Skip to content

Destination

Source code in docs_src/capo_ivs_realtime/types/destination.py
class Destination(TypedDict, closed=True):
    id: "capo_ivs_realtime.types.string.String"
    """<p>Unique identifier for this destination, assigned by IVS.</p>"""
    state: "capo_ivs_realtime.types.destination_state.DestinationState"
    """<p>State of the Composition Destination.</p>"""
    start_time: NotRequired["capo_ivs_realtime.types.time.Time"]
    """<p>UTC time of the destination start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"""
    end_time: NotRequired["capo_ivs_realtime.types.time.Time"]
    """<p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.</p>"""
    configuration: (
        "capo_ivs_realtime.types.destination_configuration.DestinationConfiguration"
    )
    """<p>Configuration used to create this destination.</p>"""
    detail: NotRequired["capo_ivs_realtime.types.destination_detail.DestinationDetail"]
    """<p>Optional details regarding the status of the destination.</p>"""

configuration instance-attribute

configuration: DestinationConfiguration

Configuration used to create this destination.

detail instance-attribute

detail: NotRequired[DestinationDetail]

Optional details regarding the status of the destination.

end_time instance-attribute

end_time: NotRequired[Time]

UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.

id instance-attribute

id: String

Unique identifier for this destination, assigned by IVS.

start_time instance-attribute

start_time: NotRequired[Time]

UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.

state instance-attribute

State of the Composition Destination.