AWS CDK Reference

Appearance

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.

TeletextCaptionSourceOptions Struct ​

Options for a Teletext caption source.

Stability
Experimental
Source
lib/caption-selector.ts

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';
const teletextCaptionSourceOptions: medialive_alpha.TeletextCaptionSourceOptions = {
  outputRectangle: {
    height: 123,
    leftOffset: 123,
    topOffset: 123,
    width: 123,
  },
  pageNumber: 'pageNumber',
};
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

teletext_caption_source_options = medialive_alpha.TeletextCaptionSourceOptions(
    output_rectangle=medialive_alpha.CaptionRectangle(
        height=123,
        left_offset=123,
        top_offset=123,
        width=123
    ),
    page_number="pageNumber"
)
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.*;

TeletextCaptionSourceOptions teletextCaptionSourceOptions = TeletextCaptionSourceOptions.builder()
        .outputRectangle(CaptionRectangle.builder()
                .height(123)
                .leftOffset(123)
                .topOffset(123)
                .width(123)
                .build())
        .pageNumber("pageNumber")
        .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;

var teletextCaptionSourceOptions = new TeletextCaptionSourceOptions {
    OutputRectangle = new CaptionRectangle {
        Height = 123,
        LeftOffset = 123,
        TopOffset = 123,
        Width = 123
    },
    PageNumber = "pageNumber"
};
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"

teletextCaptionSourceOptions := &TeletextCaptionSourceOptions{
	OutputRectangle: &CaptionRectangle{
		Height: jsii.Number(123),
		LeftOffset: jsii.Number(123),
		TopOffset: jsii.Number(123),
		Width: jsii.Number(123),
	},
	PageNumber: jsii.String("pageNumber"),
}

Properties ​

outputRectangleoptionalCaptionRectangleoutput_rectangleoptionalCaptionRectangleoutputRectangleoptionalCaptionRectangleOutputRectangleoptionalCaptionRectangleOutputRectangleoptionalCaptionRectangle#
The caption rectangle to use when converting this source to EBU-TT-D or TTML.

Default: no rectangle (service default)

pageNumberoptionalstringpage_numberoptionalstrpageNumberoptionalStringPageNumberoptionalstringPageNumberoptional*string#
The Teletext page number to extract captions from, as a hexadecimal string with no `0x` prefix (range `100`–`8FF`).

Default: MediaLive service default

Unused for passthrough.