Synopsis
An active recording is a recording that is currently being created by recording a session's sources. When it is paused, it becomes a paused recording. When it is stopped, it becomes a finished recording. Finished recordings are referred to as videos.
The recordings API is used to list, pause/resume, delete, and insert HotMarks in active recordings.
Recording Parameters
|
Property |
JSON Type |
Property Type |
Description |
|---|---|---|---|
|
|
String |
Immutable |
Identifies the resource. Generated by HMP. |
|
|
String |
Immutable |
The session being recorded. |
|
|
String |
Immutable |
The name of the user making the recording. |
|
|
String |
Optional |
The desired state of the recording. Accepted values: "PAUSED" or "RECORDING". |
|
|
Number |
Ignored |
The length of the recording in seconds. |
|
|
Array |
Optional |
Contains source IDs on which to start recording. If parameter is not provided, recording will be started on all of session's sources. |
|
|
Number |
Ignored |
The creation time of the recording as a Unix epoch timestamp (seconds). |
|
|
String |
Immutable |
Title of the recording. |