Amazonka.Transcribe.Types.Subtitles

Documentation

data 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: newSubtitles smart constructor.

Constructors

Subtitles'

Fields

• formats :: Maybe [SubtitleFormat]

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

• outputStartIndex :: Maybe Natural

  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.

Instances

ToJSON Subtitles

Defined in Amazonka.Transcribe.Types.Subtitles

Methods

toJSON :: Subtitles -> Value

toEncoding :: Subtitles -> Encoding

toJSONList :: [Subtitles] -> Value

toEncodingList :: [Subtitles] -> Encoding

Generic Subtitles

Defined in Amazonka.Transcribe.Types.Subtitles

Associated Types

type Rep Subtitles :: Type -> Type

Methods

from :: Subtitles -> Rep Subtitles x

to :: Rep Subtitles x -> Subtitles

Read Subtitles

Defined in Amazonka.Transcribe.Types.Subtitles

Methods

readsPrec :: Int -> ReadS Subtitles

readList :: ReadS [Subtitles]

readPrec :: ReadPrec Subtitles

readListPrec :: ReadPrec [Subtitles]

Show Subtitles

Defined in Amazonka.Transcribe.Types.Subtitles

Methods

showsPrec :: Int -> Subtitles -> ShowS

show :: Subtitles -> String

showList :: [Subtitles] -> ShowS

NFData Subtitles

Defined in Amazonka.Transcribe.Types.Subtitles

Methods

rnf :: Subtitles -> ()

Eq Subtitles

Defined in Amazonka.Transcribe.Types.Subtitles

Methods

(==) :: Subtitles -> Subtitles -> Bool

(/=) :: Subtitles -> Subtitles -> Bool

Hashable Subtitles

Defined in Amazonka.Transcribe.Types.Subtitles

Methods

hashWithSalt :: Int -> Subtitles -> Int

hash :: Subtitles -> Int

type Rep Subtitles

Defined in Amazonka.Transcribe.Types.Subtitles

type Rep Subtitles = D1 ('MetaData "Subtitles" "Amazonka.Transcribe.Types.Subtitles" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "Subtitles'" 'PrefixI 'True) (S1 ('MetaSel ('Just "formats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubtitleFormat])) :*: S1 ('MetaSel ('Just "outputStartIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newSubtitles :: Subtitles

Create a value of Subtitles with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:outputStartIndex:Subtitles', subtitles_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.

subtitles_formats :: Lens' Subtitles (Maybe [SubtitleFormat])

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

subtitles_outputStartIndex :: Lens' Subtitles (Maybe Natural)

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.