Skip to content

SingleMasterChannelEndpointConfiguration

Used by
Source code in docs_src/capo_kinesis_video/types/single_master_channel_endpoint_configuration.py 
12
13
14
15
16
class SingleMasterChannelEndpointConfiguration(TypedDict, closed=True):
    protocols: NotRequired["capo_kinesis_video.types.list_of_protocols.ListOfProtocols"]
    """<p>This property is used to determine the nature of communication over this <code>SINGLE_MASTER</code> signaling channel. If <code>WSS</code> is specified, this API returns a websocket endpoint. If <code>HTTPS</code> is specified, this API returns an <code>HTTPS</code> endpoint.</p>"""
    role: NotRequired["capo_kinesis_video.types.channel_role.ChannelRole"]
    """<p>This property is used to determine messaging permissions in this <code>SINGLE_MASTER</code> signaling channel. If <code>MASTER</code> is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If <code>VIEWER</code> is specified, this API returns an endpoint that a client can use only to send offers to another <code>MASTER</code> client on this signaling channel. </p>"""

protocols instance-attribute 

protocols: NotRequired[ListOfProtocols]

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

role instance-attribute 

role: NotRequired[ChannelRole]

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.