Skip to content

Stream

Source code in docs_src/capo_ivs/types/stream.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class Stream(TypedDict, closed=True):
    channel_arn: NotRequired["capo_ivs.types.channel_arn.ChannelArn"]
    """<p>Channel ARN for the stream.</p>"""
    stream_id: NotRequired["capo_ivs.types.stream_id.StreamId"]
    """<p>Unique identifier for a live or previously live stream in the specified channel.</p>"""
    playback_url: NotRequired["capo_ivs.types.playback_url.PlaybackURL"]
    """<p>URL of the master playlist, required by the video player to play the HLS stream.</p>"""
    start_time: NotRequired["capo_ivs.types.stream_start_time.StreamStartTime"]
    """<p>Time of the stream’s start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"""
    state: NotRequired["capo_ivs.types.stream_state.StreamState"]
    """<p>The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.</p>"""
    health: NotRequired["capo_ivs.types.stream_health.StreamHealth"]
    """<p>The stream’s health.</p>"""
    viewer_count: "capo_ivs.types.stream_viewer_count.StreamViewerCount"
    """<p>A count of concurrent views of the stream. Typically, a new view appears in <code>viewerCount</code> within 15 seconds of when video playback starts and a view is removed from <code>viewerCount</code> within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.</p>"""

channel_arn instance-attribute 

channel_arn: NotRequired[ChannelArn]

Channel ARN for the stream.

health instance-attribute 

health: NotRequired[StreamHealth]

The stream’s health.

playback_url instance-attribute 

playback_url: NotRequired[PlaybackURL]

URL of the master playlist, required by the video player to play the HLS stream.

start_time instance-attribute 

start_time: NotRequired[StreamStartTime]

Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.

state instance-attribute 

state: NotRequired[StreamState]

The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.

stream_id instance-attribute 

stream_id: NotRequired[StreamId]

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

viewer_count instance-attribute 

viewer_count: StreamViewerCount

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.