Amazonka.MediaConvert.Types.MpdSettings

Documentation

data MpdSettings

These settings relate to the fragmented MP4 container for the segments in your DASH outputs.

See: newMpdSettings smart constructor.

Constructors

MpdSettings'

Fields

• accessibilityCaptionHints :: Maybe MpdAccessibilityCaptionHints

  Optional. Choose Include (INCLUDE) to have MediaConvert mark up your DASH manifest with elements for embedded 608 captions. This markup isn't generally required, but some video players require it to discover and play embedded 608 captions. Keep the default value, Exclude (EXCLUDE), to leave these elements out. When you enable this setting, this is the markup that MediaConvert includes in your manifest:

• audioDuration :: Maybe MpdAudioDuration

  Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

• captionContainerType :: Maybe MpdCaptionContainerType

  Use this setting only in DASH output groups that include sidecar TTML or IMSC captions. You specify sidecar captions in a separate output from your audio and video. Choose Raw (RAW) for captions in a single XML file in a raw container. Choose Fragmented MPEG-4 (FRAGMENTED_MP4) for captions in XML format contained within fragmented MP4 files. This set of fragmented MP4 files is separate from your video and audio fragmented MP4 files.

• klvMetadata :: Maybe MpdKlvMetadata

  To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and writes each instance to a separate event message box in the output, according to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.

• manifestMetadataSignaling :: Maybe MpdManifestMetadataSignaling

  To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled. For ID3 event messages, the InbandEventStream element schemeIdUri will be same value that you specify for ID3 metadata scheme ID URI. For SCTE35 event messages, the InbandEventStream element schemeIdUri will be "urn:scte:scte35:2013:bin". To leave these elements out of your output MPD manifest, set Manifest metadata signaling to Disabled.

• scte35Esam :: Maybe MpdScte35Esam

  Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

• scte35Source :: Maybe MpdScte35Source

  Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.

• timedMetadata :: Maybe MpdTimedMetadata

  To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.

• timedMetadataBoxVersion :: Maybe MpdTimedMetadataBoxVersion

  Specify the event message box (eMSG) version for ID3 timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.3 Syntax. Leave blank to use the default value Version 0. When you specify Version 1, you must also set ID3 metadata (timedMetadata) to Passthrough.

• timedMetadataSchemeIdUri :: Maybe Text

  Specify the event message box (eMSG) scheme ID URI (scheme_id_uri) for ID3 timed metadata in your output. For more informaiton, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. Leave blank to use the default value: https://aomedia.org/emsg/ID3 When you specify a value for ID3 metadata scheme ID URI, you must also set ID3 metadata (timedMetadata) to Passthrough.

• timedMetadataValue :: Maybe Text

  Specify the event message box (eMSG) value for ID3 timed metadata in your output. For more informaiton, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. When you specify a value for ID3 Metadata Value, you must also set ID3 metadata (timedMetadata) to Passthrough.

Instances

FromJSON MpdSettings

Defined in Amazonka.MediaConvert.Types.MpdSettings

Methods

parseJSON :: Value -> Parser MpdSettings

parseJSONList :: Value -> Parser [MpdSettings]

ToJSON MpdSettings

Defined in Amazonka.MediaConvert.Types.MpdSettings

Methods

toJSON :: MpdSettings -> Value

toEncoding :: MpdSettings -> Encoding

toJSONList :: [MpdSettings] -> Value

toEncodingList :: [MpdSettings] -> Encoding

Generic MpdSettings

Defined in Amazonka.MediaConvert.Types.MpdSettings

Associated Types

type Rep MpdSettings :: Type -> Type

Methods

from :: MpdSettings -> Rep MpdSettings x

to :: Rep MpdSettings x -> MpdSettings

Read MpdSettings

Defined in Amazonka.MediaConvert.Types.MpdSettings

Methods

readsPrec :: Int -> ReadS MpdSettings

readList :: ReadS [MpdSettings]

readPrec :: ReadPrec MpdSettings

readListPrec :: ReadPrec [MpdSettings]

Show MpdSettings

Defined in Amazonka.MediaConvert.Types.MpdSettings

Methods

showsPrec :: Int -> MpdSettings -> ShowS

show :: MpdSettings -> String

showList :: [MpdSettings] -> ShowS

NFData MpdSettings

Defined in Amazonka.MediaConvert.Types.MpdSettings

Methods

rnf :: MpdSettings -> ()

Eq MpdSettings

Defined in Amazonka.MediaConvert.Types.MpdSettings

