« blib/lib/Paws/KinesisVideoMedia/StartSelector.pm
↑ Summary
blib/lib/Paws/KinesisVideoSignaling/GetIceServerConfig.pm »
| 1 | package Paws::KinesisVideoSignaling; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'kinesisvideo' } | ||
| 4 | sub signing_name { 'kinesisvideo' } | ||
| 5 | sub version { '2019-12-04' } | ||
| 6 | sub flattened_arrays { 0 } | ||
| 7 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 8 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 9 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 10 | }); | ||
| 11 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 12 | ] }); | ||
| 13 | |||
| 14 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller'; | ||
| 15 | |||
| 16 | |||
| 17 | sub GetIceServerConfig { | ||
| 18 | my $self = shift; | ||
| 19 | my $call_object = $self->new_with_coercions('Paws::KinesisVideoSignaling::GetIceServerConfig', @_); | ||
| 20 | return $self->caller->do_call($self, $call_object); | ||
| 21 | } | ||
| 22 | sub SendAlexaOfferToMaster { | ||
| 23 | my $self = shift; | ||
| 24 | my $call_object = $self->new_with_coercions('Paws::KinesisVideoSignaling::SendAlexaOfferToMaster', @_); | ||
| 25 | return $self->caller->do_call($self, $call_object); | ||
| 26 | } | ||
| 27 | |||
| 28 | |||
| 29 | |||
| 30 | sub operations { qw/GetIceServerConfig SendAlexaOfferToMaster / } | ||
| 31 | |||
| 32 | 1; | ||
| 33 | |||
| 34 | ### main pod documentation begin ### | ||
| 35 | |||
| 36 | =head1 NAME | ||
| 37 | |||
| 38 | Paws::KinesisVideoSignaling - Perl Interface to AWS Amazon Kinesis Video Signaling Channels | ||
| 39 | |||
| 40 | =head1 SYNOPSIS | ||
| 41 | |||
| 42 | use Paws; | ||
| 43 | |||
| 44 | my $obj = Paws->service('KinesisVideoSignaling'); | ||
| 45 | my $res = $obj->Method( | ||
| 46 | Arg1 => $val1, | ||
| 47 | Arg2 => [ 'V1', 'V2' ], | ||
| 48 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 49 | # of the arguments type | ||
| 50 | Arg3 => { Att1 => 'Val1' }, | ||
| 51 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 52 | # the constructor of the arguments type | ||
| 53 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 54 | ); | ||
| 55 | |||
| 56 | =head1 DESCRIPTION | ||
| 57 | |||
| 58 | Kinesis Video Streams Signaling Service is a intermediate service that | ||
| 59 | establishes a communication channel for discovering peers, transmitting | ||
| 60 | offers and answers in order to establish peer-to-peer connection in | ||
| 61 | webRTC technology. | ||
| 62 | |||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2019-12-04> | ||
| 64 | |||
| 65 | |||
| 66 | =head1 METHODS | ||
| 67 | |||
| 68 | =head2 GetIceServerConfig | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item ChannelARN => Str | ||
| 73 | |||
| 74 | =item [ClientId => Str] | ||
| 75 | |||
| 76 | =item [Service => Str] | ||
| 77 | |||
| 78 | =item [Username => Str] | ||
| 79 | |||
| 80 | |||
| 81 | =back | ||
| 82 | |||
| 83 | Each argument is described in detail in: L<Paws::KinesisVideoSignaling::GetIceServerConfig> | ||
| 84 | |||
| 85 | Returns: a L<Paws::KinesisVideoSignaling::GetIceServerConfigResponse> instance | ||
| 86 | |||
| 87 | Gets the Interactive Connectivity Establishment (ICE) server | ||
| 88 | configuration information, including URIs, username, and password which | ||
| 89 | can be used to configure the WebRTC connection. The ICE component uses | ||
| 90 | this configuration information to setup the WebRTC connection, | ||
| 91 | including authenticating with the Traversal Using Relays around NAT | ||
| 92 | (TURN) relay server. | ||
| 93 | |||
| 94 | TURN is a protocol that is used to improve the connectivity of | ||
| 95 | peer-to-peer applications. By providing a cloud-based relay service, | ||
| 96 | TURN ensures that a connection can be established even when one or more | ||
| 97 | peers are incapable of a direct peer-to-peer connection. For more | ||
| 98 | information, see A REST API For Access To TURN Services | ||
| 99 | (https://tools.ietf.org/html/draft-uberti-rtcweb-turn-rest-00). | ||
| 100 | |||
| 101 | You can invoke this API to establish a fallback mechanism in case | ||
| 102 | either of the peers is unable to establish a direct peer-to-peer | ||
| 103 | connection over a signaling channel. You must specify either a | ||
| 104 | signaling channel ARN or the client ID in order to invoke this API. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 SendAlexaOfferToMaster | ||
| 108 | |||
| 109 | =over | ||
| 110 | |||
| 111 | =item ChannelARN => Str | ||
| 112 | |||
| 113 | =item MessagePayload => Str | ||
| 114 | |||
| 115 | =item SenderClientId => Str | ||
| 116 | |||
| 117 | |||
| 118 | =back | ||
| 119 | |||
| 120 | Each argument is described in detail in: L<Paws::KinesisVideoSignaling::SendAlexaOfferToMaster> | ||
| 121 | |||
| 122 | Returns: a L<Paws::KinesisVideoSignaling::SendAlexaOfferToMasterResponse> instance | ||
| 123 | |||
| 124 | This API allows you to connect WebRTC-enabled devices with Alexa | ||
| 125 | display devices. When invoked, it sends the Alexa Session Description | ||
| 126 | Protocol (SDP) offer to the master peer. The offer is delivered as soon | ||
| 127 | as the master is connected to the specified signaling channel. This API | ||
| 128 | returns the SDP answer from the connected master. If the master is not | ||
| 129 | connected to the signaling channel, redelivery requests are made until | ||
| 130 | the message expires. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 PAGINATORS | ||
| 136 | |||
| 137 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head1 SEE ALSO | ||
| 143 | |||
| 144 | This service class forms part of L<Paws> | ||
| 145 | |||
| 146 | =head1 BUGS and CONTRIBUTIONS | ||
| 147 | |||
| 148 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 149 | |||
| 150 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 151 | |||
| 152 | =cut | ||
| 153 |