com.amazonaws.services.mediaconvert.model

Class Output

java.lang.Object

com.amazonaws.services.mediaconvert.model.Output

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Output
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Output()

Method Summary

Modifier and Type	Method and Description
Output	clone()
boolean	equals(Object obj)
List<AudioDescription>	getAudioDescriptions() Contains groups of audio encoding settings organized by audio codec.
List<CaptionDescription>	getCaptionDescriptions() Contains groups of captions settings.
ContainerSettings	getContainerSettings() Container specific settings.
String	getExtension() Use Extension to specify the file extension for outputs in File output groups.
String	getNameModifier() Use Name modifier to have the service add a string to the end of each output filename.
OutputSettings	getOutputSettings() Specific settings for this type of output.
String	getPreset() Use Preset to specify a preset for your transcoding settings.
VideoDescription	getVideoDescription() VideoDescription contains a group of video encoding settings.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAudioDescriptions(Collection<AudioDescription> audioDescriptions) Contains groups of audio encoding settings organized by audio codec.
void	setCaptionDescriptions(Collection<CaptionDescription> captionDescriptions) Contains groups of captions settings.
void	setContainerSettings(ContainerSettings containerSettings) Container specific settings.
void	setExtension(String extension) Use Extension to specify the file extension for outputs in File output groups.
void	setNameModifier(String nameModifier) Use Name modifier to have the service add a string to the end of each output filename.
void	setOutputSettings(OutputSettings outputSettings) Specific settings for this type of output.
void	setPreset(String preset) Use Preset to specify a preset for your transcoding settings.
void	setVideoDescription(VideoDescription videoDescription) VideoDescription contains a group of video encoding settings.
String	toString() Returns a string representation of this object.
Output	withAudioDescriptions(AudioDescription... audioDescriptions) Contains groups of audio encoding settings organized by audio codec.
Output	withAudioDescriptions(Collection<AudioDescription> audioDescriptions) Contains groups of audio encoding settings organized by audio codec.
Output	withCaptionDescriptions(CaptionDescription... captionDescriptions) Contains groups of captions settings.
Output	withCaptionDescriptions(Collection<CaptionDescription> captionDescriptions) Contains groups of captions settings.
Output	withContainerSettings(ContainerSettings containerSettings) Container specific settings.
Output	withExtension(String extension) Use Extension to specify the file extension for outputs in File output groups.
Output	withNameModifier(String nameModifier) Use Name modifier to have the service add a string to the end of each output filename.
Output	withOutputSettings(OutputSettings outputSettings) Specific settings for this type of output.
Output	withPreset(String preset) Use Preset to specify a preset for your transcoding settings.
Output	withVideoDescription(VideoDescription videoDescription) VideoDescription contains a group of video encoding settings.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Output

public Output()

Method Detail

getAudioDescriptions

public List<AudioDescription> getAudioDescriptions()

Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can contain multiple groups of encoding settings.

Returns:

Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can contain multiple groups of encoding settings.

setAudioDescriptions

public void setAudioDescriptions(Collection<AudioDescription> audioDescriptions)

Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can contain multiple groups of encoding settings.

Parameters:

audioDescriptions - Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can contain multiple groups of encoding settings.

withAudioDescriptions

public Output withAudioDescriptions(AudioDescription... audioDescriptions)

Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can contain multiple groups of encoding settings.

NOTE: This method appends the values to the existing list (if any). Use setAudioDescriptions(java.util.Collection) or withAudioDescriptions(java.util.Collection) if you want to override the existing values.

Parameters:

audioDescriptions - Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can contain multiple groups of encoding settings.

Returns:

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

withAudioDescriptions

public Output withAudioDescriptions(Collection<AudioDescription> audioDescriptions)

Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can contain multiple groups of encoding settings.

Parameters:

audioDescriptions - Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can contain multiple groups of encoding settings.

Returns:

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

getCaptionDescriptions

public List<CaptionDescription> getCaptionDescriptions()

Contains groups of captions settings. For each output that has captions, include one instance of CaptionDescriptions. Can contain multiple groups of captions settings.

Returns:

Contains groups of captions settings. For each output that has captions, include one instance of CaptionDescriptions. Can contain multiple groups of captions settings.

setCaptionDescriptions

public void setCaptionDescriptions(Collection<CaptionDescription> captionDescriptions)

Contains groups of captions settings. For each output that has captions, include one instance of CaptionDescriptions. Can contain multiple groups of captions settings.

Parameters:

captionDescriptions - Contains groups of captions settings. For each output that has captions, include one instance of CaptionDescriptions. Can contain multiple groups of captions settings.

withCaptionDescriptions

public Output withCaptionDescriptions(CaptionDescription... captionDescriptions)

Contains groups of captions settings. For each output that has captions, include one instance of CaptionDescriptions. Can contain multiple groups of captions settings.

NOTE: This method appends the values to the existing list (if any). Use setCaptionDescriptions(java.util.Collection) or withCaptionDescriptions(java.util.Collection) if you want to override the existing values.

Parameters:

captionDescriptions - Contains groups of captions settings. For each output that has captions, include one instance of CaptionDescriptions. Can contain multiple groups of captions settings.

Returns:

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

withCaptionDescriptions

public Output withCaptionDescriptions(Collection<CaptionDescription> captionDescriptions)

Contains groups of captions settings. For each output that has captions, include one instance of CaptionDescriptions. Can contain multiple groups of captions settings.

Parameters:

captionDescriptions - Contains groups of captions settings. For each output that has captions, include one instance of CaptionDescriptions. Can contain multiple groups of captions settings.

Returns:

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

setContainerSettings

public void setContainerSettings(ContainerSettings containerSettings)

Container specific settings.

Parameters:

containerSettings - Container specific settings.

getContainerSettings

public ContainerSettings getContainerSettings()

Container specific settings.

Returns:

Container specific settings.

withContainerSettings

public Output withContainerSettings(ContainerSettings containerSettings)

Container specific settings.

Parameters:

containerSettings - Container specific settings.

Returns:

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

setExtension

public void setExtension(String extension)

Use 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)

Parameters:

extension - Use 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)

getExtension

public String getExtension()

Use 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 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)

withExtension

public Output withExtension(String extension)

Use 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)

Parameters:

extension - Use 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:

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

setNameModifier

public void setNameModifier(String nameModifier)

Use Name modifier 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 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.

Parameters:

nameModifier - Use Name modifier 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 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.

getNameModifier

public String getNameModifier()

Use Name modifier 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 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 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 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.

withNameModifier

public Output withNameModifier(String nameModifier)

Use Name modifier 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 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.

Parameters:

nameModifier - Use Name modifier 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 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:

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

setOutputSettings

public void setOutputSettings(OutputSettings outputSettings)

Specific settings for this type of output.

Parameters:

outputSettings - Specific settings for this type of output.

getOutputSettings

public OutputSettings getOutputSettings()

Specific settings for this type of output.

Returns:

Specific settings for this type of output.

withOutputSettings

public Output withOutputSettings(OutputSettings outputSettings)

Specific settings for this type of output.

Parameters:

outputSettings - Specific settings for this type of output.

Returns:

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

setPreset

public void setPreset(String preset)

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

Parameters:

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

getPreset

public String getPreset()

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

Returns:

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

withPreset

public Output withPreset(String preset)

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

Parameters:

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

Returns:

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

setVideoDescription

public void setVideoDescription(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.

Parameters:

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.

getVideoDescription

public VideoDescription getVideoDescription()

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.

withVideoDescription

public Output withVideoDescription(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.

Parameters:

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:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Output clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.