AWS CDK Reference

Appearance

v2.274.0

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

HlsSettings Class ​

Per-output HLS settings.

Select the variant that matches the output: a standard (video) output, an audio-only rendition, an fMP4 output, or a frame-capture output.

Stability
Experimental
Source
lib/m3u8-settings.ts

Example ​

ts
declare const bucket: s3.IBucket;
declare const video: medialive.EncodeConfiguration;
declare const audio: medialive.EncodeConfiguration;

medialive.OutputGroupConfiguration.hls({
  name: 'hls',
  destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
  outputs: [
    {
      encodes: [video],
      outputName: 'video',
      hlsSettings: medialive.HlsSettings.standard({
        m3u8Settings: medialive.M3u8Settings.of({
          scte35Behavior: medialive.M3u8Scte35Behavior.PASSTHROUGH,
          programNum: 1,
        }),
      }),
    },
    {
      encodes: [audio],
      outputName: 'audio',
      hlsSettings: medialive.HlsSettings.audioOnly({
        audioGroupId: 'program',
        audioOnlyImage: medialive.FileLocation.fromBucket(bucket, 'art/cover.png'),
      }),
    },
  ],
});

Initializer ​

ts
new HlsSettings()
python
HlsSettings()
java
new HlsSettings()
csharp
new HlsSettings()
go
NewHlsSettings()

Methods ​

audioOnly(props?: AudioOnlyHlsSettingsProps): HlsSettings // chainable@staticmethod def audio_only(props: typing.Optional[AudioOnlyHlsSettingsProps] = None) -> HlsSettingspublic static HlsSettings audioOnly(AudioOnlyHlsSettingsProps props)public static HlsSettings AudioOnly(AudioOnlyHlsSettingsProps? props = null)func AudioOnly(Props AudioOnlyHlsSettingsProps) HlsSettingsstatic#
Settings for an audio-only HLS rendition.
fmp4(props?: Fmp4HlsSettingsProps): HlsSettings // chainable@staticmethod def fmp4(props: typing.Optional[Fmp4HlsSettingsProps] = None) -> HlsSettingspublic static HlsSettings fmp4(Fmp4HlsSettingsProps props)public static HlsSettings Fmp4(Fmp4HlsSettingsProps? props = null)func Fmp4(Props Fmp4HlsSettingsProps) HlsSettingsstatic#
Settings for an fMP4 HLS output.
frameCapture(): HlsSettings // chainable@staticmethod def frame_capture() -> HlsSettingspublic static HlsSettings frameCapture()public static HlsSettings FrameCapture()func FrameCapture() HlsSettingsstatic#
Settings for a frame-capture output in an HLS output group.
standard(props?: StandardHlsSettingsProps): HlsSettings // chainable@staticmethod def standard(props: typing.Optional[StandardHlsSettingsProps] = None) -> HlsSettingspublic static HlsSettings standard(StandardHlsSettingsProps props)public static HlsSettings Standard(StandardHlsSettingsProps? props = null)func Standard(Props StandardHlsSettingsProps) HlsSettingsstatic#
Settings for a standard (video) HLS output.