NAME

Paws::KinesisVideoSignaling - Perl Interface to AWS Amazon Kinesis Video Signaling Channels

SYNOPSIS

  use Paws;

  my $obj = Paws->service('KinesisVideoSignaling');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Kinesis Video Streams Signaling Service is a intermediate service that establishes a communication channel for discovering peers, transmitting offers and answers in order to establish peer-to-peer connection in webRTC technology.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2019-12-04

METHODS

GetIceServerConfig

ChannelARN => Str

[ClientId => Str]

[Service => Str]

[Username => Str]

Each argument is described in detail in: Paws::KinesisVideoSignaling::GetIceServerConfig

Returns: a Paws::KinesisVideoSignaling::GetIceServerConfigResponse instance

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.

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 REST API For Access To TURN Services (https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00).

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.

SendAlexaOfferToMaster

ChannelARN => Str

MessagePayload => Str

SenderClientId => Str

Each argument is described in detail in: Paws::KinesisVideoSignaling::SendAlexaOfferToMaster

Returns: a Paws::KinesisVideoSignaling::SendAlexaOfferToMasterResponse instance

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues