« blib/lib/Paws/MediaConvert/HlsEncryptionSettings.pm
↑ Summary
blib/lib/Paws/MediaConvert/HlsRenditionGroupSettings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::HlsGroupSettings; | ||
| 3 | use Moose; | ||
| 4 | has AdditionalManifests => (is => 'ro', isa => 'ArrayRef[Paws::MediaConvert::HlsAdditionalManifest]', request_name => 'additionalManifests', traits => ['NameInRequest']); | ||
| 5 | has AdMarkers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'adMarkers', traits => ['NameInRequest']); | ||
| 6 | has AudioOnlyHeader => (is => 'ro', isa => 'Str', request_name => 'audioOnlyHeader', traits => ['NameInRequest']); | ||
| 7 | has BaseUrl => (is => 'ro', isa => 'Str', request_name => 'baseUrl', traits => ['NameInRequest']); | ||
| 8 | has CaptionLanguageMappings => (is => 'ro', isa => 'ArrayRef[Paws::MediaConvert::HlsCaptionLanguageMapping]', request_name => 'captionLanguageMappings', traits => ['NameInRequest']); | ||
| 9 | has CaptionLanguageSetting => (is => 'ro', isa => 'Str', request_name => 'captionLanguageSetting', traits => ['NameInRequest']); | ||
| 10 | has ClientCache => (is => 'ro', isa => 'Str', request_name => 'clientCache', traits => ['NameInRequest']); | ||
| 11 | has CodecSpecification => (is => 'ro', isa => 'Str', request_name => 'codecSpecification', traits => ['NameInRequest']); | ||
| 12 | has Destination => (is => 'ro', isa => 'Str', request_name => 'destination', traits => ['NameInRequest']); | ||
| 13 | has DestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::DestinationSettings', request_name => 'destinationSettings', traits => ['NameInRequest']); | ||
| 14 | has DirectoryStructure => (is => 'ro', isa => 'Str', request_name => 'directoryStructure', traits => ['NameInRequest']); | ||
| 15 | has Encryption => (is => 'ro', isa => 'Paws::MediaConvert::HlsEncryptionSettings', request_name => 'encryption', traits => ['NameInRequest']); | ||
| 16 | has ImageBasedTrickPlay => (is => 'ro', isa => 'Str', request_name => 'imageBasedTrickPlay', traits => ['NameInRequest']); | ||
| 17 | has ManifestCompression => (is => 'ro', isa => 'Str', request_name => 'manifestCompression', traits => ['NameInRequest']); | ||
| 18 | has ManifestDurationFormat => (is => 'ro', isa => 'Str', request_name => 'manifestDurationFormat', traits => ['NameInRequest']); | ||
| 19 | has MinFinalSegmentLength => (is => 'ro', isa => 'Num', request_name => 'minFinalSegmentLength', traits => ['NameInRequest']); | ||
| 20 | has MinSegmentLength => (is => 'ro', isa => 'Int', request_name => 'minSegmentLength', traits => ['NameInRequest']); | ||
| 21 | has OutputSelection => (is => 'ro', isa => 'Str', request_name => 'outputSelection', traits => ['NameInRequest']); | ||
| 22 | has ProgramDateTime => (is => 'ro', isa => 'Str', request_name => 'programDateTime', traits => ['NameInRequest']); | ||
| 23 | has ProgramDateTimePeriod => (is => 'ro', isa => 'Int', request_name => 'programDateTimePeriod', traits => ['NameInRequest']); | ||
| 24 | has SegmentControl => (is => 'ro', isa => 'Str', request_name => 'segmentControl', traits => ['NameInRequest']); | ||
| 25 | has SegmentLength => (is => 'ro', isa => 'Int', request_name => 'segmentLength', traits => ['NameInRequest']); | ||
| 26 | has SegmentsPerSubdirectory => (is => 'ro', isa => 'Int', request_name => 'segmentsPerSubdirectory', traits => ['NameInRequest']); | ||
| 27 | has StreamInfResolution => (is => 'ro', isa => 'Str', request_name => 'streamInfResolution', traits => ['NameInRequest']); | ||
| 28 | has TimedMetadataId3Frame => (is => 'ro', isa => 'Str', request_name => 'timedMetadataId3Frame', traits => ['NameInRequest']); | ||
| 29 | has TimedMetadataId3Period => (is => 'ro', isa => 'Int', request_name => 'timedMetadataId3Period', traits => ['NameInRequest']); | ||
| 30 | has TimestampDeltaMilliseconds => (is => 'ro', isa => 'Int', request_name => 'timestampDeltaMilliseconds', traits => ['NameInRequest']); | ||
| 31 | |||
| 32 | 1; | ||
| 33 | |||
| 34 | ### main pod documentation begin ### | ||
| 35 | |||
| 36 | =head1 NAME | ||
| 37 | |||
| 38 | Paws::MediaConvert::HlsGroupSettings | ||
| 39 | |||
| 40 | =head1 USAGE | ||
| 41 | |||
| 42 | This class represents one of two things: | ||
| 43 | |||
| 44 | =head3 Arguments in a call to a service | ||
| 45 | |||
| 46 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 47 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 48 | |||
| 49 | As an example, if Att1 is expected to be a Paws::MediaConvert::HlsGroupSettings object: | ||
| 50 | |||
| 51 | $service_obj->Method(Att1 => { AdditionalManifests => $value, ..., TimestampDeltaMilliseconds => $value }); | ||
| 52 | |||
| 53 | =head3 Results returned from an API call | ||
| 54 | |||
| 55 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::HlsGroupSettings object: | ||
| 56 | |||
| 57 | $result = $service_obj->Method(...); | ||
| 58 | $result->Att1->AdditionalManifests | ||
| 59 | |||
| 60 | =head1 DESCRIPTION | ||
| 61 | |||
| 62 | Settings related to your HLS output package. For more information, see | ||
| 63 | https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. | ||
| 64 | When you work directly in your JSON job specification, include this | ||
| 65 | object and any required children when you set Type, under | ||
| 66 | OutputGroupSettings, to HLS_GROUP_SETTINGS. | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 AdditionalManifests => ArrayRef[L<Paws::MediaConvert::HlsAdditionalManifest>] | ||
| 72 | |||
| 73 | By default, the service creates one top-level .m3u8 HLS manifest for | ||
| 74 | each HLS output group in your job. This default manifest references | ||
| 75 | every output in the output group. To create additional top-level | ||
| 76 | manifests that reference a subset of the outputs in the output group, | ||
| 77 | specify a list of them here. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 AdMarkers => ArrayRef[Str|Undef] | ||
| 81 | |||
| 82 | Choose one or more ad marker types to decorate your Apple HLS manifest. | ||
| 83 | This setting does not determine whether SCTE-35 markers appear in the | ||
| 84 | outputs themselves. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 AudioOnlyHeader => Str | ||
| 88 | |||
| 89 | Ignore this setting unless you are using FairPlay DRM with Verimatrix | ||
| 90 | and you encounter playback issues. Keep the default value, Include | ||
| 91 | (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to | ||
| 92 | remove the audio-only headers from your audio segments. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 BaseUrl => Str | ||
| 96 | |||
| 97 | A partial URI prefix that will be prepended to each output in the media | ||
| 98 | .m3u8 file. Can be used if base manifest is delivered from a different | ||
| 99 | URL than the main .m3u8 file. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 CaptionLanguageMappings => ArrayRef[L<Paws::MediaConvert::HlsCaptionLanguageMapping>] | ||
| 103 | |||
| 104 | Language to be used on Caption outputs | ||
| 105 | |||
| 106 | |||
| 107 | =head2 CaptionLanguageSetting => Str | ||
| 108 | |||
| 109 | Applies only to 608 Embedded output captions. Insert: Include | ||
| 110 | CLOSED-CAPTIONS lines in the manifest. Specify at least one language in | ||
| 111 | the CC1 Language Code field. One CLOSED-CAPTION line is added for each | ||
| 112 | Language Code you specify. Make sure to specify the languages in the | ||
| 113 | order in which they appear in the original source (if the source is | ||
| 114 | embedded format) or the order of the caption selectors (if the source | ||
| 115 | is other than embedded). Otherwise, languages in the manifest will not | ||
| 116 | match up properly with the output captions. None: Include | ||
| 117 | CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any | ||
| 118 | CLOSED-CAPTIONS line from the manifest. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 ClientCache => Str | ||
| 122 | |||
| 123 | Disable this setting only when your workflow requires the | ||
| 124 | |||
| 125 | (ENABLED) and control caching in your video distribution set up. For | ||
| 126 | example, use the Cache-Control http header. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 CodecSpecification => Str | ||
| 130 | |||
| 131 | Specification to use (RFC-6381 or the default RFC-4281) during m3u8 | ||
| 132 | playlist generation. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 Destination => Str | ||
| 136 | |||
| 137 | Use Destination (Destination) to specify the S3 output location and the | ||
| 138 | output filename base. Destination accepts format identifiers. If you do | ||
| 139 | not specify the base filename in the URI, the service will use the | ||
| 140 | filename of the input file. If your job has multiple inputs, the | ||
| 141 | service uses the filename of the first input file. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 DestinationSettings => L<Paws::MediaConvert::DestinationSettings> | ||
| 145 | |||
| 146 | Settings associated with the destination. Will vary based on the type | ||
| 147 | of destination | ||
| 148 | |||
| 149 | |||
| 150 | =head2 DirectoryStructure => Str | ||
| 151 | |||
| 152 | Indicates whether segments should be placed in subdirectories. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 Encryption => L<Paws::MediaConvert::HlsEncryptionSettings> | ||
| 156 | |||
| 157 | DRM settings. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 ImageBasedTrickPlay => Str | ||
| 161 | |||
| 162 | Specify whether MediaConvert generates images for trick play. Keep the | ||
| 163 | default value, None (NONE), to not generate any images. Choose | ||
| 164 | Thumbnail (THUMBNAIL) to generate tiled thumbnails. Choose Thumbnail | ||
| 165 | and full frame (THUMBNAIL_AND_FULLFRAME) to generate tiled thumbnails | ||
| 166 | and full-resolution images of single frames. MediaConvert creates a | ||
| 167 | child manifest for each set of images that you generate and adds | ||
| 168 | corresponding entries to the parent manifest. A common application for | ||
| 169 | these images is Roku trick mode. The thumbnails and full-frame images | ||
| 170 | that MediaConvert creates with this feature are compatible with this | ||
| 171 | Roku specification: | ||
| 172 | https://developer.roku.com/docs/developer-program/media-playback/trick-mode/hls-and-dash.md | ||
| 173 | |||
| 174 | |||
| 175 | =head2 ManifestCompression => Str | ||
| 176 | |||
| 177 | When set to GZIP, compresses HLS playlist. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 ManifestDurationFormat => Str | ||
| 181 | |||
| 182 | Indicates whether the output manifest should use floating point values | ||
| 183 | for segment duration. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 MinFinalSegmentLength => Num | ||
| 187 | |||
| 188 | Keep this setting at the default value of 0, unless you are | ||
| 189 | troubleshooting a problem with how devices play back the end of your | ||
| 190 | video asset. If you know that player devices are hanging on the final | ||
| 191 | segment of your video because the length of your final segment is too | ||
| 192 | short, use this setting to specify a minimum final segment length, in | ||
| 193 | seconds. Choose a value that is greater than or equal to 1 and less | ||
| 194 | than your segment length. When you specify a value for this setting, | ||
| 195 | the encoder will combine any final segment that is shorter than the | ||
| 196 | length that you specify with the previous segment. For example, your | ||
| 197 | segment length is 3 seconds and your final segment is .5 seconds | ||
| 198 | without a minimum final segment length; when you set the minimum final | ||
| 199 | segment length to 1, your final segment is 3.5 seconds. | ||
| 200 | |||
| 201 | |||
| 202 | =head2 MinSegmentLength => Int | ||
| 203 | |||
| 204 | When set, Minimum Segment Size is enforced by looking ahead and back | ||
| 205 | within the specified range for a nearby avail and extending the segment | ||
| 206 | size if needed. | ||
| 207 | |||
| 208 | |||
| 209 | =head2 OutputSelection => Str | ||
| 210 | |||
| 211 | Indicates whether the .m3u8 manifest file should be generated for this | ||
| 212 | HLS output group. | ||
| 213 | |||
| 214 | |||
| 215 | =head2 ProgramDateTime => Str | ||
| 216 | |||
| 217 | Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest | ||
| 218 | files. The value is calculated as follows: either the program date and | ||
| 219 | time are initialized using the input timecode source, or the time is | ||
| 220 | initialized using the input timecode source and the date is initialized | ||
| 221 | using the timestamp_offset. | ||
| 222 | |||
| 223 | |||
| 224 | =head2 ProgramDateTimePeriod => Int | ||
| 225 | |||
| 226 | Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds. | ||
| 227 | |||
| 228 | |||
| 229 | =head2 SegmentControl => Str | ||
| 230 | |||
| 231 | When set to SINGLE_FILE, emits program as a single media resource (.ts) | ||
| 232 | file, uses #EXT-X-BYTERANGE tags to index segment for playback. | ||
| 233 | |||
| 234 | |||
| 235 | =head2 SegmentLength => Int | ||
| 236 | |||
| 237 | Length of MPEG-2 Transport Stream segments to create (in seconds). Note | ||
| 238 | that segments will end on the next keyframe after this number of | ||
| 239 | seconds, so actual segment length may be longer. | ||
| 240 | |||
| 241 | |||
| 242 | =head2 SegmentsPerSubdirectory => Int | ||
| 243 | |||
| 244 | Number of segments to write to a subdirectory before starting a new | ||
| 245 | one. directoryStructure must be SINGLE_DIRECTORY for this setting to | ||
| 246 | have an effect. | ||
| 247 | |||
| 248 | |||
| 249 | =head2 StreamInfResolution => Str | ||
| 250 | |||
| 251 | Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF | ||
| 252 | tag of variant manifest. | ||
| 253 | |||
| 254 | |||
| 255 | =head2 TimedMetadataId3Frame => Str | ||
| 256 | |||
| 257 | Indicates ID3 frame that has the timecode. | ||
| 258 | |||
| 259 | |||
| 260 | =head2 TimedMetadataId3Period => Int | ||
| 261 | |||
| 262 | Timed Metadata interval in seconds. | ||
| 263 | |||
| 264 | |||
| 265 | =head2 TimestampDeltaMilliseconds => Int | ||
| 266 | |||
| 267 | Provides an extra millisecond delta offset to fine tune the timestamps. | ||
| 268 | |||
| 269 | |||
| 270 | |||
| 271 | =head1 SEE ALSO | ||
| 272 | |||
| 273 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 274 | |||
| 275 | =head1 BUGS and CONTRIBUTIONS | ||
| 276 | |||
| 277 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 278 | |||
| 279 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 280 | |||
| 281 | =cut | ||
| 282 |