Class: AWSCDK::MediaLive::CfnChannel::DvbSubDestinationSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

The settings for DVB Sub captions in the output.

The parent of this entity is CaptionDestinationSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(alignment: nil, background_color: nil, background_opacity: nil, font: nil, font_color: nil, font_opacity: nil, font_resolution: nil, font_size: nil, outline_color: nil, outline_size: nil, shadow_color: nil, shadow_opacity: nil, shadow_x_offset: nil, shadow_y_offset: nil, subtitle_rows: nil, teletext_grid_control: nil, x_position: nil, y_position: nil) ⇒ DvbSubDestinationSettingsProperty

Returns a new instance of DvbSubDestinationSettingsProperty.

Parameters:

  • alignment (String, nil) (defaults to: nil) —

    If no explicit xPosition or yPosition is provided, setting the alignment to centered places the captions at the bottom center of the output.

  • background_color (String, nil) (defaults to: nil) —

    Specifies the color of the rectangle behind the captions.

  • background_opacity (Numeric, nil) (defaults to: nil) —

    Specifies the opacity of the background rectangle.

  • font (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::InputLocationProperty, nil) (defaults to: nil) —

    The external font file that is used for captions burn-in.

  • font_color (String, nil) (defaults to: nil) —

    Specifies the color of the burned-in captions.

  • font_opacity (Numeric, nil) (defaults to: nil) —

    Specifies the opacity of the burned-in captions.

  • font_resolution (Numeric, nil) (defaults to: nil) —

    The font resolution in DPI (dots per inch).

  • font_size (String, nil) (defaults to: nil) —

    When set to auto, fontSize scales depending on the size of the output.

  • outline_color (String, nil) (defaults to: nil) —

    Specifies the font outline color.

  • outline_size (Numeric, nil) (defaults to: nil) —

    Specifies the font outline size in pixels.

  • shadow_color (String, nil) (defaults to: nil) —

    Specifies the color of the shadow that is cast by the captions.

  • shadow_opacity (Numeric, nil) (defaults to: nil) —

    Specifies the opacity of the shadow.

  • shadow_x_offset (Numeric, nil) (defaults to: nil) —

    Specifies the horizontal offset of the shadow relative to the captions in pixels.

  • shadow_y_offset (Numeric, nil) (defaults to: nil) —

    Specifies the vertical offset of the shadow relative to the captions in pixels.

  • subtitle_rows (String, nil) (defaults to: nil)
  • teletext_grid_control (String, nil) (defaults to: nil) —

    Controls whether a fixed grid size is used to generate the output subtitles bitmap.

  • x_position (Numeric, nil) (defaults to: nil) —

    Specifies the horizontal position of the captions relative to the left side of the output in pixels.

  • y_position (Numeric, nil) (defaults to: nil) —

    Specifies the vertical position of the captions relative to the top of the output in pixels.



4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
 
# File 'media_live/cfn_channel.rb', line 4398

