Amazonka.MediaLive.Types.CaptionDescription

Documentation

data CaptionDescription

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

FromJSON CaptionDescription

Defined in Amazonka.MediaLive.Types.CaptionDescription

Methods

parseJSON :: Value -> Parser CaptionDescription

parseJSONList :: Value -> Parser [CaptionDescription]

ToJSON CaptionDescription

Defined in Amazonka.MediaLive.Types.CaptionDescription

Methods

toJSON :: CaptionDescription -> Value

toEncoding :: CaptionDescription -> Encoding

toJSONList :: [CaptionDescription] -> Value

toEncodingList :: [CaptionDescription] -> Encoding

Generic CaptionDescription

Defined in Amazonka.MediaLive.Types.CaptionDescription

Associated Types

type Rep CaptionDescription :: Type -> Type

Methods

from :: CaptionDescription -> Rep CaptionDescription x

to :: Rep CaptionDescription x -> CaptionDescription

Read CaptionDescription

Defined in Amazonka.MediaLive.Types.CaptionDescription

Methods

readsPrec :: Int -> ReadS CaptionDescription

readList :: ReadS [CaptionDescription]

readPrec :: ReadPrec CaptionDescription

readListPrec :: ReadPrec [CaptionDescription]

Show CaptionDescription

Defined in Amazonka.MediaLive.Types.CaptionDescription

Methods

showsPrec :: Int -> CaptionDescription -> ShowS

show :: CaptionDescription -> String

showList :: [CaptionDescription] -> ShowS

NFData CaptionDescription

Defined in Amazonka.MediaLive.Types.CaptionDescription

Methods

rnf :: CaptionDescription -> ()

Eq CaptionDescription

Defined in Amazonka.MediaLive.Types.CaptionDescription

Methods

(==) :: CaptionDescription -> CaptionDescription -> Bool

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

Hashable CaptionDescription

Defined in Amazonka.MediaLive.Types.CaptionDescription

Methods

hashWithSalt :: Int -> CaptionDescription -> Int

hash :: CaptionDescription -> Int

type Rep CaptionDescription

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

Arguments

:: Text

$sel:captionSelectorName:CaptionDescription'

-> Text

$sel:name:CaptionDescription'

-> CaptionDescription

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)

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

captionDescription_destinationSettings :: Lens' CaptionDescription (Maybe CaptionDestinationSettings)

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

captionDescription_languageCode :: Lens' CaptionDescription (Maybe Text)

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

captionDescription_languageDescription :: Lens' CaptionDescription (Maybe Text)

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

captionDescription_captionSelectorName :: Lens' CaptionDescription Text

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

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