| 1 | |||
| 2 | package Paws::IVS::CreateChannel; | ||
| 3 | use Moose; | ||
| 4 | has Authorized => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'authorized'); | ||
| 5 | has LatencyMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'latencyMode'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name'); | ||
| 7 | has RecordingConfigurationArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'recordingConfigurationArn'); | ||
| 8 | has Tags => (is => 'ro', isa => 'Paws::IVS::Tags', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 9 | has Type => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'type'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateChannel'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/CreateChannel'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IVS::CreateChannelResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::IVS::CreateChannel - Arguments for method CreateChannel on L<Paws::IVS> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateChannel on the | ||
| 28 | L<Amazon Interactive Video Service|Paws::IVS> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateChannel. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateChannel. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ivs = Paws->service('IVS'); | ||
| 36 | my $CreateChannelResponse = $ivs->CreateChannel( | ||
| 37 | Authorized => 1, # OPTIONAL | ||
| 38 | LatencyMode => 'NORMAL', # OPTIONAL | ||
| 39 | Name => 'MyChannelName', # OPTIONAL | ||
| 40 | RecordingConfigurationArn => | ||
| 41 | 'MyChannelRecordingConfigurationArn', # OPTIONAL | ||
| 42 | Tags => { | ||
| 43 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 44 | }, # OPTIONAL | ||
| 45 | Type => 'BASIC', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $Channel = $CreateChannelResponse->Channel; | ||
| 50 | my $StreamKey = $CreateChannelResponse->StreamKey; | ||
| 51 | |||
| 52 | # Returns a L<Paws::IVS::CreateChannelResponse> object. | ||
| 53 | |||
| 54 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ivs/CreateChannel> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Authorized => Bool | ||
| 61 | |||
| 62 | Whether the channel is private (enabled for playback authorization). | ||
| 63 | Default: C<false>. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 LatencyMode => Str | ||
| 68 | |||
| 69 | Channel latency mode. Use C<NORMAL> to broadcast and deliver live video | ||
| 70 | up to Full HD. Use C<LOW> for near-real-time interaction with viewers. | ||
| 71 | (Note: In the Amazon IVS console, C<LOW> and C<NORMAL> correspond to | ||
| 72 | Ultra-low and Standard, respectively.) Default: C<LOW>. | ||
| 73 | |||
| 74 | Valid values are: C<"NORMAL">, C<"LOW"> | ||
| 75 | |||
| 76 | =head2 Name => Str | ||
| 77 | |||
| 78 | Channel name. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 RecordingConfigurationArn => Str | ||
| 83 | |||
| 84 | Recording-configuration ARN. Default: "" (empty string, recording is | ||
| 85 | disabled). | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 Tags => L<Paws::IVS::Tags> | ||
| 90 | |||
| 91 | Array of 1-50 maps, each of the form C<string:string (key:value)>. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 Type => Str | ||
| 96 | |||
| 97 | Channel type, which determines the allowable resolution and bitrate. | ||
| 98 | I<If you exceed the allowable resolution or bitrate, the stream | ||
| 99 | probably will disconnect immediately.> Default: C<STANDARD>. Valid | ||
| 100 | values: | ||
| 101 | |||
| 102 | =over | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<STANDARD>: Multiple qualities are generated from the original input, | ||
| 107 | to automatically give viewers the best experience for their devices and | ||
| 108 | network conditions. Vertical resolution can be up to 1080 and bitrate | ||
| 109 | can be up to 8.5 Mbps. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | C<BASIC>: Amazon IVS delivers the original input to viewers. The | ||
| 114 | viewerE<rsquo>s video-quality choice is limited to the original input. | ||
| 115 | Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps. | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | |||
| 120 | Valid values are: C<"BASIC">, C<"STANDARD"> | ||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, documenting arguments for method CreateChannel 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 |