CaptionDescription (AWS SDK for Java

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
```
Output groups for this Live Event. Output groups contain information about where streams should be distributed.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CaptionDescription()

Constructors
Constructor and Description
`CaptionDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CaptionDescription`	`clone()`
`boolean`	`equals(Object obj)`
`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`	`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`	`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`	`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; useful for testing and debugging.
`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`	`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
  - 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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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.

Did this page help you?

Class CaptionDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CaptionDescription

Method Detail

setCaptionSelectorName

getCaptionSelectorName

withCaptionSelectorName

setDestinationSettings

getDestinationSettings

withDestinationSettings

setLanguageCode

getLanguageCode

withLanguageCode

setLanguageDescription

getLanguageDescription

withLanguageDescription

setName

getName

withName

toString

equals

hashCode

clone

marshall