Class: AWSCDK::MediaLive::CfnChannel::EbuTtDDestinationSettingsProperty

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

Overview

Settings for EBU-TT 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(copyright_holder: nil, default_font_size: nil, default_line_height: nil, fill_line_gap: nil, font_family: nil, style_control: nil) ⇒ EbuTtDDestinationSettingsProperty

Returns a new instance of EbuTtDDestinationSettingsProperty.

Parameters:

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

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

  • default_font_size (Numeric, nil) (defaults to: nil)
  • default_line_height (Numeric, nil) (defaults to: nil)
  • fill_line_gap (String, nil) (defaults to: nil) —

    Specifies how to handle the gap between the lines (in multi-line captions).

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

    Specifies the font family to include in the font data attached to the EBU-TT captions.

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

    Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions.



5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
 
# File 'media_live/cfn_channel.rb', line 5035

def initialize(copyright_holder: nil, default_font_size: nil, default_line_height: nil, fill_line_gap: nil, font_family: nil, style_control: nil)
  @copyright_holder = copyright_holder
  Jsii::Type.check_type(@copyright_holder, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "copyrightHolder") unless @copyright_holder.nil?
  @default_font_size = default_font_size
  Jsii::Type.check_type(@default_font_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "defaultFontSize") unless @default_font_size.nil?
  @default_line_height = default_line_height
  Jsii::Type.check_type(@default_line_height, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "defaultLineHeight") unless @default_line_height.nil?
  @fill_line_gap = fill_line_gap
  Jsii::Type.check_type(@fill_line_gap, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fillLineGap") unless @fill_line_gap.nil?
  @font_family = font_family
  Jsii::Type.check_type(@font_family, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fontFamily") unless @font_family.nil?
  @style_control = style_control
  Jsii::Type.check_type(@style_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "styleControl") unless @style_control.nil?
end

Instance Attribute Details

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

Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML

Returns:

  • (String, nil)

See Also:



5056
5057
5058
 
# File 'media_live/cfn_channel.rb', line 5056

def copyright_holder
  @copyright_holder
end

#default_font_size ⇒ Numeric? (readonly)

Returns:

  • (Numeric, nil)

See Also:



5059
5060
5061
 
# File 'media_live/cfn_channel.rb', line 5059

def default_font_size
  @default_font_size
end

#default_line_height ⇒ Numeric? (readonly)

Returns:

  • (Numeric, nil)

See Also:



5062
5063
5064
 
# File 'media_live/cfn_channel.rb', line 5062

def default_line_height
  @default_line_height
end

#fill_line_gap ⇒ String? (readonly)

Specifies how to handle the gap between the lines (in multi-line captions).

  • enabled: Fill with the captions background color (as specified in the input captions).
  • disabled: Leave the gap unfilled.

Returns:

  • (String, nil)

See Also:



5070
5071
5072
 
# File 'media_live/cfn_channel.rb', line 5070

def fill_line_gap
  @fill_line_gap
end

#font_family ⇒ String? (readonly)

Specifies the font family to include in the font data attached to the EBU-TT captions.

Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font).

  • Leave blank to set the family to “monospace”.

Returns:

  • (String, nil)

See Also:



5079
5080
5081
 
# File 'media_live/cfn_channel.rb', line 5079

def font_family
  @font_family
end

#style_control ⇒ String? (readonly)

Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions.

  • include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext.
  • exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information.

Returns:

  • (String, nil)

See Also:



5087
5088
5089
 
# File 'media_live/cfn_channel.rb', line 5087

def style_control
  @style_control
end

Class Method Details

.jsii_properties ⇒ Object 



5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
 
# File 'media_live/cfn_channel.rb', line 5089

def self.jsii_properties
  {
    :copyright_holder => "copyrightHolder",
    :default_font_size => "defaultFontSize",
    :default_line_height => "defaultLineHeight",
    :fill_line_gap => "fillLineGap",
    :font_family => "fontFamily",
    :style_control => "styleControl",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
 
# File 'media_live/cfn_channel.rb', line 5100

def to_jsii
  result = {}
  result.merge!({
    "copyrightHolder" => @copyright_holder,
    "defaultFontSize" => @default_font_size,
    "defaultLineHeight" => @default_line_height,
    "fillLineGap" => @fill_line_gap,
    "fontFamily" => @font_family,
    "styleControl" => @style_control,
  })
  result.compact
end