interface AudioDescriptionProperty

Language	Type name
.NET	Amazon.CDK.AWS.MediaLive.CfnChannel.AudioDescriptionProperty
Java	software.amazon.awscdk.services.medialive.CfnChannel.AudioDescriptionProperty
Python	aws_cdk.aws_medialive.CfnChannel.AudioDescriptionProperty
TypeScript	@aws-cdk/aws-medialive » CfnChannel » AudioDescriptionProperty

The encoding information for one output audio.

The parent of this entity is EncoderSettings.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive from '@aws-cdk/aws-medialive';
const audioDescriptionProperty: medialive.CfnChannel.AudioDescriptionProperty = {
  audioNormalizationSettings: {
    algorithm: 'algorithm',
    algorithmControl: 'algorithmControl',
    targetLkfs: 123,
  },
  audioSelectorName: 'audioSelectorName',
  audioType: 'audioType',
  audioTypeControl: 'audioTypeControl',
  audioWatermarkingSettings: {
    nielsenWatermarksSettings: {
      nielsenCbetSettings: {
        cbetCheckDigitString: 'cbetCheckDigitString',
        cbetStepaside: 'cbetStepaside',
        csid: 'csid',
      },
      nielsenDistributionType: 'nielsenDistributionType',
      nielsenNaesIiNwSettings: {
        checkDigitString: 'checkDigitString',
        sid: 123,
        timezone: 'timezone',
      },
    },
  },
  codecSettings: {
    aacSettings: {
      bitrate: 123,
      codingMode: 'codingMode',
      inputType: 'inputType',
      profile: 'profile',
      rateControlMode: 'rateControlMode',
      rawFormat: 'rawFormat',
      sampleRate: 123,
      spec: 'spec',
      vbrQuality: 'vbrQuality',
    },
    ac3Settings: {
      bitrate: 123,
      bitstreamMode: 'bitstreamMode',
      codingMode: 'codingMode',
      dialnorm: 123,
      drcProfile: 'drcProfile',
      lfeFilter: 'lfeFilter',
      metadataControl: 'metadataControl',
    },
    eac3AtmosSettings: {
      bitrate: 123,
      codingMode: 'codingMode',
      dialnorm: 123,
      drcLine: 'drcLine',
      drcRf: 'drcRf',
      heightTrim: 123,
      surroundTrim: 123,
    },
    eac3Settings: {
      attenuationControl: 'attenuationControl',
      bitrate: 123,
      bitstreamMode: 'bitstreamMode',
      codingMode: 'codingMode',
      dcFilter: 'dcFilter',
      dialnorm: 123,
      drcLine: 'drcLine',
      drcRf: 'drcRf',
      lfeControl: 'lfeControl',
      lfeFilter: 'lfeFilter',
      loRoCenterMixLevel: 123,
      loRoSurroundMixLevel: 123,
      ltRtCenterMixLevel: 123,
      ltRtSurroundMixLevel: 123,
      metadataControl: 'metadataControl',
      passthroughControl: 'passthroughControl',
      phaseControl: 'phaseControl',
      stereoDownmix: 'stereoDownmix',
      surroundExMode: 'surroundExMode',
      surroundMode: 'surroundMode',
    },
    mp2Settings: {
      bitrate: 123,
      codingMode: 'codingMode',
      sampleRate: 123,
    },
    passThroughSettings: { },
    wavSettings: {
      bitDepth: 123,
      codingMode: 'codingMode',
      sampleRate: 123,
    },
  },
  languageCode: 'languageCode',
  languageCodeControl: 'languageCodeControl',
  name: 'name',
  remixSettings: {
    channelMappings: [{
      inputChannelLevels: [{
        gain: 123,
        inputChannel: 123,
      }],
      outputChannel: 123,
    }],
    channelsIn: 123,
    channelsOut: 123,
  },
  streamName: 'streamName',
};

Properties

Name	Type	Description
audioNormalizationSettings?	IResolvable | AudioNormalizationSettingsProperty	The advanced audio normalization settings.
audioSelectorName?	string	The name of the AudioSelector that is used as the source for this AudioDescription.
audioType?	string	Applies only if audioTypeControl is useConfigured.
audioTypeControl?	string	Determines how audio type is determined.
audioWatermarkingSettings?	IResolvable | AudioWatermarkSettingsProperty	Settings to configure one or more solutions that insert audio watermarks in the audio encode.
codecSettings?	IResolvable | AudioCodecSettingsProperty	The audio codec settings.
languageCode?	string	Indicates the language of the audio output track.
languageCodeControl?	string	Choosing followInput causes the ISO 639 language code of the output to follow the ISO 639 language code of the input.
name?	string	The name of this AudioDescription.
remixSettings?	IResolvable | RemixSettingsProperty	The settings that control how input audio channels are remixed into the output audio channels.
streamName?	string	Used for Microsoft Smooth and Apple HLS outputs.

---

audioNormalizationSettings?

Type: IResolvable | AudioNormalizationSettingsProperty (optional)

The advanced audio normalization settings.

---

audioSelectorName?

Type: string (optional)

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

---

audioType?

Type: string (optional)

Applies only if audioTypeControl is useConfigured.

The values for audioType are defined in ISO-IEC 13818-1.

---

audioTypeControl?

Type: string (optional)

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?

Type: IResolvable | AudioWatermarkSettingsProperty (optional)

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

---

codecSettings?

Type: IResolvable | AudioCodecSettingsProperty (optional)

The audio codec settings.

---

languageCode?

Type: string (optional)

Indicates the language of the audio output track.

Used only if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.

---

languageCodeControl?

Type: string (optional)

Choosing followInput causes the ISO 639 language code of the output to follow the ISO 639 language code of the input.

The languageCode setting is used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

---

name?

Type: string (optional)

The name of this AudioDescription.

Outputs use this name to uniquely identify this AudioDescription. Description names should be unique within this channel.

---

remixSettings?

Type: IResolvable | RemixSettingsProperty (optional)

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

---

streamName?

Type: string (optional)

Used for Microsoft Smooth and Apple HLS outputs.

Indicates the name displayed by the player (for example, English or Director Commentary).