« blib/lib/Paws/MediaConvert/AudioCodecSettings.pm
↑ Summary
blib/lib/Paws/MediaConvert/AudioNormalizationSettings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::AudioDescription; | ||
| 3 | use Moose; | ||
| 4 | has AudioChannelTaggingSettings => (is => 'ro', isa => 'Paws::MediaConvert::AudioChannelTaggingSettings', request_name => 'audioChannelTaggingSettings', traits => ['NameInRequest']); | ||
| 5 | has AudioNormalizationSettings => (is => 'ro', isa => 'Paws::MediaConvert::AudioNormalizationSettings', request_name => 'audioNormalizationSettings', traits => ['NameInRequest']); | ||
| 6 | has AudioSourceName => (is => 'ro', isa => 'Str', request_name => 'audioSourceName', traits => ['NameInRequest']); | ||
| 7 | has AudioType => (is => 'ro', isa => 'Int', request_name => 'audioType', traits => ['NameInRequest']); | ||
| 8 | has AudioTypeControl => (is => 'ro', isa => 'Str', request_name => 'audioTypeControl', traits => ['NameInRequest']); | ||
| 9 | has CodecSettings => (is => 'ro', isa => 'Paws::MediaConvert::AudioCodecSettings', request_name => 'codecSettings', traits => ['NameInRequest']); | ||
| 10 | has CustomLanguageCode => (is => 'ro', isa => 'Str', request_name => 'customLanguageCode', traits => ['NameInRequest']); | ||
| 11 | has LanguageCode => (is => 'ro', isa => 'Str', request_name => 'languageCode', traits => ['NameInRequest']); | ||
| 12 | has LanguageCodeControl => (is => 'ro', isa => 'Str', request_name => 'languageCodeControl', traits => ['NameInRequest']); | ||
| 13 | has RemixSettings => (is => 'ro', isa => 'Paws::MediaConvert::RemixSettings', request_name => 'remixSettings', traits => ['NameInRequest']); | ||
| 14 | has StreamName => (is => 'ro', isa => 'Str', request_name => 'streamName', traits => ['NameInRequest']); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::MediaConvert::AudioDescription | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::MediaConvert::AudioDescription object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { AudioChannelTaggingSettings => $value, ..., StreamName => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::AudioDescription object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->AudioChannelTaggingSettings | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Settings related to one audio tab on the MediaConvert console. In your | ||
| 47 | job JSON, an instance of AudioDescription is equivalent to one audio | ||
| 48 | tab in the console. Usually, one audio tab corresponds to one output | ||
| 49 | audio track. Depending on how you set up your input audio selectors and | ||
| 50 | whether you use audio selector groups, one audio tab can correspond to | ||
| 51 | a group of output audio tracks. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 AudioChannelTaggingSettings => L<Paws::MediaConvert::AudioChannelTaggingSettings> | ||
| 57 | |||
| 58 | When you mimic a multi-channel audio layout with multiple mono-channel | ||
| 59 | tracks, you can tag each channel layout manually. For example, you | ||
| 60 | would tag the tracks that contain your left, right, and center audio | ||
| 61 | with Left (L), Right (R), and Center (C), respectively. When you don't | ||
| 62 | specify a value, MediaConvert labels your track as Center (C) by | ||
| 63 | default. To use audio layout tagging, your output must be in a | ||
| 64 | QuickTime (.mov) container; your audio codec must be AAC, WAV, or AIFF; | ||
| 65 | and you must set up your audio track to have only one channel. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 AudioNormalizationSettings => L<Paws::MediaConvert::AudioNormalizationSettings> | ||
| 69 | |||
| 70 | Advanced audio normalization settings. Ignore these settings unless you | ||
| 71 | need to comply with a loudness standard. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 AudioSourceName => Str | ||
| 75 | |||
| 76 | Specifies which audio data to use from each input. In the simplest | ||
| 77 | case, specify an "Audio Selector":#inputs-audio_selector by name based | ||
| 78 | on its order within each input. For example if you specify "Audio | ||
| 79 | Selector 3", then the third audio selector will be used from each | ||
| 80 | input. If an input does not have an "Audio Selector 3", then the audio | ||
| 81 | selector marked as "default" in that input will be used. If there is no | ||
| 82 | audio selector marked as "default", silence will be inserted for the | ||
| 83 | duration of that input. Alternatively, an "Audio Selector | ||
| 84 | Group":#inputs-audio_selector_group name may be specified, with similar | ||
| 85 | default/silence behavior. If no audio_source_name is specified, then | ||
| 86 | "Audio Selector 1" will be chosen automatically. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 AudioType => Int | ||
| 90 | |||
| 91 | Applies only if Follow Input Audio Type is unchecked (false). A number | ||
| 92 | between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = | ||
| 93 | Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually | ||
| 94 | Impaired Commentary, 4-255 = Reserved. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 AudioTypeControl => Str | ||
| 98 | |||
| 99 | When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, | ||
| 100 | then that value is passed through to the output. If the input contains | ||
| 101 | no ISO 639 audio_type, the value in Audio Type is included in the | ||
| 102 | output. Otherwise the value in Audio Type is included in the output. | ||
| 103 | Note that this field and audioType are both ignored if | ||
| 104 | audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 CodecSettings => L<Paws::MediaConvert::AudioCodecSettings> | ||
| 108 | |||
| 109 | Settings related to audio encoding. The settings in this group vary | ||
| 110 | depending on the value that you choose for your audio codec. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 CustomLanguageCode => Str | ||
| 114 | |||
| 115 | Specify the language for this audio output track. The service puts this | ||
| 116 | language code into your output audio track when you set Language code | ||
| 117 | control (AudioLanguageCodeControl) to Use configured (USE_CONFIGURED). | ||
| 118 | The service also uses your specified custom language code when you set | ||
| 119 | Language code control (AudioLanguageCodeControl) to Follow input | ||
| 120 | (FOLLOW_INPUT), but your input file doesn't specify a language code. | ||
| 121 | For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For | ||
| 122 | streaming outputs, you can also use any other code in the full RFC-5646 | ||
| 123 | specification. Streaming outputs are those that are in one of the | ||
| 124 | following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth | ||
| 125 | Streaming. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 LanguageCode => Str | ||
| 129 | |||
| 130 | Indicates the language of the audio output track. The ISO 639 language | ||
| 131 | specified in the 'Language Code' drop down will be used when 'Follow | ||
| 132 | Input Language Code' is not selected or when 'Follow Input Language | ||
| 133 | Code' is selected but there is no ISO 639 language code specified by | ||
| 134 | the input. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 LanguageCodeControl => Str | ||
| 138 | |||
| 139 | Specify which source for language code takes precedence for this audio | ||
| 140 | track. When you choose Follow input (FOLLOW_INPUT), the service uses | ||
| 141 | the language code from the input track if it's present. If there's no | ||
| 142 | languge code on the input track, the service uses the code that you | ||
| 143 | specify in the setting Language code (languageCode or | ||
| 144 | customLanguageCode). When you choose Use configured (USE_CONFIGURED), | ||
| 145 | the service uses the language code that you specify. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 RemixSettings => L<Paws::MediaConvert::RemixSettings> | ||
| 149 | |||
| 150 | Advanced audio remixing settings. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 StreamName => Str | ||
| 154 | |||
| 155 | Specify a label for this output audio stream. For example, "English", | ||
| 156 | "Director commentary", or "track_2". For streaming outputs, | ||
| 157 | MediaConvert passes this information into destination manifests for | ||
| 158 | display on the end-viewer's player device. For outputs in other output | ||
| 159 | groups, the service ignores this setting. | ||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head1 SEE ALSO | ||
| 164 | |||
| 165 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 166 | |||
| 167 | =head1 BUGS and CONTRIBUTIONS | ||
| 168 | |||
| 169 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 170 | |||
| 171 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 172 | |||
| 173 | =cut | ||
| 174 |