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

Class CaptionSource

java.lang.Object

software.amazon.awssdk.services.elastictranscoder.model.CaptionSource

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CaptionSource.Builder

Method Summary

Modifier and Type	Method	Description
static CaptionSource.Builder	builder()
Encryption	encryption()	The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
String	label()	The label of the caption shown in the player when choosing a language.
String	language()	A string that specifies the language of the caption.
List<SdkField<?>>	sdkFields()
static Class<? extends CaptionSource.Builder>	serializableBuilderClass()
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.
CaptionSource.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

key

public final String key()

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

Returns:

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

language

public final String language()

A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. 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 string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. 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.

timeOffset

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

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.

label

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

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.

encryption

public final Encryption encryption()

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

Returns:

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

toBuilder

public CaptionSource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CaptionSource.Builder,CaptionSource>

builder

public static CaptionSource.Builder builder()

serializableBuilderClass

public static Class<? extends CaptionSource.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