Package software.amazon.awscdk.services.medialive.alpha

Interface AudioEncodeProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AudioEncodeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:40.907Z") @Stability(Experimental) public interface AudioEncodeProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for an audio encode configuration.

Example: 

 Stack stack;
 IInput input;
 IBucket bucket;
 EncodeConfiguration video = EncodeConfiguration.video(VideoEncodeProps.builder()
         .name("video_720p")
         .codec(VideoCodecSettings.h264(H264SettingsProps.builder()
                 .rateControl(H264RateControl.cbr(CbrRateControlProps.builder().bitrate(Bitrate.mbps(3)).build()))
                 .framerate(Framerate.FPS_30)
                 .build()))
         .width(1280)
         .height(720)
         .build());
 EncodeConfiguration audio = EncodeConfiguration.audio(AudioEncodeProps.builder()
         .name("audio_aac")
         .codec(AudioCodecSettings.aac(AacSettingsProps.builder().bitrate(Bitrate.kbps(192)).build()))
         .build());
 Channel.Builder.create(stack, "Channel")
         .inputs(List.of(InputAttachment.builder().input(input).build()))
         .outputGroups(List.of(OutputGroupConfiguration.hls(HlsOutputGroupProps.builder()
                 .name("hls")
                 .destinations(List.of(OutputDestination.toBucket(bucket, "live/stream")))
                 .outputs(List.of(HlsOutputDefinition.builder().encodes(List.of(video, audio)).outputName("hls_out").build()))
                 .build())))
         .build();

  • Method Details

    • getCodec

      @Stability(Experimental) @NotNull AudioCodecSettings getCodec()
      (experimental) The codec for the audio encode.

      Choose the codec explicitly (e.g. AudioCodecSettings.aac(...))

    • getName

      @Stability(Experimental) @NotNull String getName()
      (experimental) A unique name for this audio encode.

    • getAudioDashRoles

      @Stability(Experimental) @Nullable default List<AudioDashRole> getAudioDashRoles()
      (experimental) The DASH roles to assign to this audio output.

      Applies only when the output is configured for DVB DASH accessibility signaling.

      Default: - no DASH roles

    • getAudioNormalization

      @Stability(Experimental) @Nullable default AudioNormalizationSettings getAudioNormalization()
      (experimental) Audio normalization settings for loudness correction.

      Default: - no normalization

    • getAudioSelectorName

      @Stability(Experimental) @Nullable default String getAudioSelectorName()
      (experimental) The name of the audio selector in the input to use as the source.

      Must match the name of an AudioSelector on the input attachment. When omitted, MediaLive uses the input's default audio.

      Default: - the input's default audio

    • getAudioType

      @Stability(Experimental) @Nullable default AudioType getAudioType()
      (experimental) The audio type when audioTypeControl is USE_CONFIGURED.

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

      Default: - follow input

    • getAudioTypeControl

      @Stability(Experimental) @Nullable default AudioTypeControl getAudioTypeControl()
      (experimental) How the audio type is signaled in the output.

      Default: - USE_CONFIGURED when `audioType` is set, otherwise FOLLOW_INPUT

    • getAudioWatermarkSettings

      @Stability(Experimental) @Nullable default AudioWatermarkSettings getAudioWatermarkSettings()
      (experimental) Audio watermarking settings (e.g. Nielsen watermarks).

      Default: - no watermarking

    • getDvbDashAccessibility

      @Stability(Experimental) @Nullable default DvbDashAccessibility getDvbDashAccessibility()
      (experimental) DVB DASH accessibility signaling for this audio output.

      Default: - no DVB DASH accessibility signaling

    • getLanguageCode

      @Stability(Experimental) @Nullable default String getLanguageCode()
      (experimental) The ISO 639-2 language code for the audio output track (e.g. 'eng', 'spa').

      Default: - follow input

    • getLanguageCodeControl

      @Stability(Experimental) @Nullable default AudioLanguageCodeControl getLanguageCodeControl()
      (experimental) How the audio language code is signaled in the output.

      When FOLLOW_INPUT, a configured languageCode is used only as a fallback when the input has none.

      Default: - USE_CONFIGURED when `languageCode` is set, otherwise FOLLOW_INPUT

    • getRemixSettings

      @Stability(Experimental) @Nullable default RemixSettings getRemixSettings()
      (experimental) Audio remix settings for channel remapping.

      Default: - no remixing

    • getStreamName

      @Stability(Experimental) @Nullable default String getStreamName()
      (experimental) The display name for the audio track (e.g. 'English', 'Director Commentary'). Used for HLS and MS Smooth outputs.

      Default: - no stream name

    • builder

      @Stability(Experimental) static AudioEncodeProps.Builder builder()
      Returns:
      a AudioEncodeProps.Builder of AudioEncodeProps