software.amazon.awssdk.services.mediaconvert.model

Interface MpdSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MpdSettings.Builder,MpdSettings>, SdkBuilder<MpdSettings.Builder,MpdSettings>, SdkPojo

Enclosing class:

MpdSettings

public static interface MpdSettings.Builder
extends SdkPojo, CopyableBuilder<MpdSettings.Builder,MpdSettings>

Method Summary

Modifier and Type	Method and Description
MpdSettings.Builder	accessibilityCaptionHints(MpdAccessibilityCaptionHints accessibilityCaptionHints) Optional.
MpdSettings.Builder	accessibilityCaptionHints(String accessibilityCaptionHints) Optional.
MpdSettings.Builder	audioDuration(MpdAudioDuration 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.
MpdSettings.Builder	audioDuration(String 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.
MpdSettings.Builder	captionContainerType(MpdCaptionContainerType captionContainerType) Use this setting only in DASH output groups that include sidecar TTML or IMSC captions.
MpdSettings.Builder	captionContainerType(String captionContainerType) Use this setting only in DASH output groups that include sidecar TTML or IMSC captions.
MpdSettings.Builder	klvMetadata(MpdKlvMetadata klvMetadata) To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough.
MpdSettings.Builder	klvMetadata(String klvMetadata) To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough.
MpdSettings.Builder	manifestMetadataSignaling(MpdManifestMetadataSignaling manifestMetadataSignaling) To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled.
MpdSettings.Builder	manifestMetadataSignaling(String manifestMetadataSignaling) To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled.
MpdSettings.Builder	scte35Esam(MpdScte35Esam scte35Esam) Use this setting only when you specify SCTE-35 markers from ESAM.
MpdSettings.Builder	scte35Esam(String scte35Esam) Use this setting only when you specify SCTE-35 markers from ESAM.
MpdSettings.Builder	scte35Source(MpdScte35Source scte35Source) Ignore this setting unless you have SCTE-35 markers in your input video file.
MpdSettings.Builder	scte35Source(String scte35Source) Ignore this setting unless you have SCTE-35 markers in your input video file.
MpdSettings.Builder	timedMetadata(MpdTimedMetadata timedMetadata) To include ID3 metadata in this output: Set ID3 metadata to Passthrough.
MpdSettings.Builder	timedMetadata(String timedMetadata) To include ID3 metadata in this output: Set ID3 metadata to Passthrough.
MpdSettings.Builder	timedMetadataBoxVersion(MpdTimedMetadataBoxVersion timedMetadataBoxVersion) Specify the event message box (eMSG) version for ID3 timed metadata in your output.
MpdSettings.Builder	timedMetadataBoxVersion(String timedMetadataBoxVersion) Specify the event message box (eMSG) version for ID3 timed metadata in your output.
MpdSettings.Builder	timedMetadataSchemeIdUri(String timedMetadataSchemeIdUri) Specify the event message box (eMSG) scheme ID URI for ID3 timed metadata in your output.
MpdSettings.Builder	timedMetadataValue(String timedMetadataValue) Specify the event message box (eMSG) value for ID3 timed metadata in your output.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

accessibilityCaptionHints

MpdSettings.Builder accessibilityCaptionHints(String accessibilityCaptionHints)

Optional. Choose 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, to leave these elements out. When you enable this setting, this is the markup that MediaConvert includes in your manifest:

Parameters:

accessibilityCaptionHints - Optional. Choose 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, to leave these elements out. When you enable this setting, this is the markup that MediaConvert includes in your manifest:

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdAccessibilityCaptionHints, MpdAccessibilityCaptionHints

accessibilityCaptionHints

MpdSettings.Builder accessibilityCaptionHints(MpdAccessibilityCaptionHints accessibilityCaptionHints)

Optional. Choose 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, to leave these elements out. When you enable this setting, this is the markup that MediaConvert includes in your manifest:

Parameters:

accessibilityCaptionHints - Optional. Choose 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, to leave these elements out. When you enable this setting, this is the markup that MediaConvert includes in your manifest:

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdAccessibilityCaptionHints, MpdAccessibilityCaptionHints

audioDuration

MpdSettings.Builder audioDuration(String 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. In all other cases, keep the default value, 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.

Parameters:

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. In all other cases, keep the default value, 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdAudioDuration, MpdAudioDuration

audioDuration

MpdSettings.Builder audioDuration(MpdAudioDuration 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. In all other cases, keep the default value, 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.

Parameters:

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. In all other cases, keep the default value, 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdAudioDuration, MpdAudioDuration

captionContainerType

MpdSettings.Builder captionContainerType(String 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 for captions in a single XML file in a raw container. Choose Fragmented MPEG-4 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.

Parameters:

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 for captions in a single XML file in a raw container. Choose Fragmented MPEG-4 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdCaptionContainerType, MpdCaptionContainerType

captionContainerType

MpdSettings.Builder captionContainerType(MpdCaptionContainerType 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 for captions in a single XML file in a raw container. Choose Fragmented MPEG-4 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.

Parameters:

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 for captions in a single XML file in a raw container. Choose Fragmented MPEG-4 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdCaptionContainerType, MpdCaptionContainerType

klvMetadata

MpdSettings.Builder klvMetadata(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdKlvMetadata, MpdKlvMetadata

klvMetadata

MpdSettings.Builder klvMetadata(MpdKlvMetadata 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdKlvMetadata, MpdKlvMetadata

manifestMetadataSignaling

MpdSettings.Builder manifestMetadataSignaling(String 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. To enable Manifest metadata signaling, you must also set SCTE-35 source to Passthrough, ESAM SCTE-35 to insert, or ID3 metadata to Passthrough.

Parameters:

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. To enable Manifest metadata signaling, you must also set SCTE-35 source to Passthrough, ESAM SCTE-35 to insert, or ID3 metadata to Passthrough.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdManifestMetadataSignaling, MpdManifestMetadataSignaling

manifestMetadataSignaling

MpdSettings.Builder manifestMetadataSignaling(MpdManifestMetadataSignaling 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. To enable Manifest metadata signaling, you must also set SCTE-35 source to Passthrough, ESAM SCTE-35 to insert, or ID3 metadata to Passthrough.

Parameters:

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. To enable Manifest metadata signaling, you must also set SCTE-35 source to Passthrough, ESAM SCTE-35 to insert, or ID3 metadata to Passthrough.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdManifestMetadataSignaling, MpdManifestMetadataSignaling

scte35Esam

MpdSettings.Builder scte35Esam(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdScte35Esam, MpdScte35Esam

scte35Esam

MpdSettings.Builder scte35Esam(MpdScte35Esam 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdScte35Esam, MpdScte35Esam

scte35Source

MpdSettings.Builder scte35Source(String scte35Source)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdScte35Source, MpdScte35Source

scte35Source

MpdSettings.Builder scte35Source(MpdScte35Source scte35Source)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdScte35Source, MpdScte35Source

timedMetadata

MpdSettings.Builder timedMetadata(String timedMetadata)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdTimedMetadata, MpdTimedMetadata

timedMetadata

MpdSettings.Builder timedMetadata(MpdTimedMetadata timedMetadata)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdTimedMetadata, MpdTimedMetadata

timedMetadataBoxVersion

MpdSettings.Builder timedMetadataBoxVersion(String 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 to Passthrough.

Parameters:

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 to Passthrough.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdTimedMetadataBoxVersion, MpdTimedMetadataBoxVersion

timedMetadataBoxVersion

MpdSettings.Builder timedMetadataBoxVersion(MpdTimedMetadataBoxVersion 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 to Passthrough.

Parameters:

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 to Passthrough.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MpdTimedMetadataBoxVersion, MpdTimedMetadataBoxVersion

timedMetadataSchemeIdUri

MpdSettings.Builder timedMetadataSchemeIdUri(String timedMetadataSchemeIdUri)

Specify the event message box (eMSG) scheme ID URI for ID3 timed metadata in your output. For more information, 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 to Passthrough.

Parameters:

timedMetadataSchemeIdUri - Specify the event message box (eMSG) scheme ID URI for ID3 timed metadata in your output. For more information, 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 to Passthrough.

Returns:

Returns a reference to this object so that method calls can be chained together.

timedMetadataValue

MpdSettings.Builder timedMetadataValue(String timedMetadataValue)

Specify the event message box (eMSG) value for ID3 timed metadata in your output. For more information, 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 to Passthrough.

Parameters:

timedMetadataValue - Specify the event message box (eMSG) value for ID3 timed metadata in your output. For more information, 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 to Passthrough.

Returns:

Returns a reference to this object so that method calls can be chained together.