KinesisVideoWebRTCStorage ************************* Client ====== class KinesisVideoWebRTCStorage.Client A low-level client representing Amazon Kinesis Video WebRTC Storage import boto3 client = boto3.client('kinesis-video-webrtc-storage') These are the available methods: * can_paginate * close * get_paginator * get_waiter * join_storage_session * join_storage_session_as_viewer KinesisVideoWebRTCStorage / Client / get_paginator get_paginator ************* KinesisVideoWebRTCStorage.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. KinesisVideoWebRTCStorage / Client / can_paginate can_paginate ************ KinesisVideoWebRTCStorage.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. KinesisVideoWebRTCStorage / Client / join_storage_session join_storage_session ******************** KinesisVideoWebRTCStorage.Client.join_storage_session(**kwargs) Note: Before using this API, you must call the "GetSignalingChannelEndpoint" API to request the WEBRTC endpoint. You then specify the endpoint and region in your "JoinStorageSession" API request. Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel. If there’s no existing session for the channel, a new streaming session needs to be created, and the Amazon Resource Name (ARN) of the signaling channel must be provided. Currently for the "SINGLE_MASTER" type, a video producing device is able to ingest both audio and video media into a stream. Only video producing devices can join the session and record media. Warning: Both audio and video tracks are currently required for WebRTC ingestion.Current requirements: * Video track: H.264 * Audio track: Opus The resulting ingested video in the Kinesis video stream will have the following parameters: H.264 video and AAC audio. Once a master participant has negotiated a connection through WebRTC, the ingested media session will be stored in the Kinesis video stream. Multiple viewers are then able to play back real-time media through our Playback APIs. You can also use existing Kinesis Video Streams features like "HLS" or "DASH" playback, image generation via GetImages, and more with ingested WebRTC media. Note: S3 image delivery and notifications are not currently supported. Note: Assume that only one video producing device client can be associated with a session for the channel. If more than one client joins the session of a specific channel as a video producing device, the most recent client request takes precedence. **Additional information** * **Idempotent** - This API is not idempotent. * **Retry behavior** - This is counted as a new API call. * **Concurrent calls** - Concurrent calls are allowed. An offer is sent once per each call. See also: AWS API Documentation **Request Syntax** response = client.join_storage_session( channelArn='string' ) Parameters: **channelArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the signaling channel. Returns: None **Exceptions** * "KinesisVideoWebRTCStorage.Client.exceptions.ClientLimitExceeded Exception" * "KinesisVideoWebRTCStorage.Client.exceptions.InvalidArgumentExce ption" * "KinesisVideoWebRTCStorage.Client.exceptions.AccessDeniedExcepti on" * "KinesisVideoWebRTCStorage.Client.exceptions.ResourceNotFoundExc eption" KinesisVideoWebRTCStorage / Client / get_waiter get_waiter ********** KinesisVideoWebRTCStorage.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" KinesisVideoWebRTCStorage / Client / join_storage_session_as_viewer join_storage_session_as_viewer ****************************** KinesisVideoWebRTCStorage.Client.join_storage_session_as_viewer(**kwargs) Join the ongoing one way-video and/or multi-way audio WebRTC session as a viewer for an input channel. If there’s no existing session for the channel, create a new streaming session and provide the Amazon Resource Name (ARN) of the signaling channel ( "channelArn") and client id ( "clientId"). Currently for "SINGLE_MASTER" type, a video producing device is able to ingest both audio and video media into a stream, while viewers can only ingest audio. Both a video producing device and viewers can join a session first and wait for other participants. While participants are having peer to peer conversations through WebRTC, the ingested media session will be stored into the Kinesis Video Stream. Multiple viewers are able to playback real-time media. Customers can also use existing Kinesis Video Streams features like "HLS" or "DASH" playback, Image generation, and more with ingested WebRTC media. If there’s an existing session with the same "clientId" that's found in the join session request, the new request takes precedence. See also: AWS API Documentation **Request Syntax** response = client.join_storage_session_as_viewer( channelArn='string', clientId='string' ) Parameters: * **channelArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the signaling channel. * **clientId** (*string*) -- **[REQUIRED]** The unique identifier for the sender client. Returns: None **Exceptions** * "KinesisVideoWebRTCStorage.Client.exceptions.ClientLimitExceeded Exception" * "KinesisVideoWebRTCStorage.Client.exceptions.InvalidArgumentExce ption" * "KinesisVideoWebRTCStorage.Client.exceptions.AccessDeniedExcepti on" * "KinesisVideoWebRTCStorage.Client.exceptions.ResourceNotFoundExc eption" KinesisVideoWebRTCStorage / Client / close close ***** KinesisVideoWebRTCStorage.Client.close() Closes underlying endpoint connections.