Amazonka.MediaConvert.Types.CaptionDestinationSettings

Documentation

data CaptionDestinationSettings

Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

See: newCaptionDestinationSettings smart constructor.

Constructors

CaptionDestinationSettings'

Fields

• burninDestinationSettings :: Maybe BurninDestinationSettings

  Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.

• destinationType :: Maybe CaptionDestinationType

  Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

• dvbSubDestinationSettings :: Maybe DvbSubDestinationSettings

  Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.

• embeddedDestinationSettings :: Maybe EmbeddedDestinationSettings

  Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.

• imscDestinationSettings :: Maybe ImscDestinationSettings

  Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.

• sccDestinationSettings :: Maybe SccDestinationSettings

  Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.

• srtDestinationSettings :: Maybe SrtDestinationSettings

  Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT.

• teletextDestinationSettings :: Maybe TeletextDestinationSettings

  Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TELETEXT.

• ttmlDestinationSettings :: Maybe TtmlDestinationSettings

  Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.

• webvttDestinationSettings :: Maybe WebvttDestinationSettings

  Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT.

Instances

FromJSON CaptionDestinationSettings

Defined in Amazonka.MediaConvert.Types.CaptionDestinationSettings

Methods

parseJSON :: Value -> Parser CaptionDestinationSettings

parseJSONList :: Value -> Parser [CaptionDestinationSettings]

ToJSON CaptionDestinationSettings

Defined in Amazonka.MediaConvert.Types.CaptionDestinationSettings

Methods

toJSON :: CaptionDestinationSettings -> Value

toEncoding :: CaptionDestinationSettings -> Encoding

toJSONList :: [CaptionDestinationSettings] -> Value

toEncodingList :: [CaptionDestinationSettings] -> Encoding

Generic CaptionDestinationSettings

Defined in Amazonka.MediaConvert.Types.CaptionDestinationSettings

Associated Types

type Rep CaptionDestinationSettings :: Type -> Type

Methods

from :: CaptionDestinationSettings -> Rep CaptionDestinationSettings x

to :: Rep CaptionDestinationSettings x -> CaptionDestinationSettings

Read CaptionDestinationSettings

Defined in Amazonka.MediaConvert.Types.CaptionDestinationSettings

Methods

readsPrec :: Int -> ReadS CaptionDestinationSettings

readList :: ReadS [CaptionDestinationSettings]

readPrec :: ReadPrec CaptionDestinationSettings

readListPrec :: ReadPrec [CaptionDestinationSettings]

Show CaptionDestinationSettings

Defined in Amazonka.MediaConvert.Types.CaptionDestinationSettings

Methods

showsPrec :: Int -> CaptionDestinationSettings -> ShowS

show :: CaptionDestinationSettings -> String

showList :: [CaptionDestinationSettings] -> ShowS

NFData CaptionDestinationSettings

Defined in Amazonka.MediaConvert.Types.CaptionDestinationSettings

Methods

rnf :: CaptionDestinationSettings -> ()

Eq CaptionDestinationSettings

Defined in Amazonka.MediaConvert.Types.CaptionDestinationSettings

Methods

(==) :: CaptionDestinationSettings -> CaptionDestinationSettings -> Bool

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

Hashable CaptionDestinationSettings

Defined in Amazonka.MediaConvert.Types.CaptionDestinationSettings

Methods

hashWithSalt :: Int -> CaptionDestinationSettings -> Int

hash :: CaptionDestinationSettings -> Int

type Rep CaptionDestinationSettings

Defined in Amazonka.MediaConvert.Types.CaptionDestinationSettings

type Rep CaptionDestinationSettings = D1 ('MetaData "CaptionDestinationSettings" "Amazonka.MediaConvert.Types.CaptionDestinationSettings" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "CaptionDestinationSettings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "burninDestinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BurninDestinationSettings)) :*: S1 ('MetaSel ('Just "destinationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CaptionDestinationType))) :*: (S1 ('MetaSel ('Just "dvbSubDestinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DvbSubDestinationSettings)) :*: (S1 ('MetaSel ('Just "embeddedDestinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmbeddedDestinationSettings)) :*: S1 ('MetaSel ('Just "imscDestinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImscDestinationSettings))))) :*: ((S1 ('MetaSel ('Just "sccDestinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SccDestinationSettings)) :*: S1 ('MetaSel ('Just "srtDestinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SrtDestinationSettings))) :*: (S1 ('MetaSel ('Just "teletextDestinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TeletextDestinationSettings)) :*: (S1 ('MetaSel ('Just "ttmlDestinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TtmlDestinationSettings)) :*: S1 ('MetaSel ('Just "webvttDestinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebvttDestinationSettings)))))))

newCaptionDestinationSettings :: CaptionDestinationSettings

Create a value of CaptionDestinationSettings 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:burninDestinationSettings:CaptionDestinationSettings', captionDestinationSettings_burninDestinationSettings - Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.

$sel:destinationType:CaptionDestinationSettings', captionDestinationSettings_destinationType - Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

$sel:dvbSubDestinationSettings:CaptionDestinationSettings', captionDestinationSettings_dvbSubDestinationSettings - Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.

$sel:embeddedDestinationSettings:CaptionDestinationSettings', captionDestinationSettings_embeddedDestinationSettings - Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.

$sel:imscDestinationSettings:CaptionDestinationSettings', captionDestinationSettings_imscDestinationSettings - Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.

$sel:sccDestinationSettings:CaptionDestinationSettings', captionDestinationSettings_sccDestinationSettings - Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.

$sel:srtDestinationSettings:CaptionDestinationSettings', captionDestinationSettings_srtDestinationSettings - Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT.

$sel:teletextDestinationSettings:CaptionDestinationSettings', captionDestinationSettings_teletextDestinationSettings - Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TELETEXT.

$sel:ttmlDestinationSettings:CaptionDestinationSettings', captionDestinationSettings_ttmlDestinationSettings - Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.

$sel:webvttDestinationSettings:CaptionDestinationSettings', captionDestinationSettings_webvttDestinationSettings - Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT.

captionDestinationSettings_burninDestinationSettings :: Lens' CaptionDestinationSettings (Maybe BurninDestinationSettings)

Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.

captionDestinationSettings_destinationType :: Lens' CaptionDestinationSettings (Maybe CaptionDestinationType)

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

captionDestinationSettings_dvbSubDestinationSettings :: Lens' CaptionDestinationSettings (Maybe DvbSubDestinationSettings)

Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.

captionDestinationSettings_embeddedDestinationSettings :: Lens' CaptionDestinationSettings (Maybe EmbeddedDestinationSettings)

Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.

captionDestinationSettings_imscDestinationSettings :: Lens' CaptionDestinationSettings (Maybe ImscDestinationSettings)

Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.

captionDestinationSettings_sccDestinationSettings :: Lens' CaptionDestinationSettings (Maybe SccDestinationSettings)

Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.

captionDestinationSettings_srtDestinationSettings :: Lens' CaptionDestinationSettings (Maybe SrtDestinationSettings)

Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT.

captionDestinationSettings_teletextDestinationSettings :: Lens' CaptionDestinationSettings (Maybe TeletextDestinationSettings)

Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TELETEXT.

captionDestinationSettings_ttmlDestinationSettings :: Lens' CaptionDestinationSettings (Maybe TtmlDestinationSettings)

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.

captionDestinationSettings_webvttDestinationSettings :: Lens' CaptionDestinationSettings (Maybe WebvttDestinationSettings)

Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT.