MediaPackageV2OutputDefinition

class aws_cdk.aws_medialive_alpha.MediaPackageV2OutputDefinition(*, encode, output_name, audio_group_id=None, audio_rendition_sets=None, captions=None, hls_auto_select=None, hls_default=None)

Bases: object

(experimental) Output definition for a MediaPackage V2 output group.

MediaPackage V2 uses CMAF ingest which requires one media track (video or audio) per output. In-band captions (burn-in, embedded) can ride alongside the primary encode because they do not produce a separate track.

Parameters:

  • encode (EncodeConfiguration) – (experimental) The primary encode for this output — one video or one audio track.

  • output_name (str) – (experimental) The name of this output. Must be unique across all outputs in the channel.

  • audio_group_id (Optional[str]) – (experimental) The audio group ID for audio outputs. Default: - service default

  • audio_rendition_sets (Optional[str]) – (experimental) The audio rendition sets for video outputs. Default: - service default

  • captions (Optional[Sequence[EncodeConfiguration]]) – (experimental) Caption encodes that ride alongside the primary encode. Only in-band caption types are allowed (burn-in, embedded) — out-of-band captions must go in their own output. Default: - no captions on this output

  • hls_auto_select (Optional[MediaPackageV2HlsSetting]) – (experimental) For audio outputs, whether MediaPackage sets this rendition as the auto-select rendition in the HLS manifest. Default: MediaPackageV2HlsSetting.OMIT

  • hls_default (Optional[MediaPackageV2HlsSetting]) – (experimental) For audio outputs, whether MediaPackage sets this rendition as the default rendition in the HLS manifest. Default: MediaPackageV2HlsSetting.OMIT

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_medialive_alpha as medialive_alpha

# encode_configuration: medialive_alpha.EncodeConfiguration
# media_package_v2_hls_setting: medialive_alpha.MediaPackageV2HlsSetting

media_package_v2_output_definition = medialive_alpha.MediaPackageV2OutputDefinition(
    encode=encode_configuration,
    output_name="outputName",

    # the properties below are optional
    audio_group_id="audioGroupId",
    audio_rendition_sets="audioRenditionSets",
    captions=[encode_configuration],
    hls_auto_select=media_package_v2_hls_setting,
    hls_default=media_package_v2_hls_setting
)

Attributes

audio_group_id

(experimental) The audio group ID for audio outputs.

Default:

  • service default

Stability:

experimental

audio_rendition_sets

(experimental) The audio rendition sets for video outputs.

Default:

  • service default

Stability:

experimental

captions

(experimental) Caption encodes that ride alongside the primary encode.

Only in-band caption types are allowed (burn-in, embedded) — out-of-band captions must go in their own output.

Default:

  • no captions on this output

Stability:

experimental

encode

(experimental) The primary encode for this output — one video or one audio track.

Stability:

experimental

hls_auto_select

(experimental) For audio outputs, whether MediaPackage sets this rendition as the auto-select rendition in the HLS manifest.

Default:

MediaPackageV2HlsSetting.OMIT

Stability:

experimental

hls_default

(experimental) For audio outputs, whether MediaPackage sets this rendition as the default rendition in the HLS manifest.

Default:

MediaPackageV2HlsSetting.OMIT

Stability:

experimental

output_name

(experimental) The name of this output.

Must be unique across all outputs in the channel.

Stability:

experimental