AWS CDK Reference

Appearance

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.

FrameCaptureOutputGroupProps Struct ​

Properties for a Frame Capture output group.

Stability
Experimental
Source
lib/output-group.ts

Example ​

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

medialive.OutputGroupConfiguration.frameCapture({
  name: 'thumbnails',
  destinations: [medialive.S3OutputDestination.toBucket(bucket, 'thumbnails/live')],
  outputs: [{ encodes: [video], outputName: 'thumb' }],
});
python
# bucket: s3.IBucket
# video: medialive.EncodeConfiguration


medialive.OutputGroupConfiguration.frame_capture(
    name="thumbnails",
    destinations=[medialive.S3OutputDestination.to_bucket(bucket, "thumbnails/live")],
    outputs=[medialive.FrameCaptureOutputDefinition(encodes=[video], output_name="thumb")]
)
java
IBucket bucket;
EncodeConfiguration video;


OutputGroupConfiguration.frameCapture(FrameCaptureOutputGroupProps.builder()
        .name("thumbnails")
        .destinations(List.of(S3OutputDestination.toBucket(bucket, "thumbnails/live")))
        .outputs(List.of(FrameCaptureOutputDefinition.builder().encodes(List.of(video)).outputName("thumb").build()))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
IBucket bucket;
EncodeConfiguration video;


OutputGroupConfiguration.FrameCapture(new FrameCaptureOutputGroupProps {
    Name = "thumbnails",
    Destinations = new [] { S3OutputDestination.ToBucket(bucket, "thumbnails/live") },
    Outputs = new [] { new FrameCaptureOutputDefinition { Encodes = new [] { video }, OutputName = "thumb" } }
});
go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
var bucket IBucket
var video EncodeConfiguration


medialive.OutputGroupConfiguration_FrameCapture(&FrameCaptureOutputGroupProps{
	Name: jsii.String("thumbnails"),
	Destinations: []S3OutputDestination{
		medialive.S3OutputDestination_ToBucket(bucket, jsii.String("thumbnails/live")),
	},
	Outputs: []FrameCaptureOutputDefinition{
		&FrameCaptureOutputDefinition{
			Encodes: []EncodeConfiguration{
				video,
			},
			OutputName: jsii.String("thumb"),
		},
	},
})

Properties ​

destinationsS3OutputDestination[]destinationstyping.List[S3OutputDestination]destinationsList<S3OutputDestination>DestinationsS3OutputDestination[]Destinations*[]S3OutputDestinationrequired#
The destinations for this output group — one per pipeline.
notes

Array position determines the pipeline mapping:

  • destinations[0] → Pipeline 0
  • destinations[1] → Pipeline 1 (STANDARD channels only)

For a SINGLE_PIPELINE channel, provide exactly 1 destination. For a STANDARD channel, provide exactly 2 destinations.

frameCaptureS3CannedAcloptionalS3CannedAclframe_capture_s3_canned_acloptionalS3CannedAclframeCaptureS3CannedAcloptionalS3CannedAclFrameCaptureS3CannedAcloptionalS3CannedAclFrameCaptureS3CannedAcloptionalS3CannedAcl#
The S3 canned ACL to apply to each frame capture output.

Default: no canned ACL

namestringnamestrnameStringNamestringName*stringrequired#
The name of this output group.

Used as the destination reference ID. Underscores are normalised to hyphens internally.

outputsoptionalFrameCaptureOutputDefinition[]outputsoptionaltyping.List[FrameCaptureOutputDefinition]outputsoptionalList<FrameCaptureOutputDefinition>OutputsoptionalFrameCaptureOutputDefinition[]Outputsoptional*[]FrameCaptureOutputDefinition#
The outputs for this Frame Capture output group.

Default: no initial outputs