libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ElasticTranscoder.Types.CaptionSource

Description

 
Synopsis

Documentation

data CaptionSource Source #

A source file for the input sidecar captions used during the transcoding process.

See: newCaptionSource smart constructor.

Constructors

CaptionSource' 

Fields

  • timeOffset :: Maybe Text

    For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

    Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

  • encryption :: Maybe Encryption

    The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

  • key :: Maybe Text

    The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

  • language :: Maybe Text

    A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

    • 2-character ISO 639-1 code
    • 3-character ISO 639-2 code

    For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

  • label :: Maybe Text

    The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

Instances

Instances details
Eq CaptionSource Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.CaptionSource

Methods

(==) :: CaptionSource -> CaptionSource -> Bool #

(/=) :: CaptionSource -> CaptionSource -> Bool #

Read CaptionSource Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.CaptionSource

Methods

readsPrec :: Int -> ReadS CaptionSource #

readList :: ReadS [CaptionSource] #

readPrec :: ReadPrec CaptionSource #

readListPrec :: ReadPrec [CaptionSource] #

Show CaptionSource Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.CaptionSource

Methods

showsPrec :: Int -> CaptionSource -> ShowS #

show :: CaptionSource -> String #

showList :: [CaptionSource] -> ShowS #

Generic CaptionSource Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.CaptionSource

Associated Types

type Rep CaptionSource :: Type -> Type #

Methods

from :: CaptionSource -> Rep CaptionSource x #

to :: Rep CaptionSource x -> CaptionSource #

NFData CaptionSource Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.CaptionSource

Methods

rnf :: CaptionSource -> () #

Hashable CaptionSource Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.CaptionSource

Methods

hashWithSalt :: Int -> CaptionSource -> Int #

hash :: CaptionSource -> Int #

ToJSON CaptionSource Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.CaptionSource

Methods

toJSON :: CaptionSource -> Value #

toEncoding :: CaptionSource -> Encoding #

toJSONList :: [CaptionSource] -> Value #

toEncodingList :: [CaptionSource] -> Encoding #

FromJSON CaptionSource Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.CaptionSource

Methods

parseJSON :: Value -> Parser CaptionSource #

parseJSONList :: Value -> Parser [CaptionSource] #

type Rep CaptionSource Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.CaptionSource

type Rep CaptionSource = D1 ('MetaData "CaptionSource" "Amazonka.ElasticTranscoder.Types.CaptionSource" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "CaptionSource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timeOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Encryption))) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newCaptionSource :: CaptionSource Source #

Create a value of CaptionSource 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:timeOffset:CaptionSource', captionSource_timeOffset - For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

$sel:encryption:CaptionSource', captionSource_encryption - The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

$sel:key:CaptionSource', captionSource_key - The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

$sel:language:CaptionSource', captionSource_language - A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

  • 2-character ISO 639-1 code
  • 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

$sel:label:CaptionSource', captionSource_label - The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

captionSource_timeOffset :: Lens' CaptionSource (Maybe Text) Source #

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

captionSource_encryption :: Lens' CaptionSource (Maybe Encryption) Source #

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

captionSource_key :: Lens' CaptionSource (Maybe Text) Source #

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

captionSource_language :: Lens' CaptionSource (Maybe Text) Source #

A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

  • 2-character ISO 639-1 code
  • 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

captionSource_label :: Lens' CaptionSource (Maybe Text) Source #

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.