| AGIScriptRecordFile Method (String, String, String, Int32, Int32, Boolean, Int32) |
Record to a file until a given dtmf digit in the sequence is received.
Returns -1 on hangup or error.
The format will specify what kind of file will be recorded. The timeout is
the maximum record time in milliseconds, or -1 for no timeout. Offset samples
is optional, and if provided will seek to the offset without exceeding the
end of the file. "maxSilence" is the number of seconds of maxSilence allowed
before the function returns despite the lack of dtmf digits or reaching
timeout.
Namespace: AsterNET.FastAGIAssembly: AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax protected int RecordFile(
string file,
string format,
string escapeDigits,
int timeout,
int offset,
bool beep,
int maxSilence
)
Protected Function RecordFile (
file As String,
format As String,
escapeDigits As String,
timeout As Integer,
offset As Integer,
beep As Boolean,
maxSilence As Integer
) As Integer
protected:
int RecordFile(
String^ file,
String^ format,
String^ escapeDigits,
int timeout,
int offset,
bool beep,
int maxSilence
)
member RecordFile :
file : string *
format : string *
escapeDigits : string *
timeout : int *
offset : int *
beep : bool *
maxSilence : int -> int
Parameters
- file
- Type: SystemString
the name of the file to stream, must not include extension. - format
- Type: SystemString
the format of the file to be recorded, for example "wav". - escapeDigits
- Type: SystemString
contains the digits that allow the user to end recording. - timeout
- Type: SystemInt32
the maximum record time in milliseconds, or -1 for no timeout. - offset
- Type: SystemInt32
the offset samples to skip. - beep
- Type: SystemBoolean
true if a beep should be played before recording. - maxSilence
- Type: SystemInt32
The amount of silence (in seconds) to allow before returning despite the lack of dtmf digits or reaching timeout.
Return Value
Type:
Int32result code
See Also