Class CfnChannel.CaptionRectangleProperty

Settings to configure the caption rectangle for an output captions that will be created using this Teletext source captions.

Inheritance

object

CfnChannel.CaptionRectangleProperty

Implements

CfnChannel.ICaptionRectangleProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.MediaLive

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnChannel.CaptionRectangleProperty : CfnChannel.ICaptionRectangleProperty

Syntax (vb)

Public Class CfnChannel.CaptionRectangleProperty Implements CfnChannel.ICaptionRectangleProperty

Remarks

The parent of this entity is TeletextSourceSettings.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.MediaLive;

             var captionRectangleProperty = new CaptionRectangleProperty {
                 Height = 123,
                 LeftOffset = 123,
                 TopOffset = 123,
                 Width = 123
             };

Synopsis

Constructors

CaptionRectangleProperty()

Settings to configure the caption rectangle for an output captions that will be created using this Teletext source captions.

Properties

Height	See the description in leftOffset.
LeftOffset	Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output.
TopOffset	See the description in leftOffset.
Width	See the description in leftOffset.

Constructors

CaptionRectangleProperty()

Settings to configure the caption rectangle for an output captions that will be created using this Teletext source captions.

public CaptionRectangleProperty()

Remarks

The parent of this entity is TeletextSourceSettings.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.MediaLive;

             var captionRectangleProperty = new CaptionRectangleProperty {
                 Height = 123,
                 LeftOffset = 123,
                 TopOffset = 123,
                 Width = 123
             };

Properties

Height

See the description in leftOffset.

public double? Height { get; set; }

Property Value

double?

Remarks

For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, "80" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html#cfn-medialive-channel-captionrectangle-height

LeftOffset

Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output.

public double? LeftOffset { get; set; }

Property Value

double?

Remarks

(Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them.

For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, "10" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html#cfn-medialive-channel-captionrectangle-leftoffset

TopOffset

See the description in leftOffset.

public double? TopOffset { get; set; }

Property Value

double?

Remarks

For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, "10" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html#cfn-medialive-channel-captionrectangle-topoffset

Width

See the description in leftOffset.

public double? Width { get; set; }

Property Value

double?

Remarks

For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, "80" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-medialive-channel-captionrectangle.html#cfn-medialive-channel-captionrectangle-width

Implements

CfnChannel.ICaptionRectangleProperty