amazonka-elastictranscoder-2.0: Amazon Elastic Transcoder SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ElasticTranscoder.Types.Captions

Description

 
Synopsis

Documentation

data Captions Source #

The captions to be created, if any.

See: newCaptions smart constructor.

Constructors

Captions' 

Fields

  • captionFormats :: Maybe [CaptionFormat]

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

  • captionSources :: Maybe [CaptionSource]

    Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

  • mergePolicy :: Maybe Text

    A policy that determines how Elastic Transcoder handles the existence of multiple captions.

    • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
    • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.
    • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.

    MergePolicy cannot be null.

Instances

Instances details
FromJSON Captions Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.Captions

ToJSON Captions Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.Captions

Generic Captions Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.Captions

Associated Types

type Rep Captions :: Type -> Type #

Methods

from :: Captions -> Rep Captions x #

to :: Rep Captions x -> Captions #

Read Captions Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.Captions

Show Captions Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.Captions

NFData Captions Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.Captions

Methods

rnf :: Captions -> () #

Eq Captions Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.Captions

Hashable Captions Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.Captions

Methods

hashWithSalt :: Int -> Captions -> Int #

hash :: Captions -> Int #

type Rep Captions Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.Captions

type Rep Captions = D1 ('MetaData "Captions" "Amazonka.ElasticTranscoder.Types.Captions" "amazonka-elastictranscoder-2.0-CmXzguD33FBGrVHrZxYHry" 'False) (C1 ('MetaCons "Captions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "captionFormats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CaptionFormat])) :*: (S1 ('MetaSel ('Just "captionSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CaptionSource])) :*: S1 ('MetaSel ('Just "mergePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCaptions :: Captions Source #

Create a value of Captions 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:captionFormats:Captions', captions_captionFormats - The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.

$sel:captionSources:Captions', captions_captionSources - Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

$sel:mergePolicy:Captions', captions_mergePolicy - A policy that determines how Elastic Transcoder handles the existence of multiple captions.

  • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
  • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.
  • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.

MergePolicy cannot be null.

captions_captionFormats :: Lens' Captions (Maybe [CaptionFormat]) Source #

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

captions_captionSources :: Lens' Captions (Maybe [CaptionSource]) Source #

Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

captions_mergePolicy :: Lens' Captions (Maybe Text) Source #

A policy that determines how Elastic Transcoder handles the existence of multiple captions.

  • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
  • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.
  • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.

MergePolicy cannot be null.