<note> <p>Before using this API, you must call the <code>GetSignalingChannelEndpoint</code> API to request the WEBRTC endpoint. You then specify the endpoint and region in your <code>JoinStorageSession</code> API request.</p> </note> <p>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. </p> <p>Currently for the <code>SINGLE_MASTER</code> 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.</p> <important> <p>Both audio and video tracks are currently required for WebRTC ingestion.</p> <p>Current requirements:</p> <ul> <li> <p>Video track: H.264</p> </li> <li> <p>Audio track: Opus</p> </li> </ul> </important> <p>The resulting ingested video in the Kinesis video stream will have the following parameters: H.264 video and AAC audio.</p> <p>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.</p> <p>You can also use existing Kinesis Video Streams features like <code>HLS</code> or <code>DASH</code> playback, image generation via <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/gs-getImages.html">GetImages</a>, and more with ingested WebRTC media.</p> <note> <p>S3 image delivery and notifications are not currently supported.</p> </note> <note> <p>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. </p> </note> <p> <b>Additional information</b> </p> <ul> <li> <p> <b>Idempotent</b> - This API is not idempotent.</p> </li> <li> <p> <b>Retry behavior</b> - This is counted as a new API call.</p> </li> <li> <p> <b>Concurrent calls</b> - Concurrent calls are allowed. An offer is sent once per each call.</p> </li> </ul>
Request body
Response
Success