No Custom Parameters
Records audio from a connection or conference.
Record action allows one to convert the voice stream of either a single connection or an entire conference into a WAV or VOX file. A connection can be recorded whether it is in or out of a conference.
Recorded files are placed into the root of the media engine audio path, which by default is
C:\Program Files\Cisco Systems\Unified Application Environment\MediaServer\Audio.
The termination condition parameters on the action are a means to create a matrix of reasons that the action should stop successfully. In the
Record_Complete event, one can use
TerminationCondition to determine why the command stopped recording.
Record action will analyze the
Filename action parameter (if specified) to determine if it is a full path. If it is a full path and assuming the path does indeed exist on the OS filesystem, the
Record action will place the recording there. Note that when a full path is specified, the media engine will not automatically expire the file, regardless of the value of the
Expires parameter. If the filename is simply a file name (no path), or if it is not specified and the name is generated by the media engine automatically, then the media engine will concat the base audio path and the filename; the
Record action will place the recording in this location.
The following properties cover most allowable audio file formats that can be recorded by the media engine: sample rate of
11, sample size of
16 bit, and encoding types of
adpcm. Only mono
wav files are allowed.
Record to a connection or a conference results in a voice resource being utilized until the action results in
If a connection is specified as the recepient of the
Record, the voice resource attaches to the connection. If a conference is specified as the recepient of the
Record, a new connection (which uses a conference resource) is created and added to the conference for the duration of the
Record, and the voice resource is attached to that new connection. It is important to understand this behavior, as the
ConnectionId result data will always be the connection to which the
Record voice resource is attached. In other words, in the case of a
Record to a connection, the value of the
ConnectionId result data is the same as that specified as an action parameter. In the case of a
Record to a conference, the value of the
ConnectionId result data is the value of the new connection added to conference which is only a valid value for the duration of the
Record. In either case, this result data
ConnectionId is what one would later specify in
|Parameter Name||.NET Type||Default||Description|
|TermCondNonSilence||The amount of non-silence (in milliseconds) to observe before terminating the |
|AudioFileSampleRate||The sample rate of the audio file (in kHz).
Valid values are |
|AudioFileSampleSize||The sample size used in the audio file (in bits).
Valid values are |
|AudioFileEncoding||The encoding of the audio file: |
|AudioFileFormat||The format of the audio file: |
|CommandTimeout||Indicates a command timeout value (in milliseconds).
If this condition is met, the |
|Expires||1||The number of days until the file is automatically deleted from the server. A value of |
|State||Optional user state information which is guaranteed present as the State event parameter in
|Filename||The name of the audo file to create.
If not specified, the media engine will generate a random file name, which is obtainable through either the result data |
|ConnectionId||The connection to perform the |
|ConferenceId||The conference to perform the |
|TermCondMaxTime||The amount of time (in milliseconds) that can elapse before terminating the |
|TermCondDigit||A specific digit that will cause the |
|TermCondSilence||The amount of silence (in milliseconds) to observe before terminating the |
|Parameter Name||.NET Type||Description|
|ConnectionId||In the case of a |
|OperationId||A unique identifier to this |
|Filename||The filename used to save the recording. The filename is relative to the root of the media engine audio path.|
|Url||The URL to the recorded audio file.|
|ResultCode||A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes.|