Package software.amazon.awssdk.services.mediaconvert.model

Class MpdSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.MpdSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MpdSettings.Builder,MpdSettings>
@Generated("software.amazon.awssdk:codegen") public final class MpdSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MpdSettings.Builder,MpdSettings>
These settings relate to the fragmented MP4 container for the segments in your DASH outputs.
See Also:

  • Method Details

    • accessibilityCaptionHints

      public final 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:

      If the service returns an enum value that is not available in the current SDK version, accessibilityCaptionHints will return MpdAccessibilityCaptionHints.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessibilityCaptionHintsAsString().

      Returns:
      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:
      See Also:

    • accessibilityCaptionHintsAsString

      public final String accessibilityCaptionHintsAsString()
      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:

      If the service returns an enum value that is not available in the current SDK version, accessibilityCaptionHints will return MpdAccessibilityCaptionHints.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessibilityCaptionHintsAsString().

      Returns:
      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:
      See Also:

    • audioDuration

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, audioDuration will return MpdAudioDuration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioDurationAsString().

      Returns:
      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.
      See Also:

    • audioDurationAsString

      public final String audioDurationAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, audioDuration will return MpdAudioDuration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioDurationAsString().

      Returns:
      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.
      See Also:

    • captionContainerType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, captionContainerType will return MpdCaptionContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captionContainerTypeAsString().

      Returns:
      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.
      See Also:

    • captionContainerTypeAsString

      public final String captionContainerTypeAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, captionContainerType will return MpdCaptionContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from captionContainerTypeAsString().

      Returns:
      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.
      See Also:

    • klvMetadata

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, klvMetadata will return MpdKlvMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from klvMetadataAsString().

      Returns:
      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.
      See Also:

    • klvMetadataAsString

      public final String klvMetadataAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, klvMetadata will return MpdKlvMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from klvMetadataAsString().

      Returns:
      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.
      See Also:

    • manifestMetadataSignaling

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, manifestMetadataSignaling will return MpdManifestMetadataSignaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from manifestMetadataSignalingAsString().

      Returns:
      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.
      See Also:

    • manifestMetadataSignalingAsString

      public final String manifestMetadataSignalingAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, manifestMetadataSignaling will return MpdManifestMetadataSignaling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from manifestMetadataSignalingAsString().

      Returns:
      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.
      See Also:

    • scte35Esam

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, scte35Esam will return MpdScte35Esam.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scte35EsamAsString().

      Returns:
      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.
      See Also:

    • scte35EsamAsString

      public final String scte35EsamAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, scte35Esam will return MpdScte35Esam.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scte35EsamAsString().

      Returns:
      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.
      See Also:

    • scte35Source

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, scte35Source will return MpdScte35Source.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scte35SourceAsString().

      Returns:
      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.
      See Also:

    • scte35SourceAsString

      public final String scte35SourceAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, scte35Source will return MpdScte35Source.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scte35SourceAsString().

      Returns:
      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.
      See Also:

    • timedMetadata

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, timedMetadata will return MpdTimedMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timedMetadataAsString().

      Returns:
      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.
      See Also:

    • timedMetadataAsString

      public final String timedMetadataAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, timedMetadata will return MpdTimedMetadata.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timedMetadataAsString().

      Returns:
      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.
      See Also:

    • timedMetadataBoxVersion

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, timedMetadataBoxVersion will return MpdTimedMetadataBoxVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timedMetadataBoxVersionAsString().

      Returns:
      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.
      See Also:

    • timedMetadataBoxVersionAsString

      public final String timedMetadataBoxVersionAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, timedMetadataBoxVersion will return MpdTimedMetadataBoxVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timedMetadataBoxVersionAsString().

      Returns:
      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.
      See Also:

    • timedMetadataSchemeIdUri

      public final 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.
      Returns:
      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.

    • timedMetadataValue

      public final 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.
      Returns:
      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.

    • toBuilder

      public MpdSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MpdSettings.Builder,MpdSettings>
      Returns:
      a builder for type T

    • builder

      public static MpdSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MpdSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.