Amazonka.MediaConvert.Types.CaptionSourceSettings

Documentation

data CaptionSourceSettings

If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

See: newCaptionSourceSettings smart constructor.

Constructors

CaptionSourceSettings'

Fields

• ancillarySourceSettings :: Maybe AncillarySourceSettings

  Settings for ancillary captions source.

• dvbSubSourceSettings :: Maybe DvbSubSourceSettings

  DVB Sub Source Settings

• embeddedSourceSettings :: Maybe EmbeddedSourceSettings

  Settings for embedded captions Source

• fileSourceSettings :: Maybe FileSourceSettings

  If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

• sourceType :: Maybe CaptionSourceType

  Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

• teletextSourceSettings :: Maybe TeletextSourceSettings

  Settings specific to Teletext caption sources, including Page number.

• trackSourceSettings :: Maybe TrackSourceSettings

  Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

• webvttHlsSourceSettings :: Maybe WebvttHlsSourceSettings

  Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Instances

FromJSON CaptionSourceSettings

Defined in Amazonka.MediaConvert.Types.CaptionSourceSettings

Methods

parseJSON :: Value -> Parser CaptionSourceSettings

parseJSONList :: Value -> Parser [CaptionSourceSettings]

ToJSON CaptionSourceSettings

Defined in Amazonka.MediaConvert.Types.CaptionSourceSettings

Methods

toJSON :: CaptionSourceSettings -> Value

toEncoding :: CaptionSourceSettings -> Encoding

toJSONList :: [CaptionSourceSettings] -> Value

toEncodingList :: [CaptionSourceSettings] -> Encoding

Generic CaptionSourceSettings

Defined in Amazonka.MediaConvert.Types.CaptionSourceSettings

Associated Types

type Rep CaptionSourceSettings :: Type -> Type

Methods

from :: CaptionSourceSettings -> Rep CaptionSourceSettings x

to :: Rep CaptionSourceSettings x -> CaptionSourceSettings

Read CaptionSourceSettings

Defined in Amazonka.MediaConvert.Types.CaptionSourceSettings

Methods

readsPrec :: Int -> ReadS CaptionSourceSettings

readList :: ReadS [CaptionSourceSettings]

readPrec :: ReadPrec CaptionSourceSettings

readListPrec :: ReadPrec [CaptionSourceSettings]

Show CaptionSourceSettings

Defined in Amazonka.MediaConvert.Types.CaptionSourceSettings

Methods

showsPrec :: Int -> CaptionSourceSettings -> ShowS

show :: CaptionSourceSettings -> String

showList :: [CaptionSourceSettings] -> ShowS

NFData CaptionSourceSettings

Defined in Amazonka.MediaConvert.Types.CaptionSourceSettings

Methods

rnf :: CaptionSourceSettings -> ()

Eq CaptionSourceSettings

Defined in Amazonka.MediaConvert.Types.CaptionSourceSettings

Methods

(==) :: CaptionSourceSettings -> CaptionSourceSettings -> Bool

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

Hashable CaptionSourceSettings

Defined in Amazonka.MediaConvert.Types.CaptionSourceSettings

Methods

hashWithSalt :: Int -> CaptionSourceSettings -> Int

hash :: CaptionSourceSettings -> Int

type Rep CaptionSourceSettings

Defined in Amazonka.MediaConvert.Types.CaptionSourceSettings

type Rep CaptionSourceSettings = D1 ('MetaData "CaptionSourceSettings" "Amazonka.MediaConvert.Types.CaptionSourceSettings" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "CaptionSourceSettings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "ancillarySourceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AncillarySourceSettings)) :*: S1 ('MetaSel ('Just "dvbSubSourceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DvbSubSourceSettings))) :*: (S1 ('MetaSel ('Just "embeddedSourceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EmbeddedSourceSettings)) :*: S1 ('MetaSel ('Just "fileSourceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FileSourceSettings)))) :*: ((S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CaptionSourceType)) :*: S1 ('MetaSel ('Just "teletextSourceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TeletextSourceSettings))) :*: (S1 ('MetaSel ('Just "trackSourceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrackSourceSettings)) :*: S1 ('MetaSel ('Just "webvttHlsSourceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebvttHlsSourceSettings))))))

newCaptionSourceSettings :: CaptionSourceSettings

Create a value of CaptionSourceSettings 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:ancillarySourceSettings:CaptionSourceSettings', captionSourceSettings_ancillarySourceSettings - Settings for ancillary captions source.

$sel:dvbSubSourceSettings:CaptionSourceSettings', captionSourceSettings_dvbSubSourceSettings - DVB Sub Source Settings

$sel:embeddedSourceSettings:CaptionSourceSettings', captionSourceSettings_embeddedSourceSettings - Settings for embedded captions Source

$sel:fileSourceSettings:CaptionSourceSettings', captionSourceSettings_fileSourceSettings - If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

$sel:sourceType:CaptionSourceSettings', captionSourceSettings_sourceType - Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

$sel:teletextSourceSettings:CaptionSourceSettings', captionSourceSettings_teletextSourceSettings - Settings specific to Teletext caption sources, including Page number.

$sel:trackSourceSettings:CaptionSourceSettings', captionSourceSettings_trackSourceSettings - Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

$sel:webvttHlsSourceSettings:CaptionSourceSettings', captionSourceSettings_webvttHlsSourceSettings - Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

captionSourceSettings_ancillarySourceSettings :: Lens' CaptionSourceSettings (Maybe AncillarySourceSettings)

Settings for ancillary captions source.

captionSourceSettings_dvbSubSourceSettings :: Lens' CaptionSourceSettings (Maybe DvbSubSourceSettings)

DVB Sub Source Settings

captionSourceSettings_embeddedSourceSettings :: Lens' CaptionSourceSettings (Maybe EmbeddedSourceSettings)

Settings for embedded captions Source

captionSourceSettings_fileSourceSettings :: Lens' CaptionSourceSettings (Maybe FileSourceSettings)

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

captionSourceSettings_sourceType :: Lens' CaptionSourceSettings (Maybe CaptionSourceType)

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

captionSourceSettings_teletextSourceSettings :: Lens' CaptionSourceSettings (Maybe TeletextSourceSettings)

Settings specific to Teletext caption sources, including Page number.

captionSourceSettings_trackSourceSettings :: Lens' CaptionSourceSettings (Maybe TrackSourceSettings)

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

captionSourceSettings_webvttHlsSourceSettings :: Lens' CaptionSourceSettings (Maybe WebvttHlsSourceSettings)

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.