Skip to content
v2.276.0

Experimental

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

HlsOutputDefinition Struct ​

Output definition for an HLS output group.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive_alpha from '@aws-cdk/aws-medialive-alpha';

declare const encodeConfiguration: medialive_alpha.EncodeConfiguration;
declare const h265PackagingType: medialive_alpha.H265PackagingType;
declare const hlsSettings: medialive_alpha.HlsSettings;
const hlsOutputDefinition: medialive_alpha.HlsOutputDefinition = {
  encodes: [encodeConfiguration],
  outputName: 'outputName',

  // the properties below are optional
  h265PackagingType: h265PackagingType,
  hlsSettings: hlsSettings,
  nameModifier: 'nameModifier',
  segmentModifier: 'segmentModifier',
};
python
# 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
# h265_packaging_type: medialive_alpha.H265PackagingType
# hls_settings: medialive_alpha.HlsSettings

hls_output_definition = medialive_alpha.HlsOutputDefinition(
    encodes=[encode_configuration],
    output_name="outputName",

    # the properties below are optional
    h265_packaging_type=h265_packaging_type,
    hls_settings=hls_settings,
    name_modifier="nameModifier",
    segment_modifier="segmentModifier"
)
java
// 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.alpha.*;

EncodeConfiguration encodeConfiguration;
H265PackagingType h265PackagingType;
HlsSettings hlsSettings;

HlsOutputDefinition hlsOutputDefinition = HlsOutputDefinition.builder()
        .encodes(List.of(encodeConfiguration))
        .outputName("outputName")

        // the properties below are optional
        .h265PackagingType(h265PackagingType)
        .hlsSettings(hlsSettings)
        .nameModifier("nameModifier")
        .segmentModifier("segmentModifier")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaLive.Alpha;

EncodeConfiguration encodeConfiguration;
H265PackagingType h265PackagingType;
HlsSettings hlsSettings;

var hlsOutputDefinition = new HlsOutputDefinition {
    Encodes = new [] { encodeConfiguration },
    OutputName = "outputName",

    // the properties below are optional
    H265PackagingType = h265PackagingType,
    HlsSettings = hlsSettings,
    NameModifier = "nameModifier",
    SegmentModifier = "segmentModifier"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import medialive_alpha "github.com/aws/aws-cdk-go/awsmedialivealpha"

var encodeConfiguration EncodeConfiguration
var h265PackagingType H265PackagingType
var hlsSettings HlsSettings

hlsOutputDefinition := &HlsOutputDefinition{
	Encodes: []EncodeConfiguration{
		encodeConfiguration,
	},
	OutputName: jsii.String("outputName"),

	// the properties below are optional
	H265PackagingType: h265PackagingType,
	HlsSettings: hlsSettings,
	NameModifier: jsii.String("nameModifier"),
	SegmentModifier: jsii.String("segmentModifier"),
}

Properties ​

encodesEncodeConfiguration[]encodestyping.List[EncodeConfiguration]encodesList<EncodeConfiguration>EncodesEncodeConfiguration[]Encodes*[]EncodeConfigurationrequired#
The encode configurations to wire to this output.
h265PackagingTypeoptionalH265PackagingTypeh265_packaging_typeoptionalH265PackagingTypeh265PackagingTypeoptionalH265PackagingTypeH265PackagingTypeoptionalH265PackagingTypeH265PackagingTypeoptionalH265PackagingType#
For H.265 video, whether to package as HEV1 or HVC1.

Default: service default

hlsSettingsoptionalHlsSettingshls_settingsoptionalHlsSettingshlsSettingsoptionalHlsSettingsHlsSettingsoptionalHlsSettingsHlsSettingsoptionalHlsSettings#
The per-output HLS settings (standard, audio-only, fMP4, or frame-capture).

Default: HlsSettings.standard() with service-default M3U8 settings

Use the HlsSettings factory methods. Standard outputs additionally configure the M3U8 container via HlsSettings.standard({ m3u8Settings }).

nameModifieroptionalstringname_modifieroptionalstrnameModifieroptionalStringNameModifieroptionalstringNameModifieroptional*string#
A string concatenated to the end of the destination file name.

Default: service default

outputNamestringoutput_namestroutputNameStringOutputNamestringOutputName*stringrequired#
The name of this output.

Must be unique across all outputs in the channel.

segmentModifieroptionalstringsegment_modifieroptionalstrsegmentModifieroptionalStringSegmentModifieroptionalstringSegmentModifieroptional*string#
A string concatenated to the end of segment file names.

Default: no segment modifier