« blib/lib/Paws/MediaConvert/CmafGroupSettings.pm
↑ Summary
blib/lib/Paws/MediaConvert/ColorCorrector.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::CmfcSettings; | ||
| 3 | use Moose; | ||
| 4 | has AudioDuration => (is => 'ro', isa => 'Str', request_name => 'audioDuration', traits => ['NameInRequest']); | ||
| 5 | has AudioGroupId => (is => 'ro', isa => 'Str', request_name => 'audioGroupId', traits => ['NameInRequest']); | ||
| 6 | has AudioRenditionSets => (is => 'ro', isa => 'Str', request_name => 'audioRenditionSets', traits => ['NameInRequest']); | ||
| 7 | has AudioTrackType => (is => 'ro', isa => 'Str', request_name => 'audioTrackType', traits => ['NameInRequest']); | ||
| 8 | has DescriptiveVideoServiceFlag => (is => 'ro', isa => 'Str', request_name => 'descriptiveVideoServiceFlag', traits => ['NameInRequest']); | ||
| 9 | has IFrameOnlyManifest => (is => 'ro', isa => 'Str', request_name => 'iFrameOnlyManifest', traits => ['NameInRequest']); | ||
| 10 | has Scte35Esam => (is => 'ro', isa => 'Str', request_name => 'scte35Esam', traits => ['NameInRequest']); | ||
| 11 | has Scte35Source => (is => 'ro', isa => 'Str', request_name => 'scte35Source', traits => ['NameInRequest']); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::MediaConvert::CmfcSettings | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::MediaConvert::CmfcSettings object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { AudioDuration => $value, ..., Scte35Source => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::CmfcSettings object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->AudioDuration | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | These settings relate to the fragmented MP4 container for the segments | ||
| 44 | in your CMAF outputs. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 AudioDuration => Str | ||
| 50 | |||
| 51 | Specify this setting only when your output will be consumed by a | ||
| 52 | downstream repackaging workflow that is sensitive to very small | ||
| 53 | duration differences between video and audio. For this situation, | ||
| 54 | choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, | ||
| 55 | keep the default value, Default codec duration | ||
| 56 | (DEFAULT_CODEC_DURATION). When you choose Match video duration, | ||
| 57 | MediaConvert pads the output audio streams with silence or trims them | ||
| 58 | to ensure that the total duration of each audio stream is at least as | ||
| 59 | long as the total duration of the video stream. After padding or | ||
| 60 | trimming, the audio stream duration is no more than one frame longer | ||
| 61 | than the video stream. MediaConvert applies audio padding or trimming | ||
| 62 | only to the end of the last segment of the output. For unsegmented | ||
| 63 | outputs, MediaConvert adds padding only to the end of the file. When | ||
| 64 | you keep the default value, any minor discrepancies between audio and | ||
| 65 | video duration will depend on your output audio codec. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 AudioGroupId => Str | ||
| 69 | |||
| 70 | Specify the audio rendition group for this audio rendition. Specify up | ||
| 71 | to one value for each audio output in your output group. This value | ||
| 72 | appears in your HLS parent manifest in the EXT-X-MEDIA tag of | ||
| 73 | TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if | ||
| 74 | you specify "audio_aac_1" for Audio group ID, it appears in your | ||
| 75 | manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". | ||
| 76 | Related setting: To associate the rendition group that this audio track | ||
| 77 | belongs to with a video rendition, include the same value that you | ||
| 78 | provide here for that video output's setting Audio rendition sets | ||
| 79 | (audioRenditionSets). | ||
| 80 | |||
| 81 | |||
| 82 | =head2 AudioRenditionSets => Str | ||
| 83 | |||
| 84 | List the audio rendition groups that you want included with this video | ||
| 85 | rendition. Use a comma-separated list. For example, say you want to | ||
| 86 | include the audio rendition groups that have the audio group IDs | ||
| 87 | "audio_aac_1" and "audio_dolby". Then you would specify this value: | ||
| 88 | "audio_aac_1, audio_dolby". Related setting: The rendition groups that | ||
| 89 | you include in your comma-separated list should all match values that | ||
| 90 | you specify in the setting Audio group ID (AudioGroupId) for audio | ||
| 91 | renditions in the same output group as this video rendition. Default | ||
| 92 | behavior: If you don't specify anything here and for Audio group ID, | ||
| 93 | MediaConvert puts each audio variant in its own audio rendition group | ||
| 94 | and associates it with every video variant. Each value in your list | ||
| 95 | appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the | ||
| 96 | value for the AUDIO attribute. To continue the previous example, say | ||
| 97 | that the file name for the child manifest for your video rendition is | ||
| 98 | "amazing_video_1.m3u8". Then, in your parent manifest, each value will | ||
| 99 | appear on separate lines, like this: | ||
| 100 | |||
| 101 | |||
| 102 | =head2 AudioTrackType => Str | ||
| 103 | |||
| 104 | Use this setting to control the values that MediaConvert puts in your | ||
| 105 | HLS parent playlist to control how the client player selects which | ||
| 106 | audio track to play. The other options for this setting determine the | ||
| 107 | values that MediaConvert writes for the DEFAULT and AUTOSELECT | ||
| 108 | attributes of the EXT-X-MEDIA entry for the audio variant. For more | ||
| 109 | information about these attributes, see the Apple documentation article | ||
| 110 | https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. | ||
| 111 | Choose Alternate audio, auto select, default | ||
| 112 | (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and | ||
| 113 | AUTOSELECT=YES. Choose this value for only one variant in your output | ||
| 114 | group. Choose Alternate audio, auto select, not default | ||
| 115 | (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. | ||
| 116 | Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and | ||
| 117 | AUTOSELECT=NO. When you don't specify a value for this setting, | ||
| 118 | MediaConvert defaults to Alternate audio, auto select, default. When | ||
| 119 | there is more than one variant in your output group, you must | ||
| 120 | explicitly choose a value for this setting. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 DescriptiveVideoServiceFlag => Str | ||
| 124 | |||
| 125 | Specify whether to flag this audio track as descriptive video service | ||
| 126 | (DVS) in your HLS parent manifest. When you choose Flag (FLAG), | ||
| 127 | MediaConvert includes the parameter | ||
| 128 | CHARACTERISTICS="public.accessibility.describes-video" in the | ||
| 129 | EXT-X-MEDIA entry for this track. When you keep the default choice, | ||
| 130 | Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS | ||
| 131 | flag can help with accessibility on Apple devices. For more | ||
| 132 | information, see the Apple documentation. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 IFrameOnlyManifest => Str | ||
| 136 | |||
| 137 | Choose Include (INCLUDE) to have MediaConvert generate an HLS child | ||
| 138 | manifest that lists only the I-frames for this rendition, in addition | ||
| 139 | to your regular manifest for this rendition. You might use this | ||
| 140 | manifest as part of a workflow that creates preview functions for your | ||
| 141 | video. MediaConvert adds both the I-frame only child manifest and the | ||
| 142 | regular child manifest to the parent manifest. When you don't need the | ||
| 143 | I-frame only child manifest, keep the default value Exclude (EXCLUDE). | ||
| 144 | |||
| 145 | |||
| 146 | =head2 Scte35Esam => Str | ||
| 147 | |||
| 148 | Use this setting only when you specify SCTE-35 markers from ESAM. | ||
| 149 | Choose INSERT to put SCTE-35 markers in this output at the insertion | ||
| 150 | points that you specify in an ESAM XML document. Provide the document | ||
| 151 | in the setting SCC XML (sccXml). | ||
| 152 | |||
| 153 | |||
| 154 | =head2 Scte35Source => Str | ||
| 155 | |||
| 156 | Ignore this setting unless you have SCTE-35 markers in your input video | ||
| 157 | file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that | ||
| 158 | appear in your input to also appear in this output. Choose None (NONE) | ||
| 159 | if you don't want those SCTE-35 markers in this output. | ||
| 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 |