software.amazon.awssdk.services.mediaconvert.model

Class CmfcSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.CmfcSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CmfcSettings.Builder,CmfcSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class CmfcSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CmfcSettings.Builder,CmfcSettings>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CmfcSettings.Builder

Method Summary

Modifier and Type	Method and Description
CmfcAudioDuration	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.
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.
String	audioGroupId() Specify the audio rendition group for this audio rendition.
String	audioRenditionSets() List the audio rendition groups that you want included with this video rendition.
CmfcAudioTrackType	audioTrackType() Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play.
String	audioTrackTypeAsString() Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play.
static CmfcSettings.Builder	builder()
CmfcDescriptiveVideoServiceFlag	descriptiveVideoServiceFlag() Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest.
String	descriptiveVideoServiceFlagAsString() Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CmfcIFrameOnlyManifest	iFrameOnlyManifest() Choose Include (INCLUDE) to have MediaConvert generate an HLS child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition.
String	iFrameOnlyManifestAsString() Choose Include (INCLUDE) to have MediaConvert generate an HLS child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition.
CmfcKlvMetadata	klvMetadata() To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough.
String	klvMetadataAsString() To include key-length-value metadata in this output: Set KLV metadata insertion to Passthrough.
CmfcManifestMetadataSignaling	manifestMetadataSignaling() To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled.
String	manifestMetadataSignalingAsString() To add an InbandEventStream element in your output MPD manifest for each type of event message, set Manifest metadata signaling to Enabled.
CmfcScte35Esam	scte35Esam() Use this setting only when you specify SCTE-35 markers from ESAM.
String	scte35EsamAsString() Use this setting only when you specify SCTE-35 markers from ESAM.
CmfcScte35Source	scte35Source() Ignore this setting unless you have SCTE-35 markers in your input video file.
String	scte35SourceAsString() Ignore this setting unless you have SCTE-35 markers in your input video file.
List<SdkField<?>>	sdkFields()
static Class<? extends CmfcSettings.Builder>	serializableBuilderClass()
CmfcTimedMetadata	timedMetadata() To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH).
String	timedMetadataAsString() To include ID3 metadata in this output: Set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH).
CmfcTimedMetadataBoxVersion	timedMetadataBoxVersion() Specify the event message box (eMSG) version for ID3 timed metadata in your output.
String	timedMetadataBoxVersionAsString() Specify the event message box (eMSG) version for ID3 timed metadata in your output.
String	timedMetadataSchemeIdUri() Specify the event message box (eMSG) scheme ID URI (scheme_id_uri) for ID3 timed metadata in your output.
String	timedMetadataValue() Specify the event message box (eMSG) value for ID3 timed metadata in your output.
CmfcSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

audioDuration

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

