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

Interface AudioOnlyHlsSettingsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AudioOnlyHlsSettingsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:40.914Z")
@Stability(Experimental)
public interface AudioOnlyHlsSettingsProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for audio-only HLS settings.

Example:

 IBucket bucket;
 EncodeConfiguration video;
 EncodeConfiguration audio;
 OutputGroupConfiguration.hls(HlsOutputGroupProps.builder()
         .name("hls")
         .destinations(List.of(OutputDestination.toBucket(bucket, "live/stream")))
         .outputs(List.of(HlsOutputDefinition.builder()
                 .encodes(List.of(video))
                 .outputName("video")
                 .hlsSettings(HlsSettings.standard(StandardHlsSettingsProps.builder()
                         .m3u8Settings(M3u8Settings.of(M3u8SettingsProps.builder()
                                 .scte35Behavior(M3u8Scte35Behavior.PASSTHROUGH)
                                 .programNum(1)
                                 .build()))
                         .build()))
                 .build(), HlsOutputDefinition.builder()
                 .encodes(List.of(audio))
                 .outputName("audio")
                 .hlsSettings(HlsSettings.audioOnly(AudioOnlyHlsSettingsProps.builder()
                         .audioGroupId("program")
                         .audioOnlyImage(FileLocation.fromBucket(bucket, "art/cover.png"))
                         .build()))
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AudioOnlyHlsSettingsProps.Builder	A builder for AudioOnlyHlsSettingsProps
static final class	AudioOnlyHlsSettingsProps.Jsii$Proxy	An implementation for AudioOnlyHlsSettingsProps

Method Summary

Modifier and Type	Method	Description
static AudioOnlyHlsSettingsProps.Builder	builder()
default String	getAudioGroupId()	(experimental) The group that this audio rendition belongs to.
default FileLocation	getAudioOnlyImage()	(experimental) A .jpg or .png cover-art image embedded in each audio-only segment.
default HlsAudioTrackType	getAudioTrackType()	(experimental) How the audio rendition is signaled in the HLS manifest.
default HlsAudioOnlySegmentType	getSegmentType()	(experimental) The segment container type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAudioGroupId

@Stability(Experimental)
@Nullable
default String getAudioGroupId()

(experimental) The group that this audio rendition belongs to.

Default: - service default

getAudioOnlyImage

@Stability(Experimental)
@Nullable
default FileLocation getAudioOnlyImage()

(experimental) A .jpg or .png cover-art image embedded in each audio-only segment. Provide a FileLocation referencing an S3 bucket (FileLocation.fromBucket, which auto-grants read access) or a URL (FileLocation.url).

Default: - no cover art

getAudioTrackType

@Stability(Experimental)
@Nullable
default HlsAudioTrackType getAudioTrackType()

(experimental) How the audio rendition is signaled in the HLS manifest.

Default: - service default

getSegmentType

@Stability(Experimental)
@Nullable
default HlsAudioOnlySegmentType getSegmentType()

(experimental) The segment container type.

Default: - service default

builder

@Stability(Experimental)
static AudioOnlyHlsSettingsProps.Builder builder()

Returns:

a AudioOnlyHlsSettingsProps.Builder of AudioOnlyHlsSettingsProps