def initialize(alignment: nil, background_color: nil, background_opacity: nil, font: nil, font_color: nil, font_opacity: nil, font_resolution: nil, font_size: nil, outline_color: nil, outline_size: nil, shadow_color: nil, shadow_opacity: nil, shadow_x_offset: nil, shadow_y_offset: nil, subtitle_rows: nil, teletext_grid_control: nil, x_position: nil, y_position: nil)
  @alignment = alignment
  Jsii::Type.check_type(@alignment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alignment") unless @alignment.nil?
  @background_color = background_color
  Jsii::Type.check_type(@background_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backgroundColor") unless @background_color.nil?
  @background_opacity = background_opacity
  Jsii::Type.check_type(@background_opacity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "backgroundOpacity") unless @background_opacity.nil?
  @font = font.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::InputLocationProperty.new(**font.transform_keys(&:to_sym)) : font
  Jsii::Type.check_type(@font, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5JbnB1dExvY2F0aW9uUHJvcGVydHkifV19fQ==")), "font") unless @font.nil?
  @font_color = font_color
  Jsii::Type.check_type(@font_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fontColor") unless @font_color.nil?
  @font_opacity = font_opacity
  Jsii::Type.check_type(@font_opacity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "fontOpacity") unless @font_opacity.nil?
  @font_resolution = font_resolution
  Jsii::Type.check_type(@font_resolution, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "fontResolution") unless @font_resolution.nil?
  @font_size = font_size
  Jsii::Type.check_type(@font_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fontSize") unless @font_size.nil?
  @outline_color = outline_color
  Jsii::Type.check_type(@outline_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outlineColor") unless @outline_color.nil?
  @outline_size = outline_size
  Jsii::Type.check_type(@outline_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "outlineSize") unless @outline_size.nil?
  @shadow_color = shadow_color
  Jsii::Type.check_type(@shadow_color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "shadowColor") unless @shadow_color.nil?
  @shadow_opacity = shadow_opacity
  Jsii::Type.check_type(@shadow_opacity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "shadowOpacity") unless @shadow_opacity.nil?
  @shadow_x_offset = shadow_x_offset
  Jsii::Type.check_type(@shadow_x_offset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "shadowXOffset") unless @shadow_x_offset.nil?
  @shadow_y_offset = shadow_y_offset
  Jsii::Type.check_type(@shadow_y_offset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "shadowYOffset") unless @shadow_y_offset.nil?
  @subtitle_rows = subtitle_rows
  Jsii::Type.check_type(@subtitle_rows, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subtitleRows") unless @subtitle_rows.nil?
  @teletext_grid_control = teletext_grid_control
  Jsii::Type.check_type(@teletext_grid_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "teletextGridControl") unless @teletext_grid_control.nil?
  @x_position = x_position
  Jsii::Type.check_type(@x_position, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "xPosition") unless @x_position.nil?
  @y_position = y_position
  Jsii::Type.check_type(@y_position, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "yPosition") unless @y_position.nil?
end

Instance Attribute Details

#alignment ⇒ String? (readonly)

If no explicit xPosition or yPosition is provided, setting the alignment to centered places the captions at the bottom center of the output.

Similarly, setting a left alignment aligns captions to the bottom left of the output. If x and y positions are specified in conjunction with the alignment parameter, the font is justified (either left or centered) relative to those coordinates. Selecting "smart" justification left-justifies live subtitles and center-justifies pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

Returns:

  • (String, nil)

See Also:



4443
4444
4445
 
# File 'media_live/cfn_channel.rb', line 4443

def alignment
  @alignment
end

#background_color ⇒ String? (readonly)

Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

Returns:

  • (String, nil)

See Also:



4450
4451
4452
 
# File 'media_live/cfn_channel.rb', line 4450

def background_color
  @background_color
end

#background_opacity ⇒ Numeric? (readonly)

Specifies the opacity of the background rectangle.

255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



4457
4458
4459
 
# File 'media_live/cfn_channel.rb', line 4457

def background_opacity
  @background_opacity
end

#font ⇒ AWSCDK::IResolvable, ... (readonly)

The external font file that is used for captions burn-in.

The file extension must be .ttf or .tte. Although you can select output fonts for many different types of input captions, embedded, STL, and Teletext sources use a strict grid system. Using external fonts with these captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

Returns:

See Also:



4464
4465
4466
 
# File 'media_live/cfn_channel.rb', line 4464

def font
  @font
end

#font_color ⇒ String? (readonly)

Specifies the color of the burned-in captions.

This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

Returns:

  • (String, nil)

See Also:



4471
4472
4473
 
# File 'media_live/cfn_channel.rb', line 4471

def font_color
  @font_color
end

#font_opacity ⇒ Numeric? (readonly)

Specifies the opacity of the burned-in captions.

255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



4478
4479
4480
 
# File 'media_live/cfn_channel.rb', line 4478

def font_opacity
  @font_opacity
end

#font_resolution ⇒ Numeric? (readonly)

The font resolution in DPI (dots per inch).

The default is 96 dpi. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



4485
4486
4487
 
# File 'media_live/cfn_channel.rb', line 4485

def font_resolution
  @font_resolution
end

#font_size ⇒ String? (readonly)

When set to auto, fontSize scales depending on the size of the output.

Providing a positive integer specifies the exact font size in points. All burn-in and DVB-Sub font settings must match.

Returns:

  • (String, nil)

See Also:



4492
4493
4494
 
# File 'media_live/cfn_channel.rb', line 4492

def font_size
  @font_size
end

#outline_color ⇒ String? (readonly)

Specifies the font outline color.

This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

Returns:

  • (String, nil)

See Also:



4499
4500
4501
 
# File 'media_live/cfn_channel.rb', line 4499

def outline_color
  @outline_color
end

#outline_size ⇒ Numeric? (readonly)

Specifies the font outline size in pixels.

This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



4506
4507
4508
 
# File 'media_live/cfn_channel.rb', line 4506

def outline_size
  @outline_size
end

#shadow_color ⇒ String? (readonly)

Specifies the color of the shadow that is cast by the captions.

All burn-in and DVB-Sub font settings must match.

Returns:

  • (String, nil)

See Also:



4513
4514
4515
 
# File 'media_live/cfn_channel.rb', line 4513

def shadow_color
  @shadow_color
end

#shadow_opacity ⇒ Numeric? (readonly)

Specifies the opacity of the shadow.

255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



4520
4521
4522
 
# File 'media_live/cfn_channel.rb', line 4520

def shadow_opacity
  @shadow_opacity
end

#shadow_x_offset ⇒ Numeric? (readonly)

Specifies the horizontal offset of the shadow relative to the captions in pixels.

A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



4527
4528
4529
 
# File 'media_live/cfn_channel.rb', line 4527

def shadow_x_offset
  @shadow_x_offset
end

#shadow_y_offset ⇒ Numeric? (readonly)

Specifies the vertical offset of the shadow relative to the captions in pixels.

A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



4534
4535
4536
 
# File 'media_live/cfn_channel.rb', line 4534

def shadow_y_offset
  @shadow_y_offset
end

#subtitle_rows ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



4537
4538
4539
 
# File 'media_live/cfn_channel.rb', line 4537

def subtitle_rows
  @subtitle_rows
end

#teletext_grid_control ⇒ String? (readonly)

Controls whether a fixed grid size is used to generate the output subtitles bitmap.

This applies to only Teletext inputs and DVB-Sub/Burn-in outputs.

Returns:

  • (String, nil)

See Also:



4544
4545
4546
 
# File 'media_live/cfn_channel.rb', line 4544

def teletext_grid_control
  @teletext_grid_control
end

#x_position ⇒ Numeric? (readonly)

Specifies the horizontal position of the captions relative to the left side of the output in pixels.

A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal captions position is determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



4551
4552
4553
 
# File 'media_live/cfn_channel.rb', line 4551

def x_position
  @x_position
end

#y_position ⇒ Numeric? (readonly)

Specifies the vertical position of the captions relative to the top of the output in pixels.

A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the captions are positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



4558
4559
4560
 
# File 'media_live/cfn_channel.rb', line 4558

def y_position
  @y_position
end

Class Method Details

.jsii_properties ⇒ Object 



4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
 
# File 'media_live/cfn_channel.rb', line 4560

def self.jsii_properties
  {
    :alignment => "alignment",
    :background_color => "backgroundColor",
    :background_opacity => "backgroundOpacity",
    :font => "font",
    :font_color => "fontColor",
    :font_opacity => "fontOpacity",
    :font_resolution => "fontResolution",
    :font_size => "fontSize",
    :outline_color => "outlineColor",
    :outline_size => "outlineSize",
    :shadow_color => "shadowColor",
    :shadow_opacity => "shadowOpacity",
    :shadow_x_offset => "shadowXOffset",
    :shadow_y_offset => "shadowYOffset",
    :subtitle_rows => "subtitleRows",
    :teletext_grid_control => "teletextGridControl",
    :x_position => "xPosition",
    :y_position => "yPosition",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
 
# File 'media_live/cfn_channel.rb', line 4583

def to_jsii
  result = {}
  result.merge!({
    "alignment" => @alignment,
    "backgroundColor" => @background_color,
    "backgroundOpacity" => @background_opacity,
    "font" => @font,
    "fontColor" => @font_color,
    "fontOpacity" => @font_opacity,
    "fontResolution" => @font_resolution,
    "fontSize" => @font_size,
    "outlineColor" => @outline_color,
    "outlineSize" => @outline_size,
    "shadowColor" => @shadow_color,
    "shadowOpacity" => @shadow_opacity,
    "shadowXOffset" => @shadow_x_offset,
    "shadowYOffset" => @shadow_y_offset,
    "subtitleRows" => @subtitle_rows,
    "teletextGridControl" => @teletext_grid_control,
    "xPosition" => @x_position,
    "yPosition" => @y_position,
  })
  result.compact
end