com.amazonaws.services.elastictranscoder.model

Class CaptionSource

java.lang.Object

com.amazonaws.services.elastictranscoder.model.CaptionSource

All Implemented Interfaces:

Serializable

public class CaptionSource
extends Object
implements Serializable

A source file for the input sidecar captions used during the transcoding process.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CaptionSource()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getKey() The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
String	getLabel() The label of the caption shown in the player when choosing a language.
String	getLanguage() A string that specifies the language of the caption.
String	getTimeOffset() For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.
int	hashCode()
void	setKey(String key) The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
void	setLabel(String label) The label of the caption shown in the player when choosing a language.
void	setLanguage(String language) A string that specifies the language of the caption.
void	setTimeOffset(String timeOffset) For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CaptionSource	withKey(String key) The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
CaptionSource	withLabel(String label) The label of the caption shown in the player when choosing a language.
CaptionSource	withLanguage(String language) A string that specifies the language of the caption.
CaptionSource	withTimeOffset(String timeOffset) For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptionSource

public CaptionSource()

Method Detail

getKey

public String getKey()

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

Constraints:
Length: 1 - 255

Returns:

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

setKey

public void setKey(String key)

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

Constraints:
Length: 1 - 255

Parameters:

key - The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

withKey

public CaptionSource withKey(String key)

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

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

Constraints:
Length: 1 - 255

Parameters:

key - The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

Returns:

A reference to this updated object so that method calls can be chained together.

getLanguage

public String getLanguage()

A string that specifies the language of the caption. Specify this as one of:

• 2-character ISO 639-1 code

• 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

Constraints:
Length: 1 - 255

Returns:

A string that specifies the language of the caption. Specify this as one of:

• 2-character ISO 639-1 code

• 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

setLanguage

public void setLanguage(String language)

A string that specifies the language of the caption. Specify this as one of:

• 2-character ISO 639-1 code

• 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

Constraints:
Length: 1 - 255

Parameters:

language - A string that specifies the language of the caption. Specify this as one of:

• 2-character ISO 639-1 code

• 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

withLanguage

public CaptionSource withLanguage(String language)

A string that specifies the language of the caption. Specify this as one of:

• 2-character ISO 639-1 code

• 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

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

Constraints:
Length: 1 - 255

Parameters:

language - A string that specifies the language of the caption. Specify this as one of:

• 2-character ISO 639-1 code

• 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

Returns:

A reference to this updated object so that method calls can be chained together.

getTimeOffset

public String getTimeOffset()

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

Constraints:
Pattern: (^[+-]?\d{1,5}(\.\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)

Returns:

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

setTimeOffset

public void setTimeOffset(String timeOffset)

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

Constraints:
Pattern: (^[+-]?\d{1,5}(\.\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)

Parameters:

timeOffset - For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

withTimeOffset

public CaptionSource withTimeOffset(String timeOffset)

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

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

Constraints:
Pattern: (^[+-]?\d{1,5}(\.\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)

Parameters:

timeOffset - For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

Returns:

A reference to this updated object so that method calls can be chained together.

getLabel

public String getLabel()

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

Constraints:
Length: 1 - 40

Returns:

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

setLabel

public void setLabel(String label)

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

Constraints:
Length: 1 - 40

Parameters:

label - The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

withLabel

public CaptionSource withLabel(String label)

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

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

Constraints:
Length: 1 - 40

Parameters:

label - The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object