« blib/lib/Paws/MediaConvert/CmafEncryptionSettings.pm
↑ Summary
blib/lib/Paws/MediaConvert/CmfcSettings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::CmafGroupSettings; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalManifests => (is => 'ro', isa => 'ArrayRef[Paws::MediaConvert::CmafAdditionalManifest]', request_name => 'additionalManifests', traits => ['NameInRequest']); | ||
| 5 | has BaseUrl => (is => 'ro', isa => 'Str', request_name => 'baseUrl', traits => ['NameInRequest']); | ||
| 6 | has ClientCache => (is => 'ro', isa => 'Str', request_name => 'clientCache', traits => ['NameInRequest']); | ||
| 7 | has CodecSpecification => (is => 'ro', isa => 'Str', request_name => 'codecSpecification', traits => ['NameInRequest']); | ||
| 8 | has Destination => (is => 'ro', isa => 'Str', request_name => 'destination', traits => ['NameInRequest']); | ||
| 9 | has DestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::DestinationSettings', request_name => 'destinationSettings', traits => ['NameInRequest']); | ||
| 10 | has Encryption => (is => 'ro', isa => 'Paws::MediaConvert::CmafEncryptionSettings', request_name => 'encryption', traits => ['NameInRequest']); | ||
| 11 | has FragmentLength => (is => 'ro', isa => 'Int', request_name => 'fragmentLength', traits => ['NameInRequest']); | ||
| 12 | has ImageBasedTrickPlay => (is => 'ro', isa => 'Str', request_name => 'imageBasedTrickPlay', traits => ['NameInRequest']); | ||
| 13 | has ManifestCompression => (is => 'ro', isa => 'Str', request_name => 'manifestCompression', traits => ['NameInRequest']); | ||
| 14 | has ManifestDurationFormat => (is => 'ro', isa => 'Str', request_name => 'manifestDurationFormat', traits => ['NameInRequest']); | ||
| 15 | has MinBufferTime => (is => 'ro', isa => 'Int', request_name => 'minBufferTime', traits => ['NameInRequest']); | ||
| 16 | has MinFinalSegmentLength => (is => 'ro', isa => 'Num', request_name => 'minFinalSegmentLength', traits => ['NameInRequest']); | ||
| 17 | has MpdProfile => (is => 'ro', isa => 'Str', request_name => 'mpdProfile', traits => ['NameInRequest']); | ||
| 18 | has PtsOffsetHandlingForBFrames => (is => 'ro', isa => 'Str', request_name => 'ptsOffsetHandlingForBFrames', traits => ['NameInRequest']); | ||
| 19 | has SegmentControl => (is => 'ro', isa => 'Str', request_name => 'segmentControl', traits => ['NameInRequest']); | ||
| 20 | has SegmentLength => (is => 'ro', isa => 'Int', request_name => 'segmentLength', traits => ['NameInRequest']); | ||
| 21 | has StreamInfResolution => (is => 'ro', isa => 'Str', request_name => 'streamInfResolution', traits => ['NameInRequest']); | ||
| 22 | has WriteDashManifest => (is => 'ro', isa => 'Str', request_name => 'writeDashManifest', traits => ['NameInRequest']); | ||
| 23 | has WriteHlsManifest => (is => 'ro', isa => 'Str', request_name => 'writeHlsManifest', traits => ['NameInRequest']); | ||
| 24 | has WriteSegmentTimelineInRepresentation => (is => 'ro', isa => 'Str', request_name => 'writeSegmentTimelineInRepresentation', traits => ['NameInRequest']); | ||
| 25 | |||
| 26 | 1; | ||
| 27 | |||
| 28 | ### main pod documentation begin ### | ||
| 29 | |||
| 30 | =head1 NAME | ||
| 31 | |||
| 32 | Paws::MediaConvert::CmafGroupSettings | ||
| 33 | |||
| 34 | =head1 USAGE | ||
| 35 | |||
| 36 | This class represents one of two things: | ||
| 37 | |||
| 38 | =head3 Arguments in a call to a service | ||
| 39 | |||
| 40 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 41 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 42 | |||
| 43 | As an example, if Att1 is expected to be a Paws::MediaConvert::CmafGroupSettings object: | ||
| 44 | |||
| 45 | $service_obj->Method(Att1 => { AdditionalManifests => $value, ..., WriteSegmentTimelineInRepresentation => $value }); | ||
| 46 | |||
| 47 | =head3 Results returned from an API call | ||
| 48 | |||
| 49 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::CmafGroupSettings object: | ||
| 50 | |||
| 51 | $result = $service_obj->Method(...); | ||
| 52 | $result->Att1->AdditionalManifests | ||
| 53 | |||
| 54 | =head1 DESCRIPTION | ||
| 55 | |||
| 56 | Settings related to your CMAF output package. For more information, see | ||
| 57 | https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. | ||
| 58 | When you work directly in your JSON job specification, include this | ||
| 59 | object and any required children when you set Type, under | ||
| 60 | OutputGroupSettings, to CMAF_GROUP_SETTINGS. | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AdditionalManifests => ArrayRef[L<Paws::MediaConvert::CmafAdditionalManifest>] | ||
| 66 | |||
| 67 | By default, the service creates one top-level .m3u8 HLS manifest and | ||
| 68 | one top -level .mpd DASH manifest for each CMAF output group in your | ||
| 69 | job. These default manifests reference every output in the output | ||
| 70 | group. To create additional top-level manifests that reference a subset | ||
| 71 | of the outputs in the output group, specify a list of them here. For | ||
| 72 | each additional manifest that you specify, the service creates one HLS | ||
| 73 | manifest and one DASH manifest. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 BaseUrl => Str | ||
| 77 | |||
| 78 | A partial URI prefix that will be put in the manifest file at the top | ||
| 79 | level BaseURL element. Can be used if streams are delivered from a | ||
| 80 | different URL than the manifest file. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 ClientCache => Str | ||
| 84 | |||
| 85 | Disable this setting only when your workflow requires the | ||
| 86 | |||
| 87 | (ENABLED) and control caching in your video distribution set up. For | ||
| 88 | example, use the Cache-Control http header. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 CodecSpecification => Str | ||
| 92 | |||
| 93 | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 | ||
| 94 | playlist generation. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 Destination => Str | ||
| 98 | |||
| 99 | Use Destination (Destination) to specify the S3 output location and the | ||
| 100 | output filename base. Destination accepts format identifiers. If you do | ||
| 101 | not specify the base filename in the URI, the service will use the | ||
| 102 | filename of the input file. If your job has multiple inputs, the | ||
| 103 | service uses the filename of the first input file. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 DestinationSettings => L<Paws::MediaConvert::DestinationSettings> | ||
| 107 | |||
| 108 | Settings associated with the destination. Will vary based on the type | ||
| 109 | of destination | ||
| 110 | |||
| 111 | |||
| 112 | =head2 Encryption => L<Paws::MediaConvert::CmafEncryptionSettings> | ||
| 113 | |||
| 114 | DRM settings. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 FragmentLength => Int | ||
| 118 | |||
| 119 | Length of fragments to generate (in seconds). Fragment length must be | ||
| 120 | compatible with GOP size and Framerate. Note that fragments will end on | ||
| 121 | the next keyframe after this number of seconds, so actual fragment | ||
| 122 | length may be longer. When Emit Single File is checked, the | ||
| 123 | fragmentation is internal to a single output file and it does not cause | ||
| 124 | the creation of many output files as in other output types. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 ImageBasedTrickPlay => Str | ||
| 128 | |||
| 129 | Specify whether MediaConvert generates images for trick play. Keep the | ||
| 130 | default value, None (NONE), to not generate any images. Choose | ||
| 131 | Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail | ||
| 132 | and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails | ||
| 133 | and full-resolution images of single frames. When you enable Write HLS | ||
| 134 | manifest (WriteHlsManifest), MediaConvert creates a child manifest for | ||
| 135 | each set of images that you generate and adds corresponding entries to | ||
| 136 | the parent manifest. When you enable Write DASH manifest | ||
| 137 | (WriteDashManifest), MediaConvert adds an entry in the .mpd manifest | ||
| 138 | for each set of images that you generate. A common application for | ||
| 139 | these images is Roku trick mode. The thumbnails and full-frame images | ||
| 140 | that MediaConvert creates with this feature are compatible with this | ||
| 141 | Roku specification: | ||
| 142 | https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md | ||
| 143 | |||
| 144 | |||
| 145 | =head2 ManifestCompression => Str | ||
| 146 | |||
| 147 | When set to GZIP, compresses HLS playlist. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 ManifestDurationFormat => Str | ||
| 151 | |||
| 152 | Indicates whether the output manifest should use floating point values | ||
| 153 | for segment duration. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 MinBufferTime => Int | ||
| 157 | |||
| 158 | Minimum time of initially buffered media that is needed to ensure | ||
| 159 | smooth playout. | ||
| 160 | |||
| 161 | |||
| 162 | =head2 MinFinalSegmentLength => Num | ||
| 163 | |||
| 164 | Keep this setting at the default value of 0, unless you are | ||
| 165 | troubleshooting a problem with how devices play back the end of your | ||
| 166 | video asset. If you know that player devices are hanging on the final | ||
| 167 | segment of your video because the length of your final segment is too | ||
| 168 | short, use this setting to specify a minimum final segment length, in | ||
| 169 | seconds. Choose a value that is greater than or equal to 1 and less | ||
| 170 | than your segment length. When you specify a value for this setting, | ||
| 171 | the encoder will combine any final segment that is shorter than the | ||
| 172 | length that you specify with the previous segment. For example, your | ||
| 173 | segment length is 3 seconds and your final segment is .5 seconds | ||
| 174 | without a minimum final segment length; when you set the minimum final | ||
| 175 | segment length to 1, your final segment is 3.5 seconds. | ||
| 176 | |||
| 177 | |||
| 178 | =head2 MpdProfile => Str | ||
| 179 | |||
| 180 | Specify whether your DASH profile is on-demand or main. When you choose | ||
| 181 | Main profile (MAIN_PROFILE), the service signals | ||
| 182 | urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When | ||
| 183 | you choose On-demand (ON_DEMAND_PROFILE), the service signals | ||
| 184 | urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you | ||
| 185 | choose On-demand, you must also set the output group setting Segment | ||
| 186 | control (SegmentControl) to Single file (SINGLE_FILE). | ||
| 187 | |||
| 188 | |||
| 189 | =head2 PtsOffsetHandlingForBFrames => Str | ||
| 190 | |||
| 191 | Use this setting only when your output video stream has B-frames, which | ||
| 192 | causes the initial presentation time stamp (PTS) to be offset from the | ||
| 193 | initial decode time stamp (DTS). Specify how MediaConvert handles PTS | ||
| 194 | when writing time stamps in output DASH manifests. Choose Match initial | ||
| 195 | PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial | ||
| 196 | PTS as the first time stamp in the manifest. Choose Zero-based | ||
| 197 | (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video | ||
| 198 | stream and instead write the initial time stamp as zero in the | ||
| 199 | manifest. For outputs that don't have B-frames, the time stamps in your | ||
| 200 | DASH manifests start at zero regardless of your choice here. | ||
| 201 | |||
| 202 | |||
| 203 | =head2 SegmentControl => Str | ||
| 204 | |||
| 205 | When set to SINGLE_FILE, a single output file is generated, which is | ||
| 206 | internally segmented using the Fragment Length and Segment Length. When | ||
| 207 | set to SEGMENTED_FILES, separate segment files will be created. | ||
| 208 | |||
| 209 | |||
| 210 | =head2 SegmentLength => Int | ||
| 211 | |||
| 212 | Use this setting to specify the length, in seconds, of each individual | ||
| 213 | CMAF segment. This value applies to the whole package; that is, to | ||
| 214 | every output in the output group. Note that segments end on the first | ||
| 215 | keyframe after this number of seconds, so the actual segment length | ||
| 216 | might be slightly longer. If you set Segment control | ||
| 217 | (CmafSegmentControl) to single file, the service puts the content of | ||
| 218 | each output in a single file that has metadata that marks these | ||
| 219 | segments. If you set it to segmented files, the service creates | ||
| 220 | multiple files for each output, each with the content of one segment. | ||
| 221 | |||
| 222 | |||
| 223 | =head2 StreamInfResolution => Str | ||
| 224 | |||
| 225 | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF | ||
| 226 | tag of variant manifest. | ||
| 227 | |||
| 228 | |||
| 229 | =head2 WriteDashManifest => Str | ||
| 230 | |||
| 231 | When set to ENABLED, a DASH MPD manifest will be generated for this | ||
| 232 | output. | ||
| 233 | |||
| 234 | |||
| 235 | =head2 WriteHlsManifest => Str | ||
| 236 | |||
| 237 | When set to ENABLED, an Apple HLS manifest will be generated for this | ||
| 238 | output. | ||
| 239 | |||
| 240 | |||
| 241 | =head2 WriteSegmentTimelineInRepresentation => Str | ||
| 242 | |||
| 243 | When you enable Precise segment duration in DASH manifests | ||
| 244 | (writeSegmentTimelineInRepresentation), your DASH manifest shows | ||
| 245 | precise segment durations. The segment duration information appears | ||
| 246 | inside the SegmentTimeline element, inside SegmentTemplate at the | ||
| 247 | Representation level. When this feature isn't enabled, the segment | ||
| 248 | durations in your DASH manifest are approximate. The segment duration | ||
| 249 | information appears in the duration attribute of the SegmentTemplate | ||
| 250 | element. | ||
| 251 | |||
| 252 | |||
| 253 | |||
| 254 | =head1 SEE ALSO | ||
| 255 | |||
| 256 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 257 | |||
| 258 | =head1 BUGS and CONTRIBUTIONS | ||
| 259 | |||
| 260 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 261 | |||
| 262 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 263 | |||
| 264 | =cut | ||
| 265 |