Class: AWSCDK::MediaLive::CfnChannel::BurnInDestinationSettingsProperty

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

Overview

The settings for burn-in 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) ⇒ BurnInDestinationSettingsProperty

Returns a new instance of BurnInDestinationSettingsProperty.

Parameters:

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

    If no explicit xPosition or yPosition is provided, setting 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 font outline size in pixels.

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

    Specifies the color of the shadow 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 that is relative to the captions in pixels.

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

    Specifies the vertical offset of the shadow that is 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.



3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
 
# File 'media_live/cfn_channel.rb', line 3047

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 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. All burn-in and DVB-Sub font settings must match.

Returns:

  • (String, nil)

See Also:



3092
3093
3094
 
# File 'media_live/cfn_channel.rb', line 3092

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:



3099
3100
3101
 
# File 'media_live/cfn_channel.rb', line 3099

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:



3106
3107
3108
 
# File 'media_live/cfn_channel.rb', line 3106

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:



3113
3114
3115
 
# File 'media_live/cfn_channel.rb', line 3113

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:



3120
3121
3122
 
# File 'media_live/cfn_channel.rb', line 3120

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:



3127
3128
3129
 
# File 'media_live/cfn_channel.rb', line 3127

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:



3134
3135
3136
 
# File 'media_live/cfn_channel.rb', line 3134

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:



3141
3142
3143
 
# File 'media_live/cfn_channel.rb', line 3141

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:



3148
3149
3150
 
# File 'media_live/cfn_channel.rb', line 3148

def outline_color
  @outline_color
end

#outline_size ⇒ Numeric? (readonly)

Specifies 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:



3155
3156
3157
 
# File 'media_live/cfn_channel.rb', line 3155

def outline_size
  @outline_size
end

#shadow_color ⇒ String? (readonly)

Specifies the color of the shadow cast by the captions.

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

Returns:

  • (String, nil)

See Also:



3162
3163
3164
 
# File 'media_live/cfn_channel.rb', line 3162

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:



3169
3170
3171
 
# File 'media_live/cfn_channel.rb', line 3169

def shadow_opacity
  @shadow_opacity
end

#shadow_x_offset ⇒ Numeric? (readonly)

Specifies the horizontal offset of the shadow that is 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:



3176
3177
3178
 
# File 'media_live/cfn_channel.rb', line 3176

def shadow_x_offset
  @shadow_x_offset
end

#shadow_y_offset ⇒ Numeric? (readonly)

Specifies the vertical offset of the shadow that is 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:



3183
3184
3185
 
# File 'media_live/cfn_channel.rb', line 3183

def shadow_y_offset
  @shadow_y_offset
end

#subtitle_rows ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



3186
3187
3188
 
# File 'media_live/cfn_channel.rb', line 3186

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 only to Teletext inputs and DVB-Sub/Burn-in outputs.

Returns:

  • (String, nil)

See Also:



3193
3194
3195
 
# File 'media_live/cfn_channel.rb', line 3193

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. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



3200
3201
3202
 
# File 'media_live/cfn_channel.rb', line 3200

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. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Numeric, nil)

See Also:



3207
3208
3209
 
# File 'media_live/cfn_channel.rb', line 3207

def y_position
  @y_position
end

Class Method Details

.jsii_properties ⇒ Object 



3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
 
# File 'media_live/cfn_channel.rb', line 3209

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 



3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
 
# File 'media_live/cfn_channel.rb', line 3232

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