Start a Recording
This command creates an active recording for specified session and returns its ID. You will use the recording ID in later commands.
Authorizations: All
Note
If you record a multi-source session, you get a multi-stream recording, whereas if you record a session with one source, you get a one-stream recording. The Command Line API is the same in either case; you are always working with a single recording ID.
Note
The Command Line API only records the session intact. For example, you cannot use it to record only two of the sources for a four-source session.
Request
startRecording sessionId |
Parameters
| Parameter | Description/Values |
|---|---|
sessionId | The ID of a HMP session. |
Result
Success
recordingId |
Error
| Error | Description |
|---|---|
ERROR|010003|Expected 1 parameter(s). | Calling startRecording requires 1 parameter. |
ERROR|010001|'Y' is not a UUID | The sessionId provided must be a UUID. |
ERROR|040006|Session not found | The session with UUID ' |
ERROR|0700014|Error writing to file | An internal error occurred while attempting to write to the disk. Please see calypso.log for details. |
ERROR|070000|Internal Server Error | The recording could not be started due to an internal error. Please see calypso.log for details. |
ERROR|070027|Insufficient Disk Space | Not enough disk space on server for creating a recording. |
ERROR|060009|Session requires at least one source | The session does not have a source. |
Example
startRecording 71edd346-2cf0-4c62-b3d3-9d457b287394 OK|f678f415-0665-48cd-b141-1e95283469f1 |