software.amazon.awssdk.services.mediaconvert.model

Class DashIsoGroupSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.DashIsoGroupSettings

All Implemented Interfaces:

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

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

Settings related to your DASH output package. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/outputs-file-ABR.html. When you work directly in your JSON job specification, include this object and any required children when you set Type, under OutputGroupSettings, to DASH_ISO_GROUP_SETTINGS.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DashIsoGroupSettings.Builder

Method Summary

Modifier and Type	Method and Description
List<DashAdditionalManifest>	additionalManifests() By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job.
DashIsoGroupAudioChannelConfigSchemeIdUri	audioChannelConfigSchemeIdUri() Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby channel configuration tag, rather than the MPEG one.
String	audioChannelConfigSchemeIdUriAsString() Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby channel configuration tag, rather than the MPEG one.
String	baseUrl() A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element.
static DashIsoGroupSettings.Builder	builder()
String	destination() Use Destination (Destination) to specify the S3 output location and the output filename base.
DestinationSettings	destinationSettings() Settings associated with the destination.
DashIsoEncryptionSettings	encryption() DRM settings.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	fragmentLength() Length of fragments to generate (in seconds).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalManifests() Returns true if the AdditionalManifests property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
DashIsoHbbtvCompliance	hbbtvCompliance() Supports HbbTV specification as indicated
String	hbbtvComplianceAsString() Supports HbbTV specification as indicated
Integer	minBufferTime() Minimum time of initially buffered media that is needed to ensure smooth playout.
Double	minFinalSegmentLength() Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset.
DashIsoMpdProfile	mpdProfile() Specify whether your DASH profile is on-demand or main.
String	mpdProfileAsString() Specify whether your DASH profile is on-demand or main.
DashIsoPtsOffsetHandlingForBFrames	ptsOffsetHandlingForBFrames() Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS).
String	ptsOffsetHandlingForBFramesAsString() Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS).
List<SdkField<?>>	sdkFields()
DashIsoSegmentControl	segmentControl() When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length.
String	segmentControlAsString() When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length.
Integer	segmentLength() Length of mpd segments to create (in seconds).
static Class<? extends DashIsoGroupSettings.Builder>	serializableBuilderClass()
DashIsoGroupSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
DashIsoWriteSegmentTimelineInRepresentation	writeSegmentTimelineInRepresentation() If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again.
String	writeSegmentTimelineInRepresentationAsString() If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again.

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

hasAdditionalManifests

public final boolean hasAdditionalManifests()

Returns true if the AdditionalManifests property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

additionalManifests

public final List<DashAdditionalManifest> additionalManifests()

By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default manifest references every output in the output group. To create additional DASH manifests that reference a subset of the outputs in the output group, specify a list of them here.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAdditionalManifests() to see if a value was sent in this field.

Returns:

By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default manifest references every output in the output group. To create additional DASH manifests that reference a subset of the outputs in the output group, specify a list of them here.

audioChannelConfigSchemeIdUri

public final DashIsoGroupAudioChannelConfigSchemeIdUri audioChannelConfigSchemeIdUri()

Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby channel configuration tag, rather than the MPEG one. For example, you might need to use this to make dynamic ad insertion work. Specify which audio channel configuration scheme ID URI MediaConvert writes in your DASH manifest. Keep the default value, MPEG channel configuration (MPEG_CHANNEL_CONFIGURATION), to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel configuration (DOLBY_CHANNEL_CONFIGURATION) to have MediaConvert write this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011.

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

Returns:

Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby channel configuration tag, rather than the MPEG one. For example, you might need to use this to make dynamic ad insertion work. Specify which audio channel configuration scheme ID URI MediaConvert writes in your DASH manifest. Keep the default value, MPEG channel configuration (MPEG_CHANNEL_CONFIGURATION), to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel configuration (DOLBY_CHANNEL_CONFIGURATION) to have MediaConvert write this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011.

See Also:

DashIsoGroupAudioChannelConfigSchemeIdUri

audioChannelConfigSchemeIdUriAsString

public final String audioChannelConfigSchemeIdUriAsString()

Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby channel configuration tag, rather than the MPEG one. For example, you might need to use this to make dynamic ad insertion work. Specify which audio channel configuration scheme ID URI MediaConvert writes in your DASH manifest. Keep the default value, MPEG channel configuration (MPEG_CHANNEL_CONFIGURATION), to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel configuration (DOLBY_CHANNEL_CONFIGURATION) to have MediaConvert write this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011.

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

