Skip to content

Latest commit

 

History

History
32 lines (29 loc) · 26.2 KB

session.md

File metadata and controls

32 lines (29 loc) · 26.2 KB

Session

Fields

Field Type Required Description Example
name str ✔️ N/A test_session
id Optional[str] ➖ N/A de7818e7-610a-4057-8f6f-b785dc1e6f88
kind Optional[str] ➖ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. stream
user_id Optional[str] ➖ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. 66E2161C-7670-4D05-B71D-DA2D6979556F
last_seen Optional[float] ➖ N/A 1587667174725
source_segments Optional[float] ➖ N/A 1
transcoded_segments Optional[float] ➖ N/A 2
source_segments_duration Optional[float] ➖ Duration of all the source segments, sec 1
transcoded_segments_duration Optional[float] ➖ Duration of all the transcoded segments, sec 2
source_bytes Optional[float] ➖ N/A 1
transcoded_bytes Optional[float] ➖ N/A 2
ingest_rate Optional[float] ➖ Rate at which sourceBytes increases (bytes/second) 1
outgoing_rate Optional[float] ➖ Rate at which transcodedBytes increases (bytes/second) 2
is_healthy OptionalNullable[bool] ➖ Indicates whether the stream is healthy or not.
issues List[str] ➖ A string array of human-readable errors describing issues affecting the stream, if any.
created_at Optional[float] ➖ Timestamp (in milliseconds) at which stream object was created 1587667174725
parent_id Optional[str] ➖ Points to parent stream object de7818e7-610a-4057-8f6f-b785dc1e6f88
project_id Optional[str] ➖ The ID of the project aac12556-4d65-4d34-9fb6-d1f0985eb0a9
record Optional[bool] ➖ Whether the stream should be recorded. Uses default settings. For more customization, create and configure an object store.
 false
recording_status Optional[components.RecordingStatus] ➖ The status of the recording process of this stream session.
recording_url Optional[str] ➖ URL for accessing the recording of this stream session.
mp4_url Optional[str] ➖ The URL for the stream session recording packaged in an MP4.
playback_id Optional[str] ➖ The playback ID to use with the Playback Info endpoint to retrieve playback URLs. eaw4nk06ts2d0mzb
profiles List[components.FfmpegProfile] ➖ Profiles to transcode the stream into. If not specified, a default
set of profiles will be used with 240p, 360p, 480p and 720p
resolutions. Keep in mind that the source rendition is always kept.
recording_spec Optional[components.RecordingSpec] ➖ Configuration for recording the stream. This can only be set if
record is true.