Amazonka.MediaConvert.Types.CaptionDescriptionPreset

Documentation

data CaptionDescriptionPreset

Caption Description for preset

See: newCaptionDescriptionPreset smart constructor.

Constructors

CaptionDescriptionPreset'

Fields

• customLanguageCode :: Maybe Text

  Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

• destinationSettings :: Maybe 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.

• languageCode :: Maybe LanguageCode

  Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

• languageDescription :: Maybe Text

  Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Instances

FromJSON CaptionDescriptionPreset

Defined in Amazonka.MediaConvert.Types.CaptionDescriptionPreset

Methods

parseJSON :: Value -> Parser CaptionDescriptionPreset

parseJSONList :: Value -> Parser [CaptionDescriptionPreset]

ToJSON CaptionDescriptionPreset

Defined in Amazonka.MediaConvert.Types.CaptionDescriptionPreset

Methods

toJSON :: CaptionDescriptionPreset -> Value

toEncoding :: CaptionDescriptionPreset -> Encoding

toJSONList :: [CaptionDescriptionPreset] -> Value

toEncodingList :: [CaptionDescriptionPreset] -> Encoding

Generic CaptionDescriptionPreset

Defined in Amazonka.MediaConvert.Types.CaptionDescriptionPreset

Associated Types

type Rep CaptionDescriptionPreset :: Type -> Type

Methods

from :: CaptionDescriptionPreset -> Rep CaptionDescriptionPreset x

to :: Rep CaptionDescriptionPreset x -> CaptionDescriptionPreset

Read CaptionDescriptionPreset

Defined in Amazonka.MediaConvert.Types.CaptionDescriptionPreset

Methods

readsPrec :: Int -> ReadS CaptionDescriptionPreset

readList :: ReadS [CaptionDescriptionPreset]

readPrec :: ReadPrec CaptionDescriptionPreset

readListPrec :: ReadPrec [CaptionDescriptionPreset]

Show CaptionDescriptionPreset

Defined in Amazonka.MediaConvert.Types.CaptionDescriptionPreset

Methods

showsPrec :: Int -> CaptionDescriptionPreset -> ShowS

show :: CaptionDescriptionPreset -> String

showList :: [CaptionDescriptionPreset] -> ShowS

NFData CaptionDescriptionPreset

Defined in Amazonka.MediaConvert.Types.CaptionDescriptionPreset

Methods

rnf :: CaptionDescriptionPreset -> ()

Eq CaptionDescriptionPreset

Defined in Amazonka.MediaConvert.Types.CaptionDescriptionPreset

Methods

(==) :: CaptionDescriptionPreset -> CaptionDescriptionPreset -> Bool

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

Hashable CaptionDescriptionPreset

Defined in Amazonka.MediaConvert.Types.CaptionDescriptionPreset

Methods

hashWithSalt :: Int -> CaptionDescriptionPreset -> Int

hash :: CaptionDescriptionPreset -> Int

type Rep CaptionDescriptionPreset

Defined in Amazonka.MediaConvert.Types.CaptionDescriptionPreset

type Rep CaptionDescriptionPreset = D1 ('MetaData "CaptionDescriptionPreset" "Amazonka.MediaConvert.Types.CaptionDescriptionPreset" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "CaptionDescriptionPreset'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "destinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CaptionDestinationSettings))) :*: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: S1 ('MetaSel ('Just "languageDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCaptionDescriptionPreset :: CaptionDescriptionPreset

Create a value of CaptionDescriptionPreset 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:customLanguageCode:CaptionDescriptionPreset', captionDescriptionPreset_customLanguageCode - Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

$sel:destinationSettings:CaptionDescriptionPreset', captionDescriptionPreset_destinationSettings - 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.

$sel:languageCode:CaptionDescriptionPreset', captionDescriptionPreset_languageCode - Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

$sel:languageDescription:CaptionDescriptionPreset', captionDescriptionPreset_languageDescription - Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

captionDescriptionPreset_customLanguageCode :: Lens' CaptionDescriptionPreset (Maybe Text)

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

captionDescriptionPreset_destinationSettings :: Lens' CaptionDescriptionPreset (Maybe 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.

captionDescriptionPreset_languageCode :: Lens' CaptionDescriptionPreset (Maybe LanguageCode)

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

captionDescriptionPreset_languageDescription :: Lens' CaptionDescriptionPreset (Maybe Text)

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.