« blib/lib/Paws/MediaConvert/HlsRenditionGroupSettings.pm
↑ Summary
blib/lib/Paws/MediaConvert/HopDestination.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::HlsSettings; | ||
| 3 | use Moose; | ||
| 4 | has AudioGroupId => (is => 'ro', isa => 'Str', request_name => 'audioGroupId', traits => ['NameInRequest']); | ||
| 5 | has AudioOnlyContainer => (is => 'ro', isa => 'Str', request_name => 'audioOnlyContainer', 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 SegmentModifier => (is => 'ro', isa => 'Str', request_name => 'segmentModifier', traits => ['NameInRequest']); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::MediaConvert::HlsSettings | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::MediaConvert::HlsSettings object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { AudioGroupId => $value, ..., SegmentModifier => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::HlsSettings object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->AudioGroupId | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Settings for HLS output groups | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 AudioGroupId => Str | ||
| 48 | |||
| 49 | Specifies the group to which the audio rendition belongs. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 AudioOnlyContainer => Str | ||
| 53 | |||
| 54 | Use this setting only in audio-only outputs. Choose MPEG-2 Transport | ||
| 55 | Stream (M2TS) to create a file in an MPEG2-TS container. Keep the | ||
| 56 | default value Automatic (AUTOMATIC) to create an audio-only file in a | ||
| 57 | raw container. Regardless of the value that you specify here, if this | ||
| 58 | output has video, the service will place the output into an MPEG2-TS | ||
| 59 | container. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 AudioRenditionSets => Str | ||
| 63 | |||
| 64 | List all the audio groups that are used with the video output stream. | ||
| 65 | Input all the audio GROUP-IDs that are associated to the video, | ||
| 66 | separate by ','. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 AudioTrackType => Str | ||
| 70 | |||
| 71 | Four types of audio-only tracks are supported: Audio-Only Variant | ||
| 72 | Stream The client can play back this audio-only stream instead of video | ||
| 73 | in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the | ||
| 74 | HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition | ||
| 75 | that the client should try to play back by default. Represented as an | ||
| 76 | EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES | ||
| 77 | Alternate Audio, Auto Select, Not Default Alternate rendition that the | ||
| 78 | client may try to play back by default. Represented as an EXT-X-MEDIA | ||
| 79 | in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, | ||
| 80 | not Auto Select Alternate rendition that the client will not try to | ||
| 81 | play back by default. Represented as an EXT-X-MEDIA in the HLS manifest | ||
| 82 | with DEFAULT=NO, AUTOSELECT=NO | ||
| 83 | |||
| 84 | |||
| 85 | =head2 DescriptiveVideoServiceFlag => Str | ||
| 86 | |||
| 87 | Specify whether to flag this audio track as descriptive video service | ||
| 88 | (DVS) in your HLS parent manifest. When you choose Flag (FLAG), | ||
| 89 | MediaConvert includes the parameter | ||
| 90 | CHARACTERISTICS="public.accessibility.describes-video" in the | ||
| 91 | EXT-X-MEDIA entry for this track. When you keep the default choice, | ||
| 92 | Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS | ||
| 93 | flag can help with accessibility on Apple devices. For more | ||
| 94 | information, see the Apple documentation. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 IFrameOnlyManifest => Str | ||
| 98 | |||
| 99 | Choose Include (INCLUDE) to have MediaConvert generate a child manifest | ||
| 100 | that lists only the I-frames for this rendition, in addition to your | ||
| 101 | regular manifest for this rendition. You might use this manifest as | ||
| 102 | part of a workflow that creates preview functions for your video. | ||
| 103 | MediaConvert adds both the I-frame only child manifest and the regular | ||
| 104 | child manifest to the parent manifest. When you don't need the I-frame | ||
| 105 | only child manifest, keep the default value Exclude (EXCLUDE). | ||
| 106 | |||
| 107 | |||
| 108 | =head2 SegmentModifier => Str | ||
| 109 | |||
| 110 | Use this setting to add an identifying string to the filename of each | ||
| 111 | segment. The service adds this string between the name modifier and | ||
| 112 | segment index number. You can use format identifiers in the string. For | ||
| 113 | more information, see | ||
| 114 | https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |