software.amazon.awssdk.services.mediaconvert.model

Class Output

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.Output

All Implemented Interfaces:

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

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

Each output in your job is a collection of settings that describes how you want MediaConvert to encode a single output file or stream. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/create-outputs.html.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Output.Builder

Method Summary

Modifier and Type	Method and Description
List<AudioDescription>	audioDescriptions() (AudioDescriptions) contains groups of audio encoding settings organized by audio codec.
static Output.Builder	builder()
List<CaptionDescription>	captionDescriptions() (CaptionDescriptions) contains groups of captions settings.
ContainerSettings	containerSettings() Container specific settings.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	extension() Use Extension (Extension) to specify the file extension for outputs in File output groups.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAudioDescriptions() For responses, this returns true if the service returned a value for the AudioDescriptions property.
boolean	hasCaptionDescriptions() For responses, this returns true if the service returned a value for the CaptionDescriptions property.
int	hashCode()
String	nameModifier() Use Name modifier (NameModifier) to have the service add a string to the end of each output filename.
OutputSettings	outputSettings() Specific settings for this type of output.
String	preset() Use Preset (Preset) to specify a preset for your transcoding settings.
List<SdkField<?>>	sdkFields()
static Class<? extends Output.Builder>	serializableBuilderClass()
Output.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VideoDescription	videoDescription() VideoDescription contains a group of video encoding settings.

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

hasAudioDescriptions

public final boolean hasAudioDescriptions()

For responses, this returns true if the service returned a value for the AudioDescriptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

audioDescriptions

public final List<AudioDescription> audioDescriptions()

(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAudioDescriptions() method.

Returns:

(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.

hasCaptionDescriptions

public final boolean hasCaptionDescriptions()

For responses, this returns true if the service returned a value for the CaptionDescriptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

captionDescriptions

public final List<CaptionDescription> captionDescriptions()

(CaptionDescriptions) contains groups of captions settings. For each output that has captions, include one instance of (CaptionDescriptions). (CaptionDescriptions) can contain multiple groups of captions settings.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCaptionDescriptions() method.

Returns:

(CaptionDescriptions) contains groups of captions settings. For each output that has captions, include one instance of (CaptionDescriptions). (CaptionDescriptions) can contain multiple groups of captions settings.

containerSettings

public final ContainerSettings containerSettings()

Container specific settings.

Returns:

Container specific settings.

extension

public final String extension()

Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)

Returns:

Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)

nameModifier

public final String nameModifier()

Use Name modifier (NameModifier) to have the service add a string to the end of each output filename. You specify the base filename as part of your destination URI. When you create multiple outputs in the same output group, Name modifier (NameModifier) is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output group.

Returns:

Use Name modifier (NameModifier) to have the service add a string to the end of each output filename. You specify the base filename as part of your destination URI. When you create multiple outputs in the same output group, Name modifier (NameModifier) is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output group.

outputSettings

public final OutputSettings outputSettings()

Specific settings for this type of output.

Returns:

Specific settings for this type of output.

preset

public final String preset()

Use Preset (Preset) to specify a preset for your transcoding settings. Provide the system or custom preset name. You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both.

Returns:

Use Preset (Preset) to specify a preset for your transcoding settings. Provide the system or custom preset name. You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both.

videoDescription

public final VideoDescription videoDescription()

VideoDescription contains a group of video encoding settings. The specific video settings depend on the video codec that you choose for the property codec. Include one instance of VideoDescription per output.

Returns:

VideoDescription contains a group of video encoding settings. The specific video settings depend on the video codec that you choose for the property codec. Include one instance of VideoDescription per output.

toBuilder

public Output.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Output.Builder,Output>

builder

public static Output.Builder builder()

serializableBuilderClass

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