libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaConvert.Types.HlsSettings

Description

 
Synopsis

Documentation

data HlsSettings Source #

Settings for HLS output groups

See: newHlsSettings smart constructor.

Constructors

HlsSettings' 

Fields

  • descriptiveVideoServiceFlag :: Maybe HlsDescriptiveVideoServiceFlag

    Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

  • audioRenditionSets :: Maybe Text

    List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.

  • iFrameOnlyManifest :: Maybe HlsIFrameOnlyManifest

    Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude (EXCLUDE).

  • audioGroupId :: Maybe Text

    Specifies the group to which the audio rendition belongs.

  • segmentModifier :: Maybe Text

    Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html

  • audioOnlyContainer :: Maybe HlsAudioOnlyContainer

    Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

  • audioTrackType :: Maybe HlsAudioTrackType

    Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

Instances

Instances details
Eq HlsSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.HlsSettings

Read HlsSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.HlsSettings

Show HlsSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.HlsSettings

Generic HlsSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.HlsSettings

Associated Types

type Rep HlsSettings :: Type -> Type #

NFData HlsSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.HlsSettings

Methods

rnf :: HlsSettings -> () #

Hashable HlsSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.HlsSettings

ToJSON HlsSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.HlsSettings

FromJSON HlsSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.HlsSettings

type Rep HlsSettings Source # 
Instance details

Defined in Amazonka.MediaConvert.Types.HlsSettings

type Rep HlsSettings = D1 ('MetaData "HlsSettings" "Amazonka.MediaConvert.Types.HlsSettings" "libZSservicesZSamazonka-mediaconvertZSamazonka-mediaconvert" 'False) (C1 ('MetaCons "HlsSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "descriptiveVideoServiceFlag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HlsDescriptiveVideoServiceFlag)) :*: (S1 ('MetaSel ('Just "audioRenditionSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iFrameOnlyManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HlsIFrameOnlyManifest)))) :*: ((S1 ('MetaSel ('Just "audioGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "segmentModifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "audioOnlyContainer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HlsAudioOnlyContainer)) :*: S1 ('MetaSel ('Just "audioTrackType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HlsAudioTrackType))))))

newHlsSettings :: HlsSettings Source #

Create a value of HlsSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:descriptiveVideoServiceFlag:HlsSettings', hlsSettings_descriptiveVideoServiceFlag - Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

$sel:audioRenditionSets:HlsSettings', hlsSettings_audioRenditionSets - List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.

$sel:iFrameOnlyManifest:HlsSettings', hlsSettings_iFrameOnlyManifest - Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude (EXCLUDE).

$sel:audioGroupId:HlsSettings', hlsSettings_audioGroupId - Specifies the group to which the audio rendition belongs.

$sel:segmentModifier:HlsSettings', hlsSettings_segmentModifier - Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html

$sel:audioOnlyContainer:HlsSettings', hlsSettings_audioOnlyContainer - Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

$sel:audioTrackType:HlsSettings', hlsSettings_audioTrackType - Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

hlsSettings_descriptiveVideoServiceFlag :: Lens' HlsSettings (Maybe HlsDescriptiveVideoServiceFlag) Source #

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag (FLAG), MediaConvert includes the parameter CHARACTERISTICS="public.accessibility.describes-video" in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don't flag (DONT_FLAG), MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

hlsSettings_audioRenditionSets :: Lens' HlsSettings (Maybe Text) Source #

List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.

hlsSettings_iFrameOnlyManifest :: Lens' HlsSettings (Maybe HlsIFrameOnlyManifest) Source #

Choose Include (INCLUDE) to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don't need the I-frame only child manifest, keep the default value Exclude (EXCLUDE).

hlsSettings_audioGroupId :: Lens' HlsSettings (Maybe Text) Source #

Specifies the group to which the audio rendition belongs.

hlsSettings_segmentModifier :: Lens' HlsSettings (Maybe Text) Source #

Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html

hlsSettings_audioOnlyContainer :: Lens' HlsSettings (Maybe HlsAudioOnlyContainer) Source #

Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

hlsSettings_audioTrackType :: Lens' HlsSettings (Maybe HlsAudioTrackType) Source #

Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO