Amazonka.MediaConvert.Types.WebvttDestinationSettings

Documentation

data 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.

See: newWebvttDestinationSettings smart constructor.

Constructors

WebvttDestinationSettings'

Fields

• accessibility :: Maybe WebvttAccessibilitySubs

  Set Accessibility subtitles to Enabled if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". Keep the default value, Disabled, if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.

• stylePassthrough :: Maybe WebvttStylePassthrough

  To use the available style, color, and position information from your input captions: Set Style passthrough (stylePassthrough) to Enabled (ENABLED). MediaConvert uses default settings when style and position information is missing from your input captions. To recreate the input captions exactly: Set Style passthrough to Strict (STRICT). MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your input captions and use simplified output captions: Set Style passthrough to Disabled (DISABLED), or leave blank.

Instances

FromJSON WebvttDestinationSettings

Defined in Amazonka.MediaConvert.Types.WebvttDestinationSettings

Methods

parseJSON :: Value -> Parser WebvttDestinationSettings

parseJSONList :: Value -> Parser [WebvttDestinationSettings]

ToJSON WebvttDestinationSettings

Defined in Amazonka.MediaConvert.Types.WebvttDestinationSettings

Methods

toJSON :: WebvttDestinationSettings -> Value

toEncoding :: WebvttDestinationSettings -> Encoding

toJSONList :: [WebvttDestinationSettings] -> Value

toEncodingList :: [WebvttDestinationSettings] -> Encoding

Generic WebvttDestinationSettings

Defined in Amazonka.MediaConvert.Types.WebvttDestinationSettings

Associated Types

type Rep WebvttDestinationSettings :: Type -> Type

Methods

from :: WebvttDestinationSettings -> Rep WebvttDestinationSettings x

to :: Rep WebvttDestinationSettings x -> WebvttDestinationSettings

Read WebvttDestinationSettings

Defined in Amazonka.MediaConvert.Types.WebvttDestinationSettings

Methods

readsPrec :: Int -> ReadS WebvttDestinationSettings

readList :: ReadS [WebvttDestinationSettings]

readPrec :: ReadPrec WebvttDestinationSettings

readListPrec :: ReadPrec [WebvttDestinationSettings]

Show WebvttDestinationSettings

Defined in Amazonka.MediaConvert.Types.WebvttDestinationSettings

Methods

showsPrec :: Int -> WebvttDestinationSettings -> ShowS

show :: WebvttDestinationSettings -> String

showList :: [WebvttDestinationSettings] -> ShowS

NFData WebvttDestinationSettings

Defined in Amazonka.MediaConvert.Types.WebvttDestinationSettings

Methods

rnf :: WebvttDestinationSettings -> ()

Eq WebvttDestinationSettings

Defined in Amazonka.MediaConvert.Types.WebvttDestinationSettings

Methods

(==) :: WebvttDestinationSettings -> WebvttDestinationSettings -> Bool

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

Hashable WebvttDestinationSettings

Defined in Amazonka.MediaConvert.Types.WebvttDestinationSettings

Methods

hashWithSalt :: Int -> WebvttDestinationSettings -> Int

hash :: WebvttDestinationSettings -> Int

type Rep WebvttDestinationSettings

Defined in Amazonka.MediaConvert.Types.WebvttDestinationSettings

type Rep WebvttDestinationSettings = D1 ('MetaData "WebvttDestinationSettings" "Amazonka.MediaConvert.Types.WebvttDestinationSettings" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "WebvttDestinationSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebvttAccessibilitySubs)) :*: S1 ('MetaSel ('Just "stylePassthrough") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebvttStylePassthrough))))

newWebvttDestinationSettings :: WebvttDestinationSettings

Create a value of WebvttDestinationSettings 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:accessibility:WebvttDestinationSettings', webvttDestinationSettings_accessibility - Set Accessibility subtitles to Enabled if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". Keep the default value, Disabled, if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.

$sel:stylePassthrough:WebvttDestinationSettings', webvttDestinationSettings_stylePassthrough - To use the available style, color, and position information from your input captions: Set Style passthrough (stylePassthrough) to Enabled (ENABLED). MediaConvert uses default settings when style and position information is missing from your input captions. To recreate the input captions exactly: Set Style passthrough to Strict (STRICT). MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your input captions and use simplified output captions: Set Style passthrough to Disabled (DISABLED), or leave blank.

webvttDestinationSettings_accessibility :: Lens' WebvttDestinationSettings (Maybe WebvttAccessibilitySubs)

Set Accessibility subtitles to Enabled if the ISMC or WebVTT captions track is intended to provide accessibility for people who are deaf or hard of hearing. When you enable this feature, MediaConvert adds the following attributes under EXT-X-MEDIA in the HLS or CMAF manifest for this track: CHARACTERISTICS="public.accessibility.describes-spoken-dialog,public.accessibility.describes-music-and-sound" and AUTOSELECT="YES". Keep the default value, Disabled, if the captions track is not intended to provide such accessibility. MediaConvert will not add the above attributes.

webvttDestinationSettings_stylePassthrough :: Lens' WebvttDestinationSettings (Maybe WebvttStylePassthrough)

To use the available style, color, and position information from your input captions: Set Style passthrough (stylePassthrough) to Enabled (ENABLED). MediaConvert uses default settings when style and position information is missing from your input captions. To recreate the input captions exactly: Set Style passthrough to Strict (STRICT). MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your input captions and use simplified output captions: Set Style passthrough to Disabled (DISABLED), or leave blank.