Class: Aws::MediaLive::Types::BurnInDestinationSettings

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-medialive/types.rb

Overview

Burn In Destination Settings

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alignmentString

If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting “smart” justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#background_colorString

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#background_opacityInteger

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Returns:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#fontTypes::InputLocation

External font file used for caption burn-in. File extension must be ‘ttf’ or ‘tte’. Although the user 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 caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.



1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#font_colorString

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

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#font_opacityInteger

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:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#font_resolutionInteger

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#font_sizeString

When set to ‘auto’ fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#outline_colorString

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

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#outline_sizeInteger

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

Returns:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#shadow_colorString

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#shadow_opacityInteger

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Returns:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#shadow_x_offsetInteger

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:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#shadow_y_offsetInteger

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:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#teletext_grid_controlString

Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#x_positionInteger

Specifies the horizontal position of the caption 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 caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end

#y_positionInteger

Specifies the vertical position of the caption 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 caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'lib/aws-sdk-medialive/types.rb', line 1420

class BurnInDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_grid_control,
  :x_position,
  :y_position)
  SENSITIVE = []
  include Aws::Structure
end