com.amazonaws.services.mediaconvert.model

Class CaptionDescription

java.lang.Object

com.amazonaws.services.mediaconvert.model.CaptionDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Description of Caption output

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CaptionDescription()

Method Summary

Modifier and Type	Method and Description
CaptionDescription	clone()
boolean	equals(Object obj)
String	getCaptionSelectorName() Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions.
String	getCustomLanguageCode() Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code.
CaptionDestinationSettings	getDestinationSettings() Specific settings required by destination type.
String	getLanguageCode() Specify the language of this captions output track.
String	getLanguageDescription() Specify a label for this set of output captions.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCaptionSelectorName(String captionSelectorName) Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions.
void	setCustomLanguageCode(String customLanguageCode) Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code.
void	setDestinationSettings(CaptionDestinationSettings destinationSettings) Specific settings required by destination type.
void	setLanguageCode(String languageCode) Specify the language of this captions output track.
void	setLanguageDescription(String languageDescription) Specify a label for this set of output captions.
String	toString() Returns a string representation of this object.
CaptionDescription	withCaptionSelectorName(String captionSelectorName) Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions.
CaptionDescription	withCustomLanguageCode(String customLanguageCode) Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code.
CaptionDescription	withDestinationSettings(CaptionDestinationSettings destinationSettings) Specific settings required by destination type.
CaptionDescription	withLanguageCode(LanguageCode languageCode) Specify the language of this captions output track.
CaptionDescription	withLanguageCode(String languageCode) Specify the language of this captions output track.
CaptionDescription	withLanguageDescription(String languageDescription) Specify a label for this set of output captions.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptionDescription

public CaptionDescription()

Method Detail

setCaptionSelectorName

public void setCaptionSelectorName(String captionSelectorName)

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input.

Parameters:

captionSelectorName - Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input.

getCaptionSelectorName

public String getCaptionSelectorName()

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input.

Returns:

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input.

withCaptionSelectorName

public CaptionDescription withCaptionSelectorName(String captionSelectorName)

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input.

Parameters:

captionSelectorName - Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used from each input.

Returns:

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

setCustomLanguageCode

public void setCustomLanguageCode(String customLanguageCode)

Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Parameters:

customLanguageCode - Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

getCustomLanguageCode

public String getCustomLanguageCode()

Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Returns:

Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

withCustomLanguageCode

public CaptionDescription withCustomLanguageCode(String customLanguageCode)

Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Parameters:

customLanguageCode - Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Returns:

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

setDestinationSettings

public void setDestinationSettings(CaptionDestinationSettings destinationSettings)

Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.

Parameters:

destinationSettings - Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.

getDestinationSettings

public CaptionDestinationSettings getDestinationSettings()

Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.

Returns:

Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.

withDestinationSettings

public CaptionDescription withDestinationSettings(CaptionDestinationSettings destinationSettings)

Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.

Parameters:

destinationSettings - Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.

Returns:

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

setLanguageCode

public void setLanguageCode(String languageCode)

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Parameters:

languageCode - Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Returns:

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

See Also:

LanguageCode

withLanguageCode

public CaptionDescription withLanguageCode(String languageCode)

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Parameters:

languageCode - Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Returns:

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

See Also:

LanguageCode

withLanguageCode

public CaptionDescription withLanguageCode(LanguageCode languageCode)

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Parameters:

languageCode - Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Returns:

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

See Also:

LanguageCode

setLanguageDescription

public void setLanguageDescription(String languageDescription)

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Parameters:

languageDescription - Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

getLanguageDescription

public String getLanguageDescription()

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Returns:

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

withLanguageDescription

public CaptionDescription withLanguageDescription(String languageDescription)

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Parameters:

languageDescription - Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

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 CaptionDescription clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo