« blib/lib/Paws/MediaConnect/UpdateFlowEntitlementResponse.pm
↑ Summary
blib/lib/Paws/MediaConnect/UpdateFlowMediaStreamResponse.pm »
| 1 | |||
| 2 | package Paws::MediaConnect::UpdateFlowMediaStream; | ||
| 3 | use Moose; | ||
| 4 | has Attributes => (is => 'ro', isa => 'Paws::MediaConnect::MediaStreamAttributesRequest', traits => ['NameInRequest'], request_name => 'attributes'); | ||
| 5 | has ClockRate => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'clockRate'); | ||
| 6 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 7 | has FlowArn => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'flowArn', required => 1); | ||
| 8 | has MediaStreamName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'mediaStreamName', required => 1); | ||
| 9 | has MediaStreamType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'mediaStreamType'); | ||
| 10 | has VideoFormat => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'videoFormat'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateFlowMediaStream'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/flows/{flowArn}/mediaStreams/{mediaStreamName}'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MediaConnect::UpdateFlowMediaStreamResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::MediaConnect::UpdateFlowMediaStream - Arguments for method UpdateFlowMediaStream on L<Paws::MediaConnect> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method UpdateFlowMediaStream on the | ||
| 29 | L<AWS MediaConnect|Paws::MediaConnect> service. Use the attributes of this class | ||
| 30 | as arguments to method UpdateFlowMediaStream. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateFlowMediaStream. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $mediaconnect = Paws->service('MediaConnect'); | ||
| 37 | my $UpdateFlowMediaStreamResponse = $mediaconnect->UpdateFlowMediaStream( | ||
| 38 | FlowArn => 'My__string', | ||
| 39 | MediaStreamName => 'My__string', | ||
| 40 | Attributes => { | ||
| 41 | Fmtp => { | ||
| 42 | ChannelOrder => 'My__string', | ||
| 43 | Colorimetry => 'BT601' | ||
| 44 | , # values: BT601, BT709, BT2020, BT2100, ST2065-1, ST2065-3, XYZ; OPTIONAL | ||
| 45 | ExactFramerate => 'My__string', | ||
| 46 | Par => 'My__string', | ||
| 47 | Range => 'NARROW', # values: NARROW, FULL, FULLPROTECT; OPTIONAL | ||
| 48 | ScanMode => 'progressive' | ||
| 49 | , # values: progressive, interlace, progressive-segmented-frame; OPTIONAL | ||
| 50 | Tcs => 'SDR' | ||
| 51 | , # values: SDR, PQ, HLG, LINEAR, BT2100LINPQ, BT2100LINHLG, ST2065-1, ST428-1, DENSITY; OPTIONAL | ||
| 52 | }, # OPTIONAL | ||
| 53 | Lang => 'My__string', | ||
| 54 | }, # OPTIONAL | ||
| 55 | ClockRate => 1, # OPTIONAL | ||
| 56 | Description => 'My__string', # OPTIONAL | ||
| 57 | MediaStreamType => 'video', # OPTIONAL | ||
| 58 | VideoFormat => 'My__string', # OPTIONAL | ||
| 59 | ); | ||
| 60 | |||
| 61 | # Results: | ||
| 62 | my $FlowArn = $UpdateFlowMediaStreamResponse->FlowArn; | ||
| 63 | my $MediaStream = $UpdateFlowMediaStreamResponse->MediaStream; | ||
| 64 | |||
| 65 | # Returns a L<Paws::MediaConnect::UpdateFlowMediaStreamResponse> object. | ||
| 66 | |||
| 67 | 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. | ||
| 68 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mediaconnect/UpdateFlowMediaStream> | ||
| 69 | |||
| 70 | =head1 ATTRIBUTES | ||
| 71 | |||
| 72 | |||
| 73 | =head2 Attributes => L<Paws::MediaConnect::MediaStreamAttributesRequest> | ||
| 74 | |||
| 75 | The attributes that you want to assign to the media stream. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 ClockRate => Int | ||
| 80 | |||
| 81 | The sample rate (in Hz) for the stream. If the media stream type is | ||
| 82 | video or ancillary data, set this value to 90000. If the media stream | ||
| 83 | type is audio, set this value to either 48000 or 96000. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 Description => Str | ||
| 88 | |||
| 89 | Description | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> FlowArn => Str | ||
| 94 | |||
| 95 | The Amazon Resource Name (ARN) of the flow. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> MediaStreamName => Str | ||
| 100 | |||
| 101 | The name of the media stream that you want to update. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 MediaStreamType => Str | ||
| 106 | |||
| 107 | The type of media stream. | ||
| 108 | |||
| 109 | Valid values are: C<"video">, C<"audio">, C<"ancillary-data"> | ||
| 110 | |||
| 111 | =head2 VideoFormat => Str | ||
| 112 | |||
| 113 | The resolution of the video. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method UpdateFlowMediaStream in L<Paws::MediaConnect> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |