AWS.Tools.KinesisVideoSignalingChannels.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.KinesisVideoSignalingChannels</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.KVSC.GetKVSCIceServerConfigCmdlet"> <summary> Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server. <para> TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see <a href="https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00">A REST API For Access To TURN Services</a>. </para><para> You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.GetKVSCIceServerConfigCmdlet.ChannelARN"> <summary> <para> <para>The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.GetKVSCIceServerConfigCmdlet.ClientId"> <summary> <para> <para>Unique identifier for the viewer. Must be unique within the signaling channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.GetKVSCIceServerConfigCmdlet.Service"> <summary> <para> <para>Specifies the desired service. Currently, <code>TURN</code> is the only valid value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.GetKVSCIceServerConfigCmdlet.Username"> <summary> <para> <para>An optional user ID to be associated with the credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.GetKVSCIceServerConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IceServerList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideoSignalingChannels.Model.GetIceServerConfigResponse). Specifying the name of a property of type Amazon.KinesisVideoSignalingChannels.Model.GetIceServerConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.GetKVSCIceServerConfigCmdlet.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="T:Amazon.PowerShell.Cmdlets.KVSC.SendKVSCAlexaOfferToMasterCmdlet"> <summary> This API allows you to connect WebRTC-enabled devices with Alexa display devices. When invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. The offer is delivered as soon as the master is connected to the specified signaling channel. This API returns the SDP answer from the connected master. If the master is not connected to the signaling channel, redelivery requests are made until the message expires. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.SendKVSCAlexaOfferToMasterCmdlet.ChannelARN"> <summary> <para> <para>The ARN of the signaling channel by which Alexa and the master peer communicate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.SendKVSCAlexaOfferToMasterCmdlet.MessagePayload"> <summary> <para> <para>The base64-encoded SDP offer content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.SendKVSCAlexaOfferToMasterCmdlet.SenderClientId"> <summary> <para> <para>The unique identifier for the sender client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.SendKVSCAlexaOfferToMasterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Answer'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideoSignalingChannels.Model.SendAlexaOfferToMasterResponse). Specifying the name of a property of type Amazon.KinesisVideoSignalingChannels.Model.SendAlexaOfferToMasterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.SendKVSCAlexaOfferToMasterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MessagePayload parameter. The -PassThru parameter is deprecated, use -Select '^MessagePayload' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KVSC.SendKVSCAlexaOfferToMasterCmdlet.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> |