com.amazonaws.services.elastictranscoder.model

Class CaptionFormat

java.lang.Object

com.amazonaws.services.elastictranscoder.model.CaptionFormat

All Implemented Interfaces:

Serializable

public class CaptionFormat
extends Object
implements Serializable

The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CaptionFormat()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getFormat() The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.
String	getPattern() The prefix for caption filenames, in the form description-{language}, where: description is a description of the video. {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.
int	hashCode()
void	setFormat(String format) The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.
void	setPattern(String pattern) The prefix for caption filenames, in the form description-{language}, where: description is a description of the video. {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CaptionFormat	withFormat(String format) The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.
CaptionFormat	withPattern(String pattern) The prefix for caption filenames, in the form description-{language}, where: description is a description of the video. {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptionFormat

public CaptionFormat()

Method Detail

getFormat

public String getFormat()

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

• Valid Embedded Caption Formats:

  • For MP3: None

  • For MP4: mov-text

  • For MPEG-TS: None

  • For ogg: None

  • For webm: None

• Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Constraints:
Pattern: (^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)

Returns:

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

• Valid Embedded Caption Formats:

  • For MP3: None

  • For MP4: mov-text

  • For MPEG-TS: None

  • For ogg: None

  • For webm: None

• Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

setFormat

public void setFormat(String format)

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

• Valid Embedded Caption Formats:

  • For MP3: None

  • For MP4: mov-text

  • For MPEG-TS: None

  • For ogg: None

  • For webm: None

• Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Constraints:
Pattern: (^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)

Parameters:

format - The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

• Valid Embedded Caption Formats:

  • For MP3: None

  • For MP4: mov-text

  • For MPEG-TS: None

  • For ogg: None

  • For webm: None

• Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

withFormat

public CaptionFormat withFormat(String format)

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

• Valid Embedded Caption Formats:

  • For MP3: None

  • For MP4: mov-text

  • For MPEG-TS: None

  • For ogg: None

  • For webm: None

• Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

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

Constraints:
Pattern: (^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)

Parameters:

format - The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

• Valid Embedded Caption Formats:

  • For MP3: None

  • For MP4: mov-text

  • For MPEG-TS: None

  • For ogg: None

  • For webm: None

• Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. There are no container restrictions on sidecar captions. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Returns:

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

getPattern

public String getPattern()

The prefix for caption filenames, in the form description-{language}, where:

• description is a description of the video.
• {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.

Constraints:
Pattern: (^$)|(^.*\{language\}.*$)

Returns:

The prefix for caption filenames, in the form description-{language}, where:

• description is a description of the video.
• {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.

setPattern

public void setPattern(String pattern)

The prefix for caption filenames, in the form description-{language}, where:

• description is a description of the video.
• {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.

Constraints:
Pattern: (^$)|(^.*\{language\}.*$)

Parameters:

pattern - The prefix for caption filenames, in the form description-{language}, where:

• description is a description of the video.
• {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.

withPattern

public CaptionFormat withPattern(String pattern)

The prefix for caption filenames, in the form description-{language}, where:

• description is a description of the video.
• {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.

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

Constraints:
Pattern: (^$)|(^.*\{language\}.*$)

Parameters:

pattern - The prefix for caption filenames, in the form description-{language}, where:

• description is a description of the video.
• {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.

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