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> 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> Currently for the <code>SINGLE_MASTER</code> 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 the session first, and wait for other participants. </para><para> 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 <code>HLS</code> or <code>DASH</code> playback, Image generation, and more with ingested WebRTC media. </para><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> </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 (<code>channelArn</code>) and client id (<code>clientId</code>). <para> Currently for <code>SINGLE_MASTER</code> 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 <code>HLS</code> or <code>DASH</code> playback, Image generation, and more with ingested WebRTC media. If there’s an existing session with the same <code>clientId</code> 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.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.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> |