Package software.amazon.awssdk.services.elastictranscoder.model

Class CaptionFormat

java.lang.Object

software.amazon.awssdk.services.elastictranscoder.model.CaptionFormat

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CaptionFormat.Builder,CaptionFormat>

@Generated("software.amazon.awssdk:codegen")
public final class CaptionFormat
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CaptionFormat.Builder,CaptionFormat>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CaptionFormat.Builder

Method Summary

Modifier and Type	Method	Description
static CaptionFormat.Builder	builder()
Encryption	encryption()	The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	format()	The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	pattern()	The prefix for caption filenames, in the form description-{language}, where:
List<SdkField<?>>	sdkFields()
static Class<? extends CaptionFormat.Builder>	serializableBuilderClass()
CaptionFormat.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

format

public final String format()

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

• Valid Embedded Caption Formats:

  • for FLAC: None

  • 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. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

  • For FMP4: dfxp

  • Non-FMP4 outputs: All sidecar types

  fmp4 captions have an extension of .ismt

Returns:

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

• Valid Embedded Caption Formats:

  • for FLAC: None

  • 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. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

  • For FMP4: dfxp

  • Non-FMP4 outputs: All sidecar types

  fmp4 captions have an extension of .ismt

pattern

public final 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 is be Sydney-en-sunrise00000.srt.

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 is be Sydney-en-sunrise00000.srt.

encryption

public final Encryption encryption()

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

Returns:

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

toBuilder

public CaptionFormat.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CaptionFormat.Builder,CaptionFormat>

builder

public static CaptionFormat.Builder builder()

serializableBuilderClass

public static Class<? extends CaptionFormat.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo