com.amazonaws.services.transcribe.model

Class Subtitles

java.lang.Object

com.amazonaws.services.transcribe.model.Subtitles

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Subtitles
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Subtitles()

Method Summary

Modifier and Type	Method and Description
Subtitles	clone()
boolean	equals(Object obj)
List<String>	getFormats() Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip ( srt) formats, two output files are generated.
Integer	getOutputStartIndex() Specify the starting value that is assigned to the first subtitle segment.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setFormats(Collection<String> formats) Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip ( srt) formats, two output files are generated.
void	setOutputStartIndex(Integer outputStartIndex) Specify the starting value that is assigned to the first subtitle segment.
String	toString() Returns a string representation of this object.
Subtitles	withFormats(Collection<String> formats) Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip ( srt) formats, two output files are generated.
Subtitles	withFormats(String... formats) Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip ( srt) formats, two output files are generated.
Subtitles	withFormats(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.
Subtitles	withOutputStartIndex(Integer outputStartIndex) Specify the starting value that is assigned to the first subtitle segment.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Subtitles

public Subtitles()

Method Detail

getFormats

public List<String> getFormats()

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

Returns:

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

See Also:

SubtitleFormat

setFormats

public void setFormats(Collection<String> formats)

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

Parameters:

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

See Also:

SubtitleFormat

withFormats

public Subtitles withFormats(String... formats)

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

NOTE: This method appends the values to the existing list (if any). Use setFormats(java.util.Collection) or withFormats(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

See Also:

SubtitleFormat

withFormats

public Subtitles withFormats(Collection<String> formats)

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

Parameters:

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

Returns:

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

See Also:

SubtitleFormat

withFormats

public Subtitles withFormats(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.

Parameters:

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

Returns:

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

See Also:

SubtitleFormat

setOutputStartIndex

public void setOutputStartIndex(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.

Parameters:

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.

getOutputStartIndex

public Integer getOutputStartIndex()

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.

withOutputStartIndex

public Subtitles withOutputStartIndex(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.

Parameters:

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:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Subtitles clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.