AWS.Tools.KinesisVideoWebRTCStorage.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.KinesisVideoWebRTCStorage</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionCmdlet"> <summary> <note><para> Before using this API, you must call the <c>GetSignalingChannelEndpoint</c> API to request the WEBRTC endpoint. You then specify the endpoint and region in your <c>JoinStorageSession</c> API request. </para></note><para> 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. </para><para> Currently for the <c>SINGLE_MASTER</c> 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. </para><important><para> Both audio and video tracks are currently required for WebRTC ingestion. </para><para> Current requirements: </para><ul><li><para> Video track: H.264 </para></li><li><para> Audio track: Opus </para></li></ul></important><para> The resulting ingested video in the Kinesis video stream will have the following parameters: H.264 video and AAC audio. </para><para> 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. </para><para> You can also use existing Kinesis Video Streams features like <c>HLS</c> or <c>DASH</c> 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. </para><note><para> S3 image delivery and notifications are not currently supported. </para></note><note><para> 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. </para></note><para><b>Additional information</b></para><ul><li><para><b>Idempotent</b> - This API is not idempotent. </para></li><li><para><b>Retry behavior</b> - This is counted as a new API call. </para></li><li><para><b>Concurrent calls</b> - Concurrent calls are allowed. An offer is sent once per each call. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionCmdlet.ChannelArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the signaling channel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideoWebRTCStorage.Model.JoinStorageSessionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionAsViewerCmdlet"> <summary> 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 (<c>channelArn</c>) and client id (<c>clientId</c>). <para> Currently for <c>SINGLE_MASTER</c> 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. </para><para> Customers can also use existing Kinesis Video Streams features like <c>HLS</c> or <c>DASH</c> playback, Image generation, and more with ingested WebRTC media. If there’s an existing session with the same <c>clientId</c> that's found in the join session request, the new request takes precedence. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionAsViewerCmdlet.ChannelArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the signaling channel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionAsViewerCmdlet.ClientId"> <summary> <para> <para> The unique identifier for the sender client. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionAsViewerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideoWebRTCStorage.Model.JoinStorageSessionAsViewerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVWS.JoinKVWSStorageSessionAsViewerCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |