Package software.amazon.awscdk.services.medialive

Interface CfnChannel.AudioDescriptionProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnChannel.AudioDescriptionProperty.Jsii$Proxy
Enclosing class:
CfnChannel
@Stability(Stable) public static interface CfnChannel.AudioDescriptionProperty extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.medialive.*;
 AudioDescriptionProperty audioDescriptionProperty = AudioDescriptionProperty.builder()
         .audioNormalizationSettings(AudioNormalizationSettingsProperty.builder()
                 .algorithm("algorithm")
                 .algorithmControl("algorithmControl")
                 .targetLkfs(123)
                 .build())
         .audioSelectorName("audioSelectorName")
         .audioType("audioType")
         .audioTypeControl("audioTypeControl")
         .audioWatermarkingSettings(AudioWatermarkSettingsProperty.builder()
                 .nielsenWatermarksSettings(NielsenWatermarksSettingsProperty.builder()
                         .nielsenCbetSettings(NielsenCBETProperty.builder()
                                 .cbetCheckDigitString("cbetCheckDigitString")
                                 .cbetStepaside("cbetStepaside")
                                 .csid("csid")
                                 .build())
                         .nielsenDistributionType("nielsenDistributionType")
                         .nielsenNaesIiNwSettings(NielsenNaesIiNwProperty.builder()
                                 .checkDigitString("checkDigitString")
                                 .sid(123)
                                 .timezone("timezone")
                                 .build())
                         .build())
                 .build())
         .codecSettings(AudioCodecSettingsProperty.builder()
                 .aacSettings(AacSettingsProperty.builder()
                         .bitrate(123)
                         .codingMode("codingMode")
                         .inputType("inputType")
                         .profile("profile")
                         .rateControlMode("rateControlMode")
                         .rawFormat("rawFormat")
                         .sampleRate(123)
                         .spec("spec")
                         .vbrQuality("vbrQuality")
                         .build())
                 .ac3Settings(Ac3SettingsProperty.builder()
                         .bitrate(123)
                         .bitstreamMode("bitstreamMode")
                         .codingMode("codingMode")
                         .dialnorm(123)
                         .drcProfile("drcProfile")
                         .lfeFilter("lfeFilter")
                         .metadataControl("metadataControl")
                         .build())
                 .eac3AtmosSettings(Eac3AtmosSettingsProperty.builder()
                         .bitrate(123)
                         .codingMode("codingMode")
                         .dialnorm(123)
                         .drcLine("drcLine")
                         .drcRf("drcRf")
                         .heightTrim(123)
                         .surroundTrim(123)
                         .build())
                 .eac3Settings(Eac3SettingsProperty.builder()
                         .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")
                         .build())
                 .mp2Settings(Mp2SettingsProperty.builder()
                         .bitrate(123)
                         .codingMode("codingMode")
                         .sampleRate(123)
                         .build())
                 .passThroughSettings(PassThroughSettingsProperty.builder().build())
                 .wavSettings(WavSettingsProperty.builder()
                         .bitDepth(123)
                         .codingMode("codingMode")
                         .sampleRate(123)
                         .build())
                 .build())
         .languageCode("languageCode")
         .languageCodeControl("languageCodeControl")
         .name("name")
         .remixSettings(RemixSettingsProperty.builder()
                 .channelMappings(List.of(AudioChannelMappingProperty.builder()
                         .inputChannelLevels(List.of(InputChannelLevelProperty.builder()
                                 .gain(123)
                                 .inputChannel(123)
                                 .build()))
                         .outputChannel(123)
                         .build()))
                 .channelsIn(123)
                 .channelsOut(123)
                 .build())
         .streamName("streamName")
         .build();

  • Method Details

    • getAudioNormalizationSettings

      @Stability(Stable) @Nullable default Object getAudioNormalizationSettings()
      The advanced audio normalization settings.

    • getAudioSelectorName

      @Stability(Stable) @Nullable default String getAudioSelectorName()
      The name of the AudioSelector that is used as the source for this AudioDescription.

    • getAudioType

      @Stability(Stable) @Nullable default String getAudioType()
      Applies only if audioTypeControl is useConfigured.

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

    • getAudioTypeControl

      @Stability(Stable) @Nullable default String getAudioTypeControl()
      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.

    • getAudioWatermarkingSettings

      @Stability(Stable) @Nullable default Object getAudioWatermarkingSettings()
      Settings to configure one or more solutions that insert audio watermarks in the audio encode.

    • getCodecSettings

      @Stability(Stable) @Nullable default Object getCodecSettings()
      The audio codec settings.

    • getLanguageCode

      @Stability(Stable) @Nullable default String getLanguageCode()
      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.

    • getLanguageCodeControl

      @Stability(Stable) @Nullable default String getLanguageCodeControl()
      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.

    • getName

      @Stability(Stable) @Nullable default String getName()
      The name of this AudioDescription.

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

    • getRemixSettings

      @Stability(Stable) @Nullable default Object getRemixSettings()
      The settings that control how input audio channels are remixed into the output audio channels.

    • getStreamName

      @Stability(Stable) @Nullable default String getStreamName()
      Used for Microsoft Smooth and Apple HLS outputs.

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

    • builder

      @Stability(Stable) static CfnChannel.AudioDescriptionProperty.Builder builder()
      Returns:
      a CfnChannel.AudioDescriptionProperty.Builder of CfnChannel.AudioDescriptionProperty