View source

== recordFile ==

recordFile(filename[, options]) records audio from the caller.

'''Parameters'''
* filename - the name of the file to record
* options - an optional string containing options

The options are:
* background - return immediately, so that the script can carry on processing while recording;
* stop_on_dtmf - stop playing and return if the IVR received a tone during recording;
* max_time=<n> - limit recording time to a maximum of n seconds;
* max_silence=<n> - stop recording after n seconds of silence.

'''Return values'''

The recordFile function returns 0 on success.

'''Examples'''

This snippet recording, and stops if the user presses 1:
<div class="pre">
<source lang="javascript">
recordFile("recording.wav", "background");
while (getStatus().indexOf("recording") >= 0) {
  dtmf = getDTMF(1);
  if (dtmf == 1) {
    stopIVR();
    break;
  }
}
</source>
</div>

Return to [[Javascript functions]].