Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElasticTranscoder.Types.CaptionFormat

Description

Synopsis

Documentation

data CaptionFormat Source #

The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.

See: newCaptionFormat smart constructor.

Constructors

CaptionFormat'

Fields

encryption :: Maybe Encryption
The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
format :: Maybe Text
The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.
- Valid Embedded Caption Formats:
  - for FLAC: None
  - For MP3: None
  - For MP4: mov-text
  - For MPEG-TS: None
  - For ogg: None
  - For webm: None
- Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
  - For FMP4: dfxp
  - Non-FMP4 outputs: All sidecar types
  fmp4 captions have an extension of .ismt
pattern' :: Maybe Text
The prefix for caption filenames, in the form description-{language}, where:
- description is a description of the video.
- {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.
If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.
For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt.

Instances

Instances details

FromJSON CaptionFormat Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.CaptionFormat Methods parseJSON :: Value -> Parser CaptionFormat # parseJSONList :: Value -> Parser [CaptionFormat] #
ToJSON CaptionFormat Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.CaptionFormat Methods toJSON :: CaptionFormat -> Value # toEncoding :: CaptionFormat -> Encoding # toJSONList :: [CaptionFormat] -> Value # toEncodingList :: [CaptionFormat] -> Encoding #
Generic CaptionFormat Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.CaptionFormat Associated Types type Rep CaptionFormat :: Type -> Type # Methods from :: CaptionFormat -> Rep CaptionFormat x # to :: Rep CaptionFormat x -> CaptionFormat #
Read CaptionFormat Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.CaptionFormat Methods readsPrec :: Int -> ReadS CaptionFormat # readList :: ReadS [CaptionFormat] # readPrec :: ReadPrec CaptionFormat # readListPrec :: ReadPrec [CaptionFormat] #
Show CaptionFormat Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.CaptionFormat Methods showsPrec :: Int -> CaptionFormat -> ShowS # show :: CaptionFormat -> String # showList :: [CaptionFormat] -> ShowS #
NFData CaptionFormat Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.CaptionFormat Methods rnf :: CaptionFormat -> () #
Eq CaptionFormat Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.CaptionFormat Methods (==) :: CaptionFormat -> CaptionFormat -> Bool # (/=) :: CaptionFormat -> CaptionFormat -> Bool #
Hashable CaptionFormat Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.CaptionFormat Methods hashWithSalt :: Int -> CaptionFormat -> Int # hash :: CaptionFormat -> Int #
type Rep CaptionFormat Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.CaptionFormat type Rep CaptionFormat = D1 ('MetaData "CaptionFormat" "Amazonka.ElasticTranscoder.Types.CaptionFormat" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "CaptionFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Encryption)) :: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pattern'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCaptionFormat :: CaptionFormat Source #

Create a value of CaptionFormat 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:encryption:CaptionFormat', captionFormat_encryption - The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

$sel:format:CaptionFormat', captionFormat_format - The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

Valid Embedded Caption Formats:
- for FLAC: None
- For MP3: None
- For MP4: mov-text
- For MPEG-TS: None
- For ogg: None
- For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
- For FMP4: dfxp
- Non-FMP4 outputs: All sidecar types
fmp4 captions have an extension of .ismt

$sel:pattern':CaptionFormat', captionFormat_pattern - The prefix for caption filenames, in the form description-{language}, where:

description is a description of the video.
{language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt.

captionFormat_encryption :: Lens' CaptionFormat (Maybe Encryption) Source #

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

captionFormat_format :: Lens' CaptionFormat (Maybe Text) Source #

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

Valid Embedded Caption Formats:
- for FLAC: None
- For MP3: None
- For MP4: mov-text
- For MPEG-TS: None
- For ogg: None
- For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
- For FMP4: dfxp
- Non-FMP4 outputs: All sidecar types
fmp4 captions have an extension of .ismt

captionFormat_pattern :: Lens' CaptionFormat (Maybe Text) Source #

The prefix for caption filenames, in the form description-{language}, where:

description is a description of the video.
{language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "{language}" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt.