Synopsis
A session is a collection of one or more video sources that are identified to provide live viewing, recording, and metadata storage. The sessions API is used to create sessions, edit session information, start a recording, and give other users access to the session.
Session Parameters
|
Property |
JSON Type |
Property Type |
Description |
|---|---|---|---|
|
|
String |
Immutable |
Identifies the session, generated by HMP. |
|
|
String |
Required |
Title of the session. |
|
|
String |
Optional |
Description of the session. |
|
|
Number |
Ignored |
The creation time of the video as a Unix epoch timestamp (seconds). |
|
|
Number |
Ignored |
The last modification time of the video as a Unix epoch timestamp (seconds). |
|
|
Number |
Ignored |
The length of the video in seconds. |
|
|
Boolean |
Optional |
Indicates if the session is active or not. Must be set to true to be available to other users. When false (default), only the session owner can see the session. |
|
|
Boolean |
Optional |
If true, indicates the session is recording in synchronous mode for multiple sources (recording all sources by default). Default is false. |
|
|
Number |
Ignored |
Number of source tracks in the session. (Also, present in the asset resource.) |
|
|
Boolean |
Ignored |
Read-only state information. True when the video is currently being recorded; false when the recording is complete. |
|
|
Array |
Optional |
List of UUIDs corresponding to the distribution policies used in the session. |
|
|
Array |
Ignored |
Array of UUIDs corresponding to the source IDs used in the session. |