Package software.amazon.awscdk.services.medialive

Interface CfnChannel.AudioOnlyHlsSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.AudioOnlyHlsSettingsProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.AudioOnlyHlsSettingsProperty
extends software.amazon.jsii.JsiiSerializable

The configuration of an audio-only HLS output.

The parent of this entity is HlsSettings.

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.*;
 AudioOnlyHlsSettingsProperty audioOnlyHlsSettingsProperty = AudioOnlyHlsSettingsProperty.builder()
         .audioGroupId("audioGroupId")
         .audioOnlyImage(InputLocationProperty.builder()
                 .passwordParam("passwordParam")
                 .uri("uri")
                 .username("username")
                 .build())
         .audioTrackType("audioTrackType")
         .segmentType("segmentType")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannel.AudioOnlyHlsSettingsProperty.Builder	builder()
default String	getAudioGroupId()	Specifies the group that the audio rendition belongs to.
default Object	getAudioOnlyImage()	Used with an audio-only stream.
default String	getAudioTrackType()	Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios.
default String	getSegmentType()	Specifies the segment type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAudioGroupId

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

Specifies the group that the audio rendition belongs to.

getAudioOnlyImage

@Stability(Stable)
@Nullable
default Object getAudioOnlyImage()

Used with an audio-only stream.

It must be a .jpg or .png file. If given, this image is used as the cover art for the audio-only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image; instead, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so it increases bandwidth by {image file size} * {segment count} * {user count.}.

getAudioTrackType

@Stability(Stable)
@Nullable
default String getAudioTrackType()

Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios.

Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client might try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO.

getSegmentType

@Stability(Stable)
@Nullable
default String getSegmentType()

Specifies the segment type.

builder

@Stability(Stable)
static CfnChannel.AudioOnlyHlsSettingsProperty.Builder builder()

Returns:

a CfnChannel.AudioOnlyHlsSettingsProperty.Builder of CfnChannel.AudioOnlyHlsSettingsProperty