Skip to content

StreamSession

Source code in docs_src/capo_ivs/types/stream_session.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class StreamSession(TypedDict, closed=True):
    stream_id: NotRequired["capo_ivs.types.stream_id.StreamId"]
    """<p>Unique identifier for a live or previously live stream in the specified channel.</p>"""
    start_time: NotRequired["capo_ivs.types.time.Time"]
    """<p>Time when the channel went live. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"""
    end_time: NotRequired["capo_ivs.types.time.Time"]
    """<p>Time when the channel went offline. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>. For live streams, this is <code>NULL</code>.</p>"""
    channel: NotRequired["capo_ivs.types.channel.Channel"]
    """<p>The properties of the channel at the time of going live.</p>"""
    ingest_configuration: NotRequired[
        "capo_ivs.types.ingest_configuration.IngestConfiguration"
    ]
    """<p>The properties of the incoming RTMP stream.</p> <p> <b>Note:</b> <code>ingestConfiguration</code> is deprecated in favor of <code>ingestConfigurations</code> but retained to ensure backward compatibility. If multitrack is not enabled, <code>ingestConfiguration</code> and <code>ingestConfigurations</code> contain the same data, namely information about Track0 (the sole track). If multitrack is enabled, <code>ingestConfiguration</code> contains data for only the first track (Track0) and <code>ingestConfigurations</code> contains data for all tracks.</p>"""
    ingest_configurations: NotRequired[
        "capo_ivs.types.ingest_configurations.IngestConfigurations"
    ]
    """<p>The properties of the incoming RTMP stream. If multitrack is enabled, <code>ingestConfigurations</code> contains data for all tracks; otherwise, it contains data only for Track0 (the sole track).</p>"""
    recording_configuration: NotRequired[
        "capo_ivs.types.recording_configuration.RecordingConfiguration"
    ]
    """<p>The properties of recording the live stream.</p>"""
    truncated_events: NotRequired["capo_ivs.types.stream_events.StreamEvents"]
    """<p>List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html">Using Amazon EventBridge with Amazon IVS</a>.</p>"""

channel instance-attribute 

channel: NotRequired[Channel]

The properties of the channel at the time of going live.

end_time instance-attribute 

end_time: NotRequired[Time]

Time when the channel went offline. This is an ISO 8601 timestamp; note that this is returned as a string. For live streams, this is NULL.

ingest_configuration instance-attribute 

ingest_configuration: NotRequired[IngestConfiguration]

The properties of the incoming RTMP stream.

Note: ingestConfiguration is deprecated in favor of ingestConfigurations but retained to ensure backward compatibility. If multitrack is not enabled, ingestConfiguration and ingestConfigurations contain the same data, namely information about Track0 (the sole track). If multitrack is enabled, ingestConfiguration contains data for only the first track (Track0) and ingestConfigurations contains data for all tracks.

ingest_configurations instance-attribute 

ingest_configurations: NotRequired[IngestConfigurations]

The properties of the incoming RTMP stream. If multitrack is enabled, ingestConfigurations contains data for all tracks; otherwise, it contains data only for Track0 (the sole track).

recording_configuration instance-attribute 

recording_configuration: NotRequired[RecordingConfiguration]

The properties of recording the live stream.

start_time instance-attribute 

start_time: NotRequired[Time]

Time when the channel went live. This is an ISO 8601 timestamp; note that this is returned as a string.

stream_id instance-attribute 

stream_id: NotRequired[StreamId]

Unique identifier for a live or previously live stream in the specified channel.

truncated_events instance-attribute 

truncated_events: NotRequired[StreamEvents]

List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.