Class Subtitles
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Subtitles.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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.Specify the output format for your subtitle file; if you select both WebVTT (vtt
) and SubRip (srt
) formats, two output files are generated.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Formats property.final int
hashCode()
final Integer
Specify the starting value that is assigned to the first subtitle segment.static Class
<? extends Subtitles.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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 of1
. If you're uncertain which value to use, we recommend choosing1
, 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 of1
. If you're uncertain which value to use, we recommend choosing1
, as this may improve compatibility with other services.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Subtitles.Builder,
Subtitles> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-