« blib/lib/Paws/MediaConvert/M2tsScte35Esam.pm
↑ Summary
blib/lib/Paws/MediaConvert/M3u8Settings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::M2tsSettings; | ||
| 3 | use Moose; | ||
| 4 | has AudioBufferModel => (is => 'ro', isa => 'Str', request_name => 'audioBufferModel', traits => ['NameInRequest']); | ||
| 5 | has AudioDuration => (is => 'ro', isa => 'Str', request_name => 'audioDuration', traits => ['NameInRequest']); | ||
| 6 | has AudioFramesPerPes => (is => 'ro', isa => 'Int', request_name => 'audioFramesPerPes', traits => ['NameInRequest']); | ||
| 7 | has AudioPids => (is => 'ro', isa => 'ArrayRef[Int]', request_name => 'audioPids', traits => ['NameInRequest']); | ||
| 8 | has Bitrate => (is => 'ro', isa => 'Int', request_name => 'bitrate', traits => ['NameInRequest']); | ||
| 9 | has BufferModel => (is => 'ro', isa => 'Str', request_name => 'bufferModel', traits => ['NameInRequest']); | ||
| 10 | has DvbNitSettings => (is => 'ro', isa => 'Paws::MediaConvert::DvbNitSettings', request_name => 'dvbNitSettings', traits => ['NameInRequest']); | ||
| 11 | has DvbSdtSettings => (is => 'ro', isa => 'Paws::MediaConvert::DvbSdtSettings', request_name => 'dvbSdtSettings', traits => ['NameInRequest']); | ||
| 12 | has DvbSubPids => (is => 'ro', isa => 'ArrayRef[Int]', request_name => 'dvbSubPids', traits => ['NameInRequest']); | ||
| 13 | has DvbTdtSettings => (is => 'ro', isa => 'Paws::MediaConvert::DvbTdtSettings', request_name => 'dvbTdtSettings', traits => ['NameInRequest']); | ||
| 14 | has DvbTeletextPid => (is => 'ro', isa => 'Int', request_name => 'dvbTeletextPid', traits => ['NameInRequest']); | ||
| 15 | has EbpAudioInterval => (is => 'ro', isa => 'Str', request_name => 'ebpAudioInterval', traits => ['NameInRequest']); | ||
| 16 | has EbpPlacement => (is => 'ro', isa => 'Str', request_name => 'ebpPlacement', traits => ['NameInRequest']); | ||
| 17 | has EsRateInPes => (is => 'ro', isa => 'Str', request_name => 'esRateInPes', traits => ['NameInRequest']); | ||
| 18 | has ForceTsVideoEbpOrder => (is => 'ro', isa => 'Str', request_name => 'forceTsVideoEbpOrder', traits => ['NameInRequest']); | ||
| 19 | has FragmentTime => (is => 'ro', isa => 'Num', request_name => 'fragmentTime', traits => ['NameInRequest']); | ||
| 20 | has MaxPcrInterval => (is => 'ro', isa => 'Int', request_name => 'maxPcrInterval', traits => ['NameInRequest']); | ||
| 21 | has MinEbpInterval => (is => 'ro', isa => 'Int', request_name => 'minEbpInterval', traits => ['NameInRequest']); | ||
| 22 | has NielsenId3 => (is => 'ro', isa => 'Str', request_name => 'nielsenId3', traits => ['NameInRequest']); | ||
| 23 | has NullPacketBitrate => (is => 'ro', isa => 'Num', request_name => 'nullPacketBitrate', traits => ['NameInRequest']); | ||
| 24 | has PatInterval => (is => 'ro', isa => 'Int', request_name => 'patInterval', traits => ['NameInRequest']); | ||
| 25 | has PcrControl => (is => 'ro', isa => 'Str', request_name => 'pcrControl', traits => ['NameInRequest']); | ||
| 26 | has PcrPid => (is => 'ro', isa => 'Int', request_name => 'pcrPid', traits => ['NameInRequest']); | ||
| 27 | has PmtInterval => (is => 'ro', isa => 'Int', request_name => 'pmtInterval', traits => ['NameInRequest']); | ||
| 28 | has PmtPid => (is => 'ro', isa => 'Int', request_name => 'pmtPid', traits => ['NameInRequest']); | ||
| 29 | has PrivateMetadataPid => (is => 'ro', isa => 'Int', request_name => 'privateMetadataPid', traits => ['NameInRequest']); | ||
| 30 | has ProgramNumber => (is => 'ro', isa => 'Int', request_name => 'programNumber', traits => ['NameInRequest']); | ||
| 31 | has RateMode => (is => 'ro', isa => 'Str', request_name => 'rateMode', traits => ['NameInRequest']); | ||
| 32 | has Scte35Esam => (is => 'ro', isa => 'Paws::MediaConvert::M2tsScte35Esam', request_name => 'scte35Esam', traits => ['NameInRequest']); | ||
| 33 | has Scte35Pid => (is => 'ro', isa => 'Int', request_name => 'scte35Pid', traits => ['NameInRequest']); | ||
| 34 | has Scte35Source => (is => 'ro', isa => 'Str', request_name => 'scte35Source', traits => ['NameInRequest']); | ||
| 35 | has SegmentationMarkers => (is => 'ro', isa => 'Str', request_name => 'segmentationMarkers', traits => ['NameInRequest']); | ||
| 36 | has SegmentationStyle => (is => 'ro', isa => 'Str', request_name => 'segmentationStyle', traits => ['NameInRequest']); | ||
| 37 | has SegmentationTime => (is => 'ro', isa => 'Num', request_name => 'segmentationTime', traits => ['NameInRequest']); | ||
| 38 | has TimedMetadataPid => (is => 'ro', isa => 'Int', request_name => 'timedMetadataPid', traits => ['NameInRequest']); | ||
| 39 | has TransportStreamId => (is => 'ro', isa => 'Int', request_name => 'transportStreamId', traits => ['NameInRequest']); | ||
| 40 | has VideoPid => (is => 'ro', isa => 'Int', request_name => 'videoPid', traits => ['NameInRequest']); | ||
| 41 | |||
| 42 | 1; | ||
| 43 | |||
| 44 | ### main pod documentation begin ### | ||
| 45 | |||
| 46 | =head1 NAME | ||
| 47 | |||
| 48 | Paws::MediaConvert::M2tsSettings | ||
| 49 | |||
| 50 | =head1 USAGE | ||
| 51 | |||
| 52 | This class represents one of two things: | ||
| 53 | |||
| 54 | =head3 Arguments in a call to a service | ||
| 55 | |||
| 56 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 57 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 58 | |||
| 59 | As an example, if Att1 is expected to be a Paws::MediaConvert::M2tsSettings object: | ||
| 60 | |||
| 61 | $service_obj->Method(Att1 => { AudioBufferModel => $value, ..., VideoPid => $value }); | ||
| 62 | |||
| 63 | =head3 Results returned from an API call | ||
| 64 | |||
| 65 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::M2tsSettings object: | ||
| 66 | |||
| 67 | $result = $service_obj->Method(...); | ||
| 68 | $result->Att1->AudioBufferModel | ||
| 69 | |||
| 70 | =head1 DESCRIPTION | ||
| 71 | |||
| 72 | MPEG-2 TS container settings. These apply to outputs in a File output | ||
| 73 | group when the output's container (ContainerType) is MPEG-2 Transport | ||
| 74 | Stream (M2TS). In these assets, data is organized by the program map | ||
| 75 | table (PMT). Each transport stream program contains subsets of data, | ||
| 76 | including audio, video, and metadata. Each of these subsets of data has | ||
| 77 | a numerical label called a packet identifier (PID). Each transport | ||
| 78 | stream program corresponds to one MediaConvert output. The PMT lists | ||
| 79 | the types of data in a program along with their PID. Downstream systems | ||
| 80 | and players use the program map table to look up the PID for each type | ||
| 81 | of data it accesses and then uses the PIDs to locate specific data | ||
| 82 | within the asset. | ||
| 83 | |||
| 84 | =head1 ATTRIBUTES | ||
| 85 | |||
| 86 | |||
| 87 | =head2 AudioBufferModel => Str | ||
| 88 | |||
| 89 | Selects between the DVB and ATSC buffer models for Dolby Digital audio. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 AudioDuration => Str | ||
| 93 | |||
| 94 | Specify this setting only when your output will be consumed by a | ||
| 95 | downstream repackaging workflow that is sensitive to very small | ||
| 96 | duration differences between video and audio. For this situation, | ||
| 97 | choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, | ||
| 98 | keep the default value, Default codec duration | ||
| 99 | (DEFAULT_CODEC_DURATION). When you choose Match video duration, | ||
| 100 | MediaConvert pads the output audio streams with silence or trims them | ||
| 101 | to ensure that the total duration of each audio stream is at least as | ||
| 102 | long as the total duration of the video stream. After padding or | ||
| 103 | trimming, the audio stream duration is no more than one frame longer | ||
| 104 | than the video stream. MediaConvert applies audio padding or trimming | ||
| 105 | only to the end of the last segment of the output. For unsegmented | ||
| 106 | outputs, MediaConvert adds padding only to the end of the file. When | ||
| 107 | you keep the default value, any minor discrepancies between audio and | ||
| 108 | video duration will depend on your output audio codec. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 AudioFramesPerPes => Int | ||
| 112 | |||
| 113 | The number of audio frames to insert for each PES packet. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 AudioPids => ArrayRef[Int] | ||
| 117 | |||
| 118 | Specify the packet identifiers (PIDs) for any elementary audio streams | ||
| 119 | you include in this output. Specify multiple PIDs as a JSON array. | ||
| 120 | Default is the range 482-492. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 Bitrate => Int | ||
| 124 | |||
| 125 | Specify the output bitrate of the transport stream in bits per second. | ||
| 126 | Setting to 0 lets the muxer automatically determine the appropriate | ||
| 127 | bitrate. Other common values are 3750000, 7500000, and 15000000. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 BufferModel => Str | ||
| 131 | |||
| 132 | Controls what buffer model to use for accurate interleaving. If set to | ||
| 133 | MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to | ||
| 134 | lower latency, but low-memory devices may not be able to play back the | ||
| 135 | stream without interruptions. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 DvbNitSettings => L<Paws::MediaConvert::DvbNitSettings> | ||
| 139 | |||
| 140 | Use these settings to insert a DVB Network Information Table (NIT) in | ||
| 141 | the transport stream of this output. When you work directly in your | ||
| 142 | JSON job specification, include this object only when your job has a | ||
| 143 | transport stream output and the container settings contain the object | ||
| 144 | M2tsSettings. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 DvbSdtSettings => L<Paws::MediaConvert::DvbSdtSettings> | ||
| 148 | |||
| 149 | Use these settings to insert a DVB Service Description Table (SDT) in | ||
| 150 | the transport stream of this output. When you work directly in your | ||
| 151 | JSON job specification, include this object only when your job has a | ||
| 152 | transport stream output and the container settings contain the object | ||
| 153 | M2tsSettings. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 DvbSubPids => ArrayRef[Int] | ||
| 157 | |||
| 158 | Specify the packet identifiers (PIDs) for DVB subtitle data included in | ||
| 159 | this output. Specify multiple PIDs as a JSON array. Default is the | ||
| 160 | range 460-479. | ||
| 161 | |||
| 162 | |||
| 163 | =head2 DvbTdtSettings => L<Paws::MediaConvert::DvbTdtSettings> | ||
| 164 | |||
| 165 | Use these settings to insert a DVB Time and Date Table (TDT) in the | ||
| 166 | transport stream of this output. When you work directly in your JSON | ||
| 167 | job specification, include this object only when your job has a | ||
| 168 | transport stream output and the container settings contain the object | ||
| 169 | M2tsSettings. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 DvbTeletextPid => Int | ||
| 173 | |||
| 174 | Specify the packet identifier (PID) for DVB teletext data you include | ||
| 175 | in this output. Default is 499. | ||
| 176 | |||
| 177 | |||
| 178 | =head2 EbpAudioInterval => Str | ||
| 179 | |||
| 180 | When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added | ||
| 181 | to partitions 3 and 4. The interval between these additional markers | ||
| 182 | will be fixed, and will be slightly shorter than the video EBP marker | ||
| 183 | interval. When set to VIDEO_INTERVAL, these additional markers will not | ||
| 184 | be inserted. Only applicable when EBP segmentation markers are is | ||
| 185 | selected (segmentationMarkers is EBP or EBP_LEGACY). | ||
| 186 | |||
| 187 | |||
| 188 | =head2 EbpPlacement => Str | ||
| 189 | |||
| 190 | Selects which PIDs to place EBP markers on. They can either be placed | ||
| 191 | only on the video PID, or on both the video PID and all audio PIDs. | ||
| 192 | Only applicable when EBP segmentation markers are is selected | ||
| 193 | (segmentationMarkers is EBP or EBP_LEGACY). | ||
| 194 | |||
| 195 | |||
| 196 | =head2 EsRateInPes => Str | ||
| 197 | |||
| 198 | Controls whether to include the ES Rate field in the PES header. | ||
| 199 | |||
| 200 | |||
| 201 | =head2 ForceTsVideoEbpOrder => Str | ||
| 202 | |||
| 203 | Keep the default value (DEFAULT) unless you know that your audio EBP | ||
| 204 | markers are incorrectly appearing before your video EBP markers. To | ||
| 205 | correct this problem, set this value to Force (FORCE). | ||
| 206 | |||
| 207 | |||
| 208 | =head2 FragmentTime => Num | ||
| 209 | |||
| 210 | The length, in seconds, of each fragment. Only used with EBP markers. | ||
| 211 | |||
| 212 | |||
| 213 | =head2 MaxPcrInterval => Int | ||
| 214 | |||
| 215 | Specify the maximum time, in milliseconds, between Program Clock | ||
| 216 | References (PCRs) inserted into the transport stream. | ||
| 217 | |||
| 218 | |||
| 219 | =head2 MinEbpInterval => Int | ||
| 220 | |||
| 221 | When set, enforces that Encoder Boundary Points do not come within the | ||
| 222 | specified time interval of each other by looking ahead at input video. | ||
| 223 | If another EBP is going to come in within the specified time interval, | ||
| 224 | the current EBP is not emitted, and the segment is "stretched" to the | ||
| 225 | next marker. The lookahead value does not add latency to the system. | ||
| 226 | The Live Event must be configured elsewhere to create sufficient | ||
| 227 | latency to make the lookahead accurate. | ||
| 228 | |||
| 229 | |||
| 230 | =head2 NielsenId3 => Str | ||
| 231 | |||
| 232 | If INSERT, Nielsen inaudible tones for media tracking will be detected | ||
| 233 | in the input audio and an equivalent ID3 tag will be inserted in the | ||
| 234 | output. | ||
| 235 | |||
| 236 | |||
| 237 | =head2 NullPacketBitrate => Num | ||
| 238 | |||
| 239 | Value in bits per second of extra null packets to insert into the | ||
| 240 | transport stream. This can be used if a downstream encryption system | ||
| 241 | requires periodic null packets. | ||
| 242 | |||
| 243 | |||
| 244 | =head2 PatInterval => Int | ||
| 245 | |||
| 246 | The number of milliseconds between instances of this table in the | ||
| 247 | output transport stream. | ||
| 248 | |||
| 249 | |||
| 250 | =head2 PcrControl => Str | ||
| 251 | |||
| 252 | When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is | ||
| 253 | inserted for every Packetized Elementary Stream (PES) header. This is | ||
| 254 | effective only when the PCR PID is the same as the video or audio | ||
| 255 | elementary stream. | ||
| 256 | |||
| 257 | |||
| 258 | =head2 PcrPid => Int | ||
| 259 | |||
| 260 | Specify the packet identifier (PID) for the program clock reference | ||
| 261 | (PCR) in this output. If you do not specify a value, the service will | ||
| 262 | use the value for Video PID (VideoPid). | ||
| 263 | |||
| 264 | |||
| 265 | =head2 PmtInterval => Int | ||
| 266 | |||
| 267 | Specify the number of milliseconds between instances of the program map | ||
| 268 | table (PMT) in the output transport stream. | ||
| 269 | |||
| 270 | |||
| 271 | =head2 PmtPid => Int | ||
| 272 | |||
| 273 | Specify the packet identifier (PID) for the program map table (PMT) | ||
| 274 | itself. Default is 480. | ||
| 275 | |||
| 276 | |||
| 277 | =head2 PrivateMetadataPid => Int | ||
| 278 | |||
| 279 | Specify the packet identifier (PID) of the private metadata stream. | ||
| 280 | Default is 503. | ||
| 281 | |||
| 282 | |||
| 283 | =head2 ProgramNumber => Int | ||
| 284 | |||
| 285 | Use Program number (programNumber) to specify the program number used | ||
| 286 | in the program map table (PMT) for this output. Default is 1. Program | ||
| 287 | numbers and program map tables are parts of MPEG-2 transport stream | ||
| 288 | containers, used for organizing data. | ||
| 289 | |||
| 290 | |||
| 291 | =head2 RateMode => Str | ||
| 292 | |||
| 293 | When set to CBR, inserts null packets into transport stream to fill | ||
| 294 | specified bitrate. When set to VBR, the bitrate setting acts as the | ||
| 295 | maximum bitrate, but the output will not be padded up to that bitrate. | ||
| 296 | |||
| 297 | |||
| 298 | =head2 Scte35Esam => L<Paws::MediaConvert::M2tsScte35Esam> | ||
| 299 | |||
| 300 | Include this in your job settings to put SCTE-35 markers in your HLS | ||
| 301 | and transport stream outputs at the insertion points that you specify | ||
| 302 | in an ESAM XML document. Provide the document in the setting SCC XML | ||
| 303 | (sccXml). | ||
| 304 | |||
| 305 | |||
| 306 | =head2 Scte35Pid => Int | ||
| 307 | |||
| 308 | Specify the packet identifier (PID) of the SCTE-35 stream in the | ||
| 309 | transport stream. | ||
| 310 | |||
| 311 | |||
| 312 | =head2 Scte35Source => Str | ||
| 313 | |||
| 314 | For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) | ||
| 315 | if you want SCTE-35 markers that appear in your input to also appear in | ||
| 316 | this output. Choose None (NONE) if you don't want SCTE-35 markers in | ||
| 317 | this output. For SCTE-35 markers from an ESAM XML document-- Choose | ||
| 318 | None (NONE). Also provide the ESAM XML as a string in the setting | ||
| 319 | Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 | ||
| 320 | (include the property scte35Esam). | ||
| 321 | |||
| 322 | |||
| 323 | =head2 SegmentationMarkers => Str | ||
| 324 | |||
| 325 | Inserts segmentation markers at each segmentation_time period. | ||
| 326 | rai_segstart sets the Random Access Indicator bit in the adaptation | ||
| 327 | field. rai_adapt sets the RAI bit and adds the current timecode in the | ||
| 328 | private data bytes. psi_segstart inserts PAT and PMT tables at the | ||
| 329 | start of segments. ebp adds Encoder Boundary Point information to the | ||
| 330 | adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. | ||
| 331 | ebp_legacy adds Encoder Boundary Point information to the adaptation | ||
| 332 | field using a legacy proprietary format. | ||
| 333 | |||
| 334 | |||
| 335 | =head2 SegmentationStyle => Str | ||
| 336 | |||
| 337 | The segmentation style parameter controls how segmentation markers are | ||
| 338 | inserted into the transport stream. With avails, it is possible that | ||
| 339 | segments may be truncated, which can influence where future | ||
| 340 | segmentation markers are inserted. When a segmentation style of | ||
| 341 | "reset_cadence" is selected and a segment is truncated due to an avail, | ||
| 342 | we will reset the segmentation cadence. This means the subsequent | ||
| 343 | segment will have a duration of of $segmentation_time seconds. When a | ||
| 344 | segmentation style of "maintain_cadence" is selected and a segment is | ||
| 345 | truncated due to an avail, we will not reset the segmentation cadence. | ||
| 346 | This means the subsequent segment will likely be truncated as well. | ||
| 347 | However, all segments after that will have a duration of | ||
| 348 | $segmentation_time seconds. Note that EBP lookahead is a slight | ||
| 349 | exception to this rule. | ||
| 350 | |||
| 351 | |||
| 352 | =head2 SegmentationTime => Num | ||
| 353 | |||
| 354 | Specify the length, in seconds, of each segment. Required unless | ||
| 355 | markers is set to _none_. | ||
| 356 | |||
| 357 | |||
| 358 | =head2 TimedMetadataPid => Int | ||
| 359 | |||
| 360 | Specify the packet identifier (PID) for timed metadata in this output. | ||
| 361 | Default is 502. | ||
| 362 | |||
| 363 | |||
| 364 | =head2 TransportStreamId => Int | ||
| 365 | |||
| 366 | Specify the ID for the transport stream itself in the program map table | ||
| 367 | for this output. Transport stream IDs and program map tables are parts | ||
| 368 | of MPEG-2 transport stream containers, used for organizing data. | ||
| 369 | |||
| 370 | |||
| 371 | =head2 VideoPid => Int | ||
| 372 | |||
| 373 | Specify the packet identifier (PID) of the elementary video stream in | ||
| 374 | the transport stream. | ||
| 375 | |||
| 376 | |||
| 377 | |||
| 378 | =head1 SEE ALSO | ||
| 379 | |||
| 380 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 381 | |||
| 382 | =head1 BUGS and CONTRIBUTIONS | ||
| 383 | |||
| 384 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 385 | |||
| 386 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 387 | |||
| 388 | =cut | ||
| 389 |