@aws-cdk/aws-medialive-alpha.AudioOnlyHlsSettingsProps

Experimental

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

AudioOnlyHlsSettingsProps Struct

Properties for audio-only HLS settings.

Stability

Experimental

Source

lib/m3u8-settings.ts

Example

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'),
      }),
    },
  ],
});

Properties

audioGroupId?optionalstringaudio_group_id?optionalstraudioGroupId?optionalStringAudioGroupId?optionalstringAudioGroupId?optional*string#

The group that this audio rendition belongs to.

Default: service default

audioOnlyImage?optionalFileLocationaudio_only_image?optionalFileLocationaudioOnlyImage?optionalFileLocationAudioOnlyImage?optionalFileLocationAudioOnlyImage?optionalFileLocation#

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

audioTrackType?optionalHlsAudioTrackTypeaudio_track_type?optionalHlsAudioTrackTypeaudioTrackType?optionalHlsAudioTrackTypeAudioTrackType?optionalHlsAudioTrackTypeAudioTrackType?optionalHlsAudioTrackType#

How the audio rendition is signaled in the HLS manifest.

Default: service default

segmentType?optionalHlsAudioOnlySegmentTypesegment_type?optionalHlsAudioOnlySegmentTypesegmentType?optionalHlsAudioOnlySegmentTypeSegmentType?optionalHlsAudioOnlySegmentTypeSegmentType?optionalHlsAudioOnlySegmentType#

The segment container type.

Default: service default