Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MediaLive.Types.AudioDescription

Description

Synopsis

Documentation

data AudioDescription Source #

Audio Description

See: newAudioDescription smart constructor.

Constructors

AudioDescription'

Fields

audioNormalizationSettings :: Maybe AudioNormalizationSettings
Advanced audio normalization settings.
audioType :: Maybe AudioType
Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.
audioTypeControl :: Maybe AudioDescriptionAudioTypeControl
Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.
audioWatermarkingSettings :: Maybe AudioWatermarkSettings
Settings to configure one or more solutions that insert audio watermarks in the audio encode
codecSettings :: Maybe AudioCodecSettings
Audio codec settings.
languageCode :: Maybe Text
RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
languageCodeControl :: Maybe AudioDescriptionLanguageCodeControl
Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.
remixSettings :: Maybe RemixSettings
Settings that control how input audio channels are remixed into the output audio channels.
streamName :: Maybe Text
Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
audioSelectorName :: Text
The name of the AudioSelector used as the source for this AudioDescription.
name :: Text
The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.

Instances

Instances details

FromJSON AudioDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.AudioDescription Methods parseJSON :: Value -> Parser AudioDescription # parseJSONList :: Value -> Parser [AudioDescription] #
ToJSON AudioDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.AudioDescription Methods toJSON :: AudioDescription -> Value # toEncoding :: AudioDescription -> Encoding # toJSONList :: [AudioDescription] -> Value # toEncodingList :: [AudioDescription] -> Encoding #
Generic AudioDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.AudioDescription Associated Types type Rep AudioDescription :: Type -> Type # Methods from :: AudioDescription -> Rep AudioDescription x # to :: Rep AudioDescription x -> AudioDescription #
Read AudioDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.AudioDescription Methods readsPrec :: Int -> ReadS AudioDescription # readList :: ReadS [AudioDescription] # readPrec :: ReadPrec AudioDescription # readListPrec :: ReadPrec [AudioDescription] #
Show AudioDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.AudioDescription Methods showsPrec :: Int -> AudioDescription -> ShowS # show :: AudioDescription -> String # showList :: [AudioDescription] -> ShowS #
NFData AudioDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.AudioDescription Methods rnf :: AudioDescription -> () #
Eq AudioDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.AudioDescription Methods (==) :: AudioDescription -> AudioDescription -> Bool # (/=) :: AudioDescription -> AudioDescription -> Bool #
Hashable AudioDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.AudioDescription Methods hashWithSalt :: Int -> AudioDescription -> Int # hash :: AudioDescription -> Int #
type Rep AudioDescription Source #
Instance details Defined in Amazonka.MediaLive.Types.AudioDescription type Rep AudioDescription = D1 ('MetaData "AudioDescription" "Amazonka.MediaLive.Types.AudioDescription" "amazonka-medialive-2.0-FK9HUAz0OmeIH2i6eRdod0" 'False) (C1 ('MetaCons "AudioDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "audioNormalizationSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AudioNormalizationSettings)) :: S1 ('MetaSel ('Just "audioType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AudioType))) :: (S1 ('MetaSel ('Just "audioTypeControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AudioDescriptionAudioTypeControl)) :: (S1 ('MetaSel ('Just "audioWatermarkingSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AudioWatermarkSettings)) :: S1 ('MetaSel ('Just "codecSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AudioCodecSettings))))) :: ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "languageCodeControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AudioDescriptionLanguageCodeControl)) :: S1 ('MetaSel ('Just "remixSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RemixSettings)))) :: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "audioSelectorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newAudioDescription Source #

Arguments

:: Text	`$sel:audioSelectorName:AudioDescription'`
-> Text	`$sel:name:AudioDescription'`
-> AudioDescription

Create a value of AudioDescription 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:audioNormalizationSettings:AudioDescription', audioDescription_audioNormalizationSettings - Advanced audio normalization settings.

$sel:audioType:AudioDescription', audioDescription_audioType - Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.

$sel:audioTypeControl:AudioDescription', audioDescription_audioTypeControl - Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.

$sel:audioWatermarkingSettings:AudioDescription', audioDescription_audioWatermarkingSettings - Settings to configure one or more solutions that insert audio watermarks in the audio encode

$sel:codecSettings:AudioDescription', audioDescription_codecSettings - Audio codec settings.

$sel:languageCode:AudioDescription', audioDescription_languageCode - RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.

$sel:languageCodeControl:AudioDescription', audioDescription_languageCodeControl - Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

$sel:remixSettings:AudioDescription', audioDescription_remixSettings - Settings that control how input audio channels are remixed into the output audio channels.

$sel:streamName:AudioDescription', audioDescription_streamName - Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).

$sel:audioSelectorName:AudioDescription', audioDescription_audioSelectorName - The name of the AudioSelector used as the source for this AudioDescription.

$sel:name:AudioDescription', audioDescription_name - The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.

audioDescription_audioNormalizationSettings :: Lens' AudioDescription (Maybe AudioNormalizationSettings) Source #

Advanced audio normalization settings.

audioDescription_audioType :: Lens' AudioDescription (Maybe AudioType) Source #

Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.

audioDescription_audioTypeControl :: Lens' AudioDescription (Maybe AudioDescriptionAudioTypeControl) Source #

Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.

audioDescription_audioWatermarkingSettings :: Lens' AudioDescription (Maybe AudioWatermarkSettings) Source #

Settings to configure one or more solutions that insert audio watermarks in the audio encode

audioDescription_codecSettings :: Lens' AudioDescription (Maybe AudioCodecSettings) Source #

Audio codec settings.

audioDescription_languageCode :: Lens' AudioDescription (Maybe Text) Source #

RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.

audioDescription_languageCodeControl :: Lens' AudioDescription (Maybe AudioDescriptionLanguageCodeControl) Source #

Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

audioDescription_remixSettings :: Lens' AudioDescription (Maybe RemixSettings) Source #

Settings that control how input audio channels are remixed into the output audio channels.

audioDescription_streamName :: Lens' AudioDescription (Maybe Text) Source #

Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).

audioDescription_audioSelectorName :: Lens' AudioDescription Text Source #

The name of the AudioSelector used as the source for this AudioDescription.

audioDescription_name :: Lens' AudioDescription Text Source #

The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.