Returns:

Use this setting only when your audio codec is a Dolby one (AC3, EAC3, or Atmos) and your downstream workflow requires that your DASH manifest use the Dolby channel configuration tag, rather than the MPEG one. For example, you might need to use this to make dynamic ad insertion work. Specify which audio channel configuration scheme ID URI MediaConvert writes in your DASH manifest. Keep the default value, MPEG channel configuration (MPEG_CHANNEL_CONFIGURATION), to have MediaConvert write this: urn:mpeg:mpegB:cicp:ChannelConfiguration. Choose Dolby channel configuration (DOLBY_CHANNEL_CONFIGURATION) to have MediaConvert write this instead: tag:dolby.com,2014:dash:audio_channel_configuration:2011.

See Also:

DashIsoGroupAudioChannelConfigSchemeIdUri

baseUrl

public final String baseUrl()

A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

Returns:

A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.

destination

public final String destination()

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

Returns:

Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.

destinationSettings

public final DestinationSettings destinationSettings()

Settings associated with the destination. Will vary based on the type of destination

Returns:

Settings associated with the destination. Will vary based on the type of destination

encryption

public final DashIsoEncryptionSettings encryption()

DRM settings.

Returns:

DRM settings.

fragmentLength

public final Integer fragmentLength()

Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

Returns:

Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

hbbtvCompliance

public final DashIsoHbbtvCompliance hbbtvCompliance()

Supports HbbTV specification as indicated

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

Returns:

Supports HbbTV specification as indicated

See Also:

DashIsoHbbtvCompliance

hbbtvComplianceAsString

public final String hbbtvComplianceAsString()

Supports HbbTV specification as indicated

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

Returns:

Supports HbbTV specification as indicated

See Also:

DashIsoHbbtvCompliance

minBufferTime

public final Integer minBufferTime()

Minimum time of initially buffered media that is needed to ensure smooth playout.

Returns:

Minimum time of initially buffered media that is needed to ensure smooth playout.

minFinalSegmentLength

public final Double minFinalSegmentLength()

Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

Returns:

Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.

mpdProfile

public final DashIsoMpdProfile mpdProfile()

Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

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

Returns:

Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

See Also:

DashIsoMpdProfile

mpdProfileAsString

public final String mpdProfileAsString()

Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

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

Returns:

Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).

See Also:

DashIsoMpdProfile

ptsOffsetHandlingForBFrames

public final DashIsoPtsOffsetHandlingForBFrames ptsOffsetHandlingForBFrames()

Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

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

Returns:

Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

See Also:

DashIsoPtsOffsetHandlingForBFrames

ptsOffsetHandlingForBFramesAsString

public final String ptsOffsetHandlingForBFramesAsString()

Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

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

Returns:

Use this setting only when your output video stream has B-frames, which causes the initial presentation time stamp (PTS) to be offset from the initial decode time stamp (DTS). Specify how MediaConvert handles PTS when writing time stamps in output DASH manifests. Choose Match initial PTS (MATCH_INITIAL_PTS) when you want MediaConvert to use the initial PTS as the first time stamp in the manifest. Choose Zero-based (ZERO_BASED) to have MediaConvert ignore the initial PTS in the video stream and instead write the initial time stamp as zero in the manifest. For outputs that don't have B-frames, the time stamps in your DASH manifests start at zero regardless of your choice here.

See Also:

DashIsoPtsOffsetHandlingForBFrames

segmentControl

public final DashIsoSegmentControl segmentControl()

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

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

Returns:

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

See Also:

DashIsoSegmentControl

segmentControlAsString

public final String segmentControlAsString()

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

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

Returns:

When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.

See Also:

DashIsoSegmentControl

segmentLength

public final Integer segmentLength()

Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

Returns:

Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.

writeSegmentTimelineInRepresentation

public final DashIsoWriteSegmentTimelineInRepresentation writeSegmentTimelineInRepresentation()

If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest.

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

Returns:

If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest.

See Also:

DashIsoWriteSegmentTimelineInRepresentation

writeSegmentTimelineInRepresentationAsString

public final String writeSegmentTimelineInRepresentationAsString()

If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest.

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

Returns:

If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest.

See Also:

DashIsoWriteSegmentTimelineInRepresentation

toBuilder

public DashIsoGroupSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DashIsoGroupSettings.Builder,DashIsoGroupSettings>

builder

public static DashIsoGroupSettings.Builder builder()

serializableBuilderClass

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