You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaConvert::Types::BurninDestinationSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

Note:

When making an API call, you may pass BurninDestinationSettings data as a hash:

{
  alignment: "CENTERED", # required, accepts CENTERED, LEFT
  background_color: "NONE", # accepts NONE, BLACK, WHITE
  background_opacity: 1,
  font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE
  font_opacity: 1, # required
  font_resolution: 1,
  font_size: 1,
  outline_color: "BLACK", # required, accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE
  outline_size: 1, # required
  shadow_color: "NONE", # accepts NONE, BLACK, WHITE
  shadow_opacity: 1,
  shadow_x_offset: 1,
  shadow_y_offset: 1,
  teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL
  x_position: 1,
  y_position: 1,
}

Burn-In Destination Settings.

Instance Attribute Summary collapse

Instance Attribute Details

#alignmentString

If no explicit x_position or y_position 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. 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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  include Aws::Structure
end

#background_opacityInteger

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

Returns:

  • (Integer)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  include Aws::Structure
end

#font_sizeInteger

A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Integer)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  include Aws::Structure
end

#shadow_opacityInteger

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

Returns:

  • (Integer)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  include Aws::Structure
end

#teletext_spacingString

Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.

Returns:

  • (String)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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 x_position is provided, the horizontal caption position will be 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 caption stream. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Integer)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  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 y_position is provided, the caption will be 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 caption stream. All burn-in and DVB-Sub font settings must match.

Returns:

  • (Integer)


913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 913

class BurninDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_size,
  :outline_color,
  :outline_size,
  :shadow_color,
  :shadow_opacity,
  :shadow_x_offset,
  :shadow_y_offset,
  :teletext_spacing,
  :x_position,
  :y_position)
  include Aws::Structure
end