Skip to content

StreamSessionSummary

Source code in docs_src/capo_ivs/types/stream_session_summary.py 
13
14
15
16
17
18
19
20
21
class StreamSessionSummary(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>"""
    has_error_event: "capo_ivs.types.boolean.Boolean"
    """<p>If <code>true</code>, this stream encountered a quota breach or failure.</p>"""

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.

has_error_event instance-attribute 

has_error_event: Boolean

If true, this stream encountered a quota breach or failure.

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.