Methods

(==) :: MpdSettings -> MpdSettings -> Bool

(/=) :: MpdSettings -> MpdSettings -> Bool

Hashable MpdSettings

Defined in Amazonka.MediaConvert.Types.MpdSettings

Methods

hashWithSalt :: Int -> MpdSettings -> Int

hash :: MpdSettings -> Int

type Rep MpdSettings

Defined in Amazonka.MediaConvert.Types.MpdSettings

type Rep MpdSettings = D1 ('MetaData "MpdSettings" "Amazonka.MediaConvert.Types.MpdSettings" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "MpdSettings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accessibilityCaptionHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MpdAccessibilityCaptionHints)) :*: S1 ('MetaSel ('Just "audioDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MpdAudioDuration))) :*: (S1 ('MetaSel ('Just "captionContainerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MpdCaptionContainerType)) :*: (S1 ('MetaSel ('Just "klvMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MpdKlvMetadata)) :*: S1 ('MetaSel ('Just "manifestMetadataSignaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MpdManifestMetadataSignaling))))) :*: ((S1 ('MetaSel ('Just "scte35Esam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MpdScte35Esam)) :*: (S1 ('MetaSel ('Just "scte35Source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MpdScte35Source)) :*: S1 ('MetaSel ('Just "timedMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MpdTimedMetadata)))) :*: (S1 ('MetaSel ('Just "timedMetadataBoxVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MpdTimedMetadataBoxVersion)) :*: (S1 ('MetaSel ('Just "timedMetadataSchemeIdUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timedMetadataValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newMpdSettings :: MpdSettings

Create a value of MpdSettings 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:accessibilityCaptionHints:MpdSettings', mpdSettings_accessibilityCaptionHints - Optional. Choose Include (INCLUDE) to have MediaConvert mark up your DASH manifest with elements for embedded 608 captions. This markup isn't generally required, but some video players require it to discover and play embedded 608 captions. Keep the default value, Exclude (EXCLUDE), to leave these elements out. When you enable this setting, this is the markup that MediaConvert includes in your manifest:

$sel:audioDuration:MpdSettings', mpdSettings_audioDuration - Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

$sel:captionContainerType:MpdSettings', mpdSettings_captionContainerType - Use this setting only in DASH output groups that include sidecar TTML or IMSC captions. You specify sidecar captions in a separate output from your audio and video. Choose Raw (RAW) for captions in a single XML file in a raw container. Choose Fragmented MPEG-4 (FRAGMENTED_MP4) for captions in XML format contained within fragmented MP4 files. This set of fragmented MP4 files is separate from your video and audio fragmented MP4 files.

$sel:klvMetadata:MpdSettings', mpdSettings_klvMetadata - To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and writes each instance to a separate event message box in the output, according to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.

$sel:manifestMetadataSignaling:MpdSettings', mpdSettings_manifestMetadataSignaling - To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled. For ID3 event messages, the InbandEventStream element schemeIdUri will be same value that you specify for ID3 metadata scheme ID URI. For SCTE35 event messages, the InbandEventStream element schemeIdUri will be "urn:scte:scte35:2013:bin". To leave these elements out of your output MPD manifest, set Manifest metadata signaling to Disabled.

$sel:scte35Esam:MpdSettings', mpdSettings_scte35Esam - Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

$sel:scte35Source:MpdSettings', mpdSettings_scte35Source - Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.

$sel:timedMetadata:MpdSettings', mpdSettings_timedMetadata - To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.

$sel:timedMetadataBoxVersion:MpdSettings', mpdSettings_timedMetadataBoxVersion - Specify the event message box (eMSG) version for ID3 timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.3 Syntax. Leave blank to use the default value Version 0. When you specify Version 1, you must also set ID3 metadata (timedMetadata) to Passthrough.

$sel:timedMetadataSchemeIdUri:MpdSettings', mpdSettings_timedMetadataSchemeIdUri - Specify the event message box (eMSG) scheme ID URI (scheme_id_uri) for ID3 timed metadata in your output. For more informaiton, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. Leave blank to use the default value: https://aomedia.org/emsg/ID3 When you specify a value for ID3 metadata scheme ID URI, you must also set ID3 metadata (timedMetadata) to Passthrough.

$sel:timedMetadataValue:MpdSettings', mpdSettings_timedMetadataValue - Specify the event message box (eMSG) value for ID3 timed metadata in your output. For more informaiton, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. When you specify a value for ID3 Metadata Value, you must also set ID3 metadata (timedMetadata) to Passthrough.

mpdSettings_accessibilityCaptionHints :: Lens' MpdSettings (Maybe MpdAccessibilityCaptionHints)

Optional. Choose Include (INCLUDE) to have MediaConvert mark up your DASH manifest with elements for embedded 608 captions. This markup isn't generally required, but some video players require it to discover and play embedded 608 captions. Keep the default value, Exclude (EXCLUDE), to leave these elements out. When you enable this setting, this is the markup that MediaConvert includes in your manifest:

mpdSettings_audioDuration :: Lens' MpdSettings (Maybe MpdAudioDuration)

Specify this setting only when your output will be consumed by a downstream repackaging workflow that is sensitive to very small duration differences between video and audio. For this situation, choose Match video duration (MATCH_VIDEO_DURATION). In all other cases, keep the default value, Default codec duration (DEFAULT_CODEC_DURATION). When you choose Match video duration, MediaConvert pads the output audio streams with silence or trims them to ensure that the total duration of each audio stream is at least as long as the total duration of the video stream. After padding or trimming, the audio stream duration is no more than one frame longer than the video stream. MediaConvert applies audio padding or trimming only to the end of the last segment of the output. For unsegmented outputs, MediaConvert adds padding only to the end of the file. When you keep the default value, any minor discrepancies between audio and video duration will depend on your output audio codec.

mpdSettings_captionContainerType :: Lens' MpdSettings (Maybe MpdCaptionContainerType)

Use this setting only in DASH output groups that include sidecar TTML or IMSC captions. You specify sidecar captions in a separate output from your audio and video. Choose Raw (RAW) for captions in a single XML file in a raw container. Choose Fragmented MPEG-4 (FRAGMENTED_MP4) for captions in XML format contained within fragmented MP4 files. This set of fragmented MP4 files is separate from your video and audio fragmented MP4 files.

mpdSettings_klvMetadata :: Lens' MpdSettings (Maybe MpdKlvMetadata)

To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough. MediaConvert reads KLV metadata present in your input and writes each instance to a separate event message box in the output, according to MISB ST1910.1. To exclude this KLV metadata: Set KLV metadata insertion to None or leave blank.

mpdSettings_manifestMetadataSignaling :: Lens' MpdSettings (Maybe MpdManifestMetadataSignaling)

To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled. For ID3 event messages, the InbandEventStream element schemeIdUri will be same value that you specify for ID3 metadata scheme ID URI. For SCTE35 event messages, the InbandEventStream element schemeIdUri will be "urn:scte:scte35:2013:bin". To leave these elements out of your output MPD manifest, set Manifest metadata signaling to Disabled.

mpdSettings_scte35Esam :: Lens' MpdSettings (Maybe MpdScte35Esam)

Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).

mpdSettings_scte35Source :: Lens' MpdSettings (Maybe MpdScte35Source)

Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.

mpdSettings_timedMetadata :: Lens' MpdSettings (Maybe MpdTimedMetadata)

To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH). Specify this ID3 metadata in Custom ID3 metadata inserter (timedMetadataInsertion). MediaConvert writes each instance of ID3 metadata in a separate Event Message (eMSG) box. To exclude this ID3 metadata: Set ID3 metadata to None (NONE) or leave blank.

mpdSettings_timedMetadataBoxVersion :: Lens' MpdSettings (Maybe MpdTimedMetadataBoxVersion)

Specify the event message box (eMSG) version for ID3 timed metadata in your output. For more information, see ISO/IEC 23009-1:2022 section 5.10.3.3.3 Syntax. Leave blank to use the default value Version 0. When you specify Version 1, you must also set ID3 metadata (timedMetadata) to Passthrough.

mpdSettings_timedMetadataSchemeIdUri :: Lens' MpdSettings (Maybe Text)

Specify the event message box (eMSG) scheme ID URI (scheme_id_uri) for ID3 timed metadata in your output. For more informaiton, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. Leave blank to use the default value: https://aomedia.org/emsg/ID3 When you specify a value for ID3 metadata scheme ID URI, you must also set ID3 metadata (timedMetadata) to Passthrough.

mpdSettings_timedMetadataValue :: Lens' MpdSettings (Maybe Text)

Specify the event message box (eMSG) value for ID3 timed metadata in your output. For more informaiton, see ISO/IEC 23009-1:2022 section 5.10.3.3.4 Semantics. When you specify a value for ID3 Metadata Value, you must also set ID3 metadata (timedMetadata) to Passthrough.