com.amazonaws.services.medialive.model

Class CaptionDescription

java.lang.Object

com.amazonaws.services.medialive.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

Caption Description

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	getAccessibility() Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.
List<String>	getCaptionDashRoles() Identifies the DASH roles to assign to this captions output.
String	getCaptionSelectorName() Specifies which input caption selector to use as a caption source when generating output captions.
CaptionDestinationSettings	getDestinationSettings() Additional settings for captions destination that depend on the destination type.
String	getDvbDashAccessibility() Identifies DVB DASH accessibility signaling in this captions output.
String	getLanguageCode() ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
String	getLanguageDescription() Human readable information to indicate captions available for players (eg.
String	getName() Name of the caption description.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAccessibility(String accessibility) Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.
void	setCaptionDashRoles(Collection<String> captionDashRoles) Identifies the DASH roles to assign to this captions output.
void	setCaptionSelectorName(String captionSelectorName) Specifies which input caption selector to use as a caption source when generating output captions.
void	setDestinationSettings(CaptionDestinationSettings destinationSettings) Additional settings for captions destination that depend on the destination type.
void	setDvbDashAccessibility(String dvbDashAccessibility) Identifies DVB DASH accessibility signaling in this captions output.
void	setLanguageCode(String languageCode) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
void	setLanguageDescription(String languageDescription) Human readable information to indicate captions available for players (eg.
void	setName(String name) Name of the caption description.
String	toString() Returns a string representation of this object.
CaptionDescription	withAccessibility(AccessibilityType accessibility) Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.
CaptionDescription	withAccessibility(String accessibility) Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.
CaptionDescription	withCaptionDashRoles(Collection<String> captionDashRoles) Identifies the DASH roles to assign to this captions output.
CaptionDescription	withCaptionDashRoles(DashRoleCaption... captionDashRoles) Identifies the DASH roles to assign to this captions output.
CaptionDescription	withCaptionDashRoles(String... captionDashRoles) Identifies the DASH roles to assign to this captions output.
CaptionDescription	withCaptionSelectorName(String captionSelectorName) Specifies which input caption selector to use as a caption source when generating output captions.
CaptionDescription	withDestinationSettings(CaptionDestinationSettings destinationSettings) Additional settings for captions destination that depend on the destination type.
CaptionDescription	withDvbDashAccessibility(DvbDashAccessibility dvbDashAccessibility) Identifies DVB DASH accessibility signaling in this captions output.
CaptionDescription	withDvbDashAccessibility(String dvbDashAccessibility) Identifies DVB DASH accessibility signaling in this captions output.
CaptionDescription	withLanguageCode(String languageCode) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
CaptionDescription	withLanguageDescription(String languageDescription) Human readable information to indicate captions available for players (eg.
CaptionDescription	withName(String name) Name of the caption description.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CaptionDescription

public CaptionDescription()

Method Detail

setAccessibility

public void setAccessibility(String accessibility)

Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

Parameters:

accessibility - Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

See Also:

AccessibilityType

getAccessibility

public String getAccessibility()

Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

Returns:

Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

See Also:

AccessibilityType

withAccessibility

public CaptionDescription withAccessibility(String accessibility)

Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

Parameters:

accessibility - Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

Returns:

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

See Also:

AccessibilityType

withAccessibility

public CaptionDescription withAccessibility(AccessibilityType accessibility)

Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

Parameters:

accessibility - Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

Returns:

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

See Also:

AccessibilityType

setCaptionSelectorName

public void setCaptionSelectorName(String captionSelectorName)

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

Parameters:

captionSelectorName - Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

getCaptionSelectorName

public String getCaptionSelectorName()

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

Returns:

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

withCaptionSelectorName

public CaptionDescription withCaptionSelectorName(String captionSelectorName)

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

Parameters:

captionSelectorName - Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

Returns:

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

setDestinationSettings

public void setDestinationSettings(CaptionDestinationSettings destinationSettings)

Additional settings for captions destination that depend on the destination type.

Parameters:

destinationSettings - Additional settings for captions destination that depend on the destination type.

getDestinationSettings

public CaptionDestinationSettings getDestinationSettings()

Additional settings for captions destination that depend on the destination type.

Returns:

Additional settings for captions destination that depend on the destination type.

withDestinationSettings

public CaptionDescription withDestinationSettings(CaptionDestinationSettings destinationSettings)

Additional settings for captions destination that depend on the destination type.

Parameters:

destinationSettings - Additional settings for captions destination that depend on the destination type.

Returns:

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

setLanguageCode

public void setLanguageCode(String languageCode)

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

Parameters:

languageCode - ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

getLanguageCode

public String getLanguageCode()

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

Returns:

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

withLanguageCode

public CaptionDescription withLanguageCode(String languageCode)

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

Parameters:

languageCode - ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

Returns:

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

setLanguageDescription

public void setLanguageDescription(String languageDescription)

Human readable information to indicate captions available for players (eg. English, or Spanish).

Parameters:

languageDescription - Human readable information to indicate captions available for players (eg. English, or Spanish).

getLanguageDescription

public String getLanguageDescription()

Human readable information to indicate captions available for players (eg. English, or Spanish).

Returns:

Human readable information to indicate captions available for players (eg. English, or Spanish).

withLanguageDescription

public CaptionDescription withLanguageDescription(String languageDescription)

Human readable information to indicate captions available for players (eg. English, or Spanish).

Parameters:

languageDescription - Human readable information to indicate captions available for players (eg. English, or Spanish).

Returns:

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

setName

public void setName(String name)

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

Parameters:

name - Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

getName

public String getName()

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

Returns:

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

withName

public CaptionDescription withName(String name)

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

Parameters:

name - Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

Returns:

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

getCaptionDashRoles

public List<String> getCaptionDashRoles()

Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

Returns:

Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

See Also:

DashRoleCaption

setCaptionDashRoles

public void setCaptionDashRoles(Collection<String> captionDashRoles)

Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

Parameters:

captionDashRoles - Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

See Also:

DashRoleCaption

withCaptionDashRoles

public CaptionDescription withCaptionDashRoles(String... captionDashRoles)

Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

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

Parameters:

captionDashRoles - Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

Returns:

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

See Also:

DashRoleCaption

withCaptionDashRoles

public CaptionDescription withCaptionDashRoles(Collection<String> captionDashRoles)

Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

Parameters:

captionDashRoles - Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

Returns:

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

See Also:

DashRoleCaption

withCaptionDashRoles

public CaptionDescription withCaptionDashRoles(DashRoleCaption... captionDashRoles)

Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

Parameters:

captionDashRoles - Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

Returns:

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

See Also:

DashRoleCaption

setDvbDashAccessibility

public void setDvbDashAccessibility(String dvbDashAccessibility)

Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

Parameters:

dvbDashAccessibility - Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

See Also:

DvbDashAccessibility

getDvbDashAccessibility

public String getDvbDashAccessibility()

Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

Returns:

Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

See Also:

DvbDashAccessibility

withDvbDashAccessibility

public CaptionDescription withDvbDashAccessibility(String dvbDashAccessibility)

Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

Parameters:

dvbDashAccessibility - Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

Returns:

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

See Also:

DvbDashAccessibility

withDvbDashAccessibility

public CaptionDescription withDvbDashAccessibility(DvbDashAccessibility dvbDashAccessibility)

Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

Parameters:

dvbDashAccessibility - Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

Returns:

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

See Also:

DvbDashAccessibility

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)

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.