If the service returns an enum value that is not available in the current SDK version, audioDuration will return CmfcAudioDuration.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 (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.

See Also:

CmfcAudioDuration

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 (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.

If the service returns an enum value that is not available in the current SDK version, audioDuration will return CmfcAudioDuration.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 (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.

See Also:

CmfcAudioDuration

audioGroupId

public final String audioGroupId()

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

Returns:

Specify the audio rendition group for this audio rendition. Specify up to one value for each audio output in your output group. This value appears in your HLS parent manifest in the EXT-X-MEDIA tag of TYPE=AUDIO, as the value for the GROUP-ID attribute. For example, if you specify "audio_aac_1" for Audio group ID, it appears in your manifest like this: #EXT-X-MEDIA:TYPE=AUDIO,GROUP-ID="audio_aac_1". Related setting: To associate the rendition group that this audio track belongs to with a video rendition, include the same value that you provide here for that video output's setting Audio rendition sets (audioRenditionSets).

audioRenditionSets

public final String audioRenditionSets()

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1,audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

Returns:

List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs "audio_aac_1" and "audio_dolby". Then you would specify this value: "audio_aac_1,audio_dolby". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is "amazing_video_1.m3u8". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO="audio_aac_1"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO="audio_dolby"... amazing_video_1.m3u8

audioTrackType

public final CmfcAudioTrackType audioTrackType()

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation /http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

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

Returns:

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/ adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

See Also:

CmfcAudioTrackType

audioTrackTypeAsString

public final String audioTrackTypeAsString()

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation /http_live_streaming/example_playlists_for_http_live_streaming/adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

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

Returns:

Use this setting to control the values that MediaConvert puts in your HLS parent playlist to control how the client player selects which audio track to play. The other options for this setting determine the values that MediaConvert writes for the DEFAULT and AUTOSELECT attributes of the EXT-X-MEDIA entry for the audio variant. For more information about these attributes, see the Apple documentation article https://developer.apple.com/documentation/http_live_streaming/example_playlists_for_http_live_streaming/ adding_alternate_media_to_a_playlist. Choose Alternate audio, auto select, default (ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT) to set DEFAULT=YES and AUTOSELECT=YES. Choose this value for only one variant in your output group. Choose Alternate audio, auto select, not default (ALTERNATE_AUDIO_AUTO_SELECT) to set DEFAULT=NO and AUTOSELECT=YES. Choose Alternate Audio, Not Auto Select to set DEFAULT=NO and AUTOSELECT=NO. When you don't specify a value for this setting, MediaConvert defaults to Alternate audio, auto select, default. When there is more than one variant in your output group, you must explicitly choose a value for this setting.

See Also:

CmfcAudioTrackType

descriptiveVideoServiceFlag

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

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

Returns:

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.

See Also:

CmfcDescriptiveVideoServiceFlag

descriptiveVideoServiceFlagAsString

public final String descriptiveVideoServiceFlagAsString()

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.

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

Returns:

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.

See Also:

CmfcDescriptiveVideoServiceFlag

iFrameOnlyManifest

public final CmfcIFrameOnlyManifest iFrameOnlyManifest()

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

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

Returns:

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

See Also:

CmfcIFrameOnlyManifest

iFrameOnlyManifestAsString

public final String iFrameOnlyManifestAsString()

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

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

Returns:

Choose Include (INCLUDE) to have MediaConvert generate an HLS 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).

See Also:

CmfcIFrameOnlyManifest

klvMetadata

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

CmfcKlvMetadata

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 CmfcKlvMetadata.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:

CmfcKlvMetadata

manifestMetadataSignaling

public final CmfcManifestMetadataSignaling 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 (TimedMetadata) to Passthrough.

If the service returns an enum value that is not available in the current SDK version, manifestMetadataSignaling will return CmfcManifestMetadataSignaling.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 (TimedMetadata) to Passthrough.

See Also:

CmfcManifestMetadataSignaling

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 (TimedMetadata) to Passthrough.

If the service returns an enum value that is not available in the current SDK version, manifestMetadataSignaling will return CmfcManifestMetadataSignaling.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 (TimedMetadata) to Passthrough.

See Also:

CmfcManifestMetadataSignaling

scte35Esam

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

If the service returns an enum value that is not available in the current SDK version, scte35Esam will return CmfcScte35Esam.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 (sccXml).

See Also:

CmfcScte35Esam

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 (sccXml).

If the service returns an enum value that is not available in the current SDK version, scte35Esam will return CmfcScte35Esam.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 (sccXml).

See Also:

CmfcScte35Esam

scte35Source

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

If the service returns an enum value that is not available in the current SDK version, scte35Source will return CmfcScte35Source.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 (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.

See Also:

CmfcScte35Source

scte35SourceAsString

public final String scte35SourceAsString()

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.

If the service returns an enum value that is not available in the current SDK version, scte35Source will return CmfcScte35Source.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 (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.

See Also:

CmfcScte35Source

timedMetadata

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

If the service returns an enum value that is not available in the current SDK version, timedMetadata will return CmfcTimedMetadata.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 (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.

See Also:

CmfcTimedMetadata

timedMetadataAsString

public final String timedMetadataAsString()

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.

If the service returns an enum value that is not available in the current SDK version, timedMetadata will return CmfcTimedMetadata.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 (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.

See Also:

CmfcTimedMetadata

timedMetadataBoxVersion

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

If the service returns an enum value that is not available in the current SDK version, timedMetadataBoxVersion will return CmfcTimedMetadataBoxVersion.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 (timedMetadata) to Passthrough.

See Also:

CmfcTimedMetadataBoxVersion

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 (timedMetadata) to Passthrough.

If the service returns an enum value that is not available in the current SDK version, timedMetadataBoxVersion will return CmfcTimedMetadataBoxVersion.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 (timedMetadata) to Passthrough.

See Also:

CmfcTimedMetadataBoxVersion

timedMetadataSchemeIdUri

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

Returns:

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

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

Returns:

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.

toBuilder

public CmfcSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CmfcSettings.Builder,CmfcSettings>

builder

public static CmfcSettings.Builder builder()

serializableBuilderClass

public static Class<? extends CmfcSettings.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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