| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IVS::Channel; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 5 | has Authorized => (is => 'ro', isa => 'Bool', request_name => 'authorized', traits => ['NameInRequest']); | ||
| 6 | has IngestEndpoint => (is => 'ro', isa => 'Str', request_name => 'ingestEndpoint', traits => ['NameInRequest']); | ||
| 7 | has LatencyMode => (is => 'ro', isa => 'Str', request_name => 'latencyMode', traits => ['NameInRequest']); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 9 | has PlaybackUrl => (is => 'ro', isa => 'Str', request_name => 'playbackUrl', traits => ['NameInRequest']); | ||
| 10 | has RecordingConfigurationArn => (is => 'ro', isa => 'Str', request_name => 'recordingConfigurationArn', traits => ['NameInRequest']); | ||
| 11 | has Tags => (is => 'ro', isa => 'Paws::IVS::Tags', request_name => 'tags', traits => ['NameInRequest']); | ||
| 12 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::IVS::Channel | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::IVS::Channel object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Arn => $value, ..., Type => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::IVS::Channel object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Arn | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Object specifying a channel. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Arn => Str | ||
| 50 | |||
| 51 | Channel ARN. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Authorized => Bool | ||
| 55 | |||
| 56 | Whether the channel is private (enabled for playback authorization). | ||
| 57 | Default: C<false>. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 IngestEndpoint => Str | ||
| 61 | |||
| 62 | Channel ingest endpoint, part of the definition of an ingest server, | ||
| 63 | used when you set up streaming software. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 LatencyMode => Str | ||
| 67 | |||
| 68 | Channel latency mode. Use C<NORMAL> to broadcast and deliver live video | ||
| 69 | up to Full HD. Use C<LOW> for near-real-time interaction with viewers. | ||
| 70 | Default: C<LOW>. (Note: In the Amazon IVS console, C<LOW> and C<NORMAL> | ||
| 71 | correspond to Ultra-low and Standard, respectively.) | ||
| 72 | |||
| 73 | |||
| 74 | =head2 Name => Str | ||
| 75 | |||
| 76 | Channel name. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 PlaybackUrl => Str | ||
| 80 | |||
| 81 | Channel playback URL. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 RecordingConfigurationArn => Str | ||
| 85 | |||
| 86 | Recording-configuration ARN. A value other than an empty string | ||
| 87 | indicates that recording is enabled. Default: "" (empty string, | ||
| 88 | recording is disabled). | ||
| 89 | |||
| 90 | |||
| 91 | =head2 Tags => L<Paws::IVS::Tags> | ||
| 92 | |||
| 93 | Array of 1-50 maps, each of the form C<string:string (key:value)>. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 Type => Str | ||
| 97 | |||
| 98 | Channel type, which determines the allowable resolution and bitrate. | ||
| 99 | I<If you exceed the allowable resolution or bitrate, the stream | ||
| 100 | probably will disconnect immediately.> Default: C<STANDARD>. Valid | ||
| 101 | values: | ||
| 102 | |||
| 103 | =over | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<STANDARD>: Multiple qualities are generated from the original input, | ||
| 108 | to automatically give viewers the best experience for their devices and | ||
| 109 | network conditions. Vertical resolution can be up to 1080 and bitrate | ||
| 110 | can be up to 8.5 Mbps. | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | C<BASIC>: Amazon IVS delivers the original input to viewers. The | ||
| 115 | viewerE<rsquo>s video-quality choice is limited to the original input. | ||
| 116 | Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps. | ||
| 117 | |||
| 118 | =back | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, describing an object used in L<Paws::IVS> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |