Skip to content
v2.277.0

Experimental

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

FrameCaptureOutputDefinition Struct ​

Output definition for a Frame Capture 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;
const frameCaptureOutputDefinition: medialive_alpha.FrameCaptureOutputDefinition = {
  encodes: [encodeConfiguration],
  outputName: 'outputName',

  // the properties below are optional
  nameModifier: 'nameModifier',
};
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

frame_capture_output_definition = medialive_alpha.FrameCaptureOutputDefinition(
    encodes=[encode_configuration],
    output_name="outputName",

    # the properties below are optional
    name_modifier="nameModifier"
)
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;

FrameCaptureOutputDefinition frameCaptureOutputDefinition = FrameCaptureOutputDefinition.builder()
        .encodes(List.of(encodeConfiguration))
        .outputName("outputName")

        // the properties below are optional
        .nameModifier("nameModifier")
        .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;

var frameCaptureOutputDefinition = new FrameCaptureOutputDefinition {
    Encodes = new [] { encodeConfiguration },
    OutputName = "outputName",

    // the properties below are optional
    NameModifier = "nameModifier"
};
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

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

	// the properties below are optional
	NameModifier: jsii.String("nameModifier"),
}

Properties ​

encodesEncodeConfiguration[]encodestyping.List[EncodeConfiguration]encodesList<EncodeConfiguration>EncodesEncodeConfiguration[]Encodes*[]EncodeConfiguration required #
The encode configurations to wire to this output.
nameModifieroptionalstringname_modifieroptionalstrnameModifieroptionalStringNameModifieroptionalstringNameModifieroptional*string #
A string concatenated to the end of the destination file name.

Default: no name modifier

Required if the output group contains more than one output.

outputNamestringoutput_namestroutputNameStringOutputNamestringOutputName*string required #
The name of this output.

Must be unique across all outputs in the channel.