« blib/lib/Paws/KinesisVideo/ResourceTags.pm
↑ Summary
blib/lib/Paws/KinesisVideo/SingleMasterConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisVideo::SingleMasterChannelEndpointConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Protocols => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has Role => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::KinesisVideo::SingleMasterChannelEndpointConfiguration | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::KinesisVideo::SingleMasterChannelEndpointConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Protocols => $value, ..., Role => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::KinesisVideo::SingleMasterChannelEndpointConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Protocols | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | An object that contains the endpoint configuration for the | ||
| 38 | C<SINGLE_MASTER> channel type. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Protocols => ArrayRef[Str|Undef] | ||
| 44 | |||
| 45 | This property is used to determine the nature of communication over | ||
| 46 | this C<SINGLE_MASTER> signaling channel. If C<WSS> is specified, this | ||
| 47 | API returns a websocket endpoint. If C<HTTPS> is specified, this API | ||
| 48 | returns an C<HTTPS> endpoint. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Role => Str | ||
| 52 | |||
| 53 | This property is used to determine messaging permissions in this | ||
| 54 | C<SINGLE_MASTER> signaling channel. If C<MASTER> is specified, this API | ||
| 55 | returns an endpoint that a client can use to receive offers from and | ||
| 56 | send answers to any of the viewers on this signaling channel. If | ||
| 57 | C<VIEWER> is specified, this API returns an endpoint that a client can | ||
| 58 | use only to send offers to another C<MASTER> client on this signaling | ||
| 59 | channel. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisVideo> | ||
| 66 | |||
| 67 | =head1 BUGS and CONTRIBUTIONS | ||
| 68 | |||
| 69 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 70 | |||
| 71 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 72 | |||
| 73 | =cut | ||
| 74 |