amazonka-medialive-2.0: Amazon Elemental MediaLive 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.MediaLive.Types.CaptionDescription

Description

 
Synopsis

Documentation

data CaptionDescription Source #

Caption Description

See: newCaptionDescription smart constructor.

Constructors

CaptionDescription' 

Fields

  • accessibility :: Maybe AccessibilityType

    Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.

  • destinationSettings :: Maybe CaptionDestinationSettings

    Additional settings for captions destination that depend on the destination type.

  • languageCode :: Maybe Text

    ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

  • languageDescription :: Maybe Text

    Human readable information to indicate captions available for players (eg. English, or Spanish).

  • captionSelectorName :: Text

    Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

  • name :: Text

    Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

Instances

Instances details
FromJSON CaptionDescription Source # 
Instance details

Defined in Amazonka.MediaLive.Types.CaptionDescription

ToJSON CaptionDescription Source # 
Instance details

Defined in Amazonka.MediaLive.Types.CaptionDescription

Generic CaptionDescription Source # 
Instance details

Defined in Amazonka.MediaLive.Types.CaptionDescription

Associated Types

type Rep CaptionDescription :: Type -> Type #

Read CaptionDescription Source # 
Instance details

Defined in Amazonka.MediaLive.Types.CaptionDescription

Show CaptionDescription Source # 
Instance details

Defined in Amazonka.MediaLive.Types.CaptionDescription

NFData CaptionDescription Source # 
Instance details

Defined in Amazonka.MediaLive.Types.CaptionDescription

Methods

rnf :: CaptionDescription -> () #

Eq CaptionDescription Source # 
Instance details

Defined in Amazonka.MediaLive.Types.CaptionDescription

Hashable CaptionDescription Source # 
Instance details

Defined in Amazonka.MediaLive.Types.CaptionDescription

type Rep CaptionDescription Source # 
Instance details

Defined in Amazonka.MediaLive.Types.CaptionDescription

type Rep CaptionDescription = D1 ('MetaData "CaptionDescription" "Amazonka.MediaLive.Types.CaptionDescription" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "CaptionDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessibilityType)) :*: (S1 ('MetaSel ('Just "destinationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CaptionDestinationSettings)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "languageDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "captionSelectorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCaptionDescription Source #

Create a value of CaptionDescription 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:CaptionDescription', captionDescription_accessibility - Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.

$sel:destinationSettings:CaptionDescription', captionDescription_destinationSettings - Additional settings for captions destination that depend on the destination type.

$sel:languageCode:CaptionDescription', captionDescription_languageCode - ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

$sel:languageDescription:CaptionDescription', captionDescription_languageDescription - Human readable information to indicate captions available for players (eg. English, or Spanish).

$sel:captionSelectorName:CaptionDescription', captionDescription_captionSelectorName - Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

$sel:name:CaptionDescription', captionDescription_name - Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

captionDescription_accessibility :: Lens' CaptionDescription (Maybe AccessibilityType) Source #

Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.

captionDescription_destinationSettings :: Lens' CaptionDescription (Maybe CaptionDestinationSettings) Source #

Additional settings for captions destination that depend on the destination type.

captionDescription_languageCode :: Lens' CaptionDescription (Maybe Text) Source #

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

captionDescription_languageDescription :: Lens' CaptionDescription (Maybe Text) Source #

Human readable information to indicate captions available for players (eg. English, or Spanish).

captionDescription_captionSelectorName :: Lens' CaptionDescription Text Source #

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

captionDescription_name :: Lens' CaptionDescription Text Source #

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.