Package software.amazon.awssdk.services.transcribe.model

Class Subtitles

java.lang.Object

software.amazon.awssdk.services.transcribe.model.Subtitles

All Implemented Interfaces:

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

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

Generate subtitles for your media file with your transcription request.

You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or both) as your output format.

Note that your subtitle files are placed in the same location as your transcription output.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Subtitles.Builder

Method Summary

Modifier and Type	Method	Description
static Subtitles.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<SubtitleFormat>	formats()	Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip ( srt) formats, two output files are generated.
List<String>	formatsAsStrings()	Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip ( srt) formats, two output files are generated.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFormats()	For responses, this returns true if the service returned a value for the Formats property.
int	hashCode()
Integer	outputStartIndex()	Specify the starting value that is assigned to the first subtitle segment.
List<SdkField<?>>	sdkFields()
static Class<? extends Subtitles.Builder>	serializableBuilderClass()
Subtitles.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

formats

public final List<SubtitleFormat> formats()

Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip ( srt) formats, two output files are generated.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFormats() method.

Returns:

Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip (srt) formats, two output files are generated.

hasFormats

public final boolean hasFormats()

For responses, this returns true if the service returned a value for the Formats property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

formatsAsStrings

public final List<String> formatsAsStrings()

Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip ( srt) formats, two output files are generated.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFormats() method.

Returns:

Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip (srt) formats, two output files are generated.

outputStartIndex

public final Integer outputStartIndex()

Specify the starting value that is assigned to the first subtitle segment.

The default start index for Amazon Transcribe is 0, which differs from the more widely used standard of 1. If you're uncertain which value to use, we recommend choosing 1, as this may improve compatibility with other services.

Returns:

Specify the starting value that is assigned to the first subtitle segment.

The default start index for Amazon Transcribe is 0, which differs from the more widely used standard of 1. If you're uncertain which value to use, we recommend choosing 1, as this may improve compatibility with other services.

toBuilder

public Subtitles.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Subtitles.Builder,Subtitles>

builder

public static Subtitles.Builder builder()

serializableBuilderClass

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