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

Class: Aws::MediaConvert::Types::DvbSubDestinationSettings

Inherits:

Struct

• Object
• Struct
• Aws::MediaConvert::Types::DvbSubDestinationSettings

Defined in:

gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

Note:

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

{
  alignment: "CENTERED", # 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,
  font_resolution: 1,
  font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
  font_size: 1,
  outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE
  outline_size: 1,
  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,
}

DVB-Sub Destination Settings

See Also:

• AWS API Documentation

Instance Attribute Summary

• #alignment ⇒ String

  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.

• #background_color ⇒ String

  Specifies the color of the rectangle behind the captions.

• #background_opacity ⇒ Integer

  Specifies the opacity of the background rectangle.

• #font_color ⇒ String

  Specifies the color of the burned-in captions.

• #font_opacity ⇒ Integer

  Specifies the opacity of the burned-in captions.

• #font_resolution ⇒ Integer

  Font resolution in DPI (dots per inch); default is 96 dpi.

• #font_script ⇒ String

  Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type.

• #font_size ⇒ Integer

  A positive integer indicates the exact font size in points.

• #outline_color ⇒ String

  Specifies font outline color.

• #outline_size ⇒ Integer

  Specifies font outline size in pixels.

• #shadow_color ⇒ String

  Specifies the color of the shadow cast by the captions.

• #shadow_opacity ⇒ Integer

  Specifies the opacity of the shadow.

• #shadow_x_offset ⇒ Integer

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

• #shadow_y_offset ⇒ Integer

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

• #teletext_spacing ⇒ String

  Only applies to jobs with input captions in Teletext or STL formats.

• #x_position ⇒ Integer

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

• #y_position ⇒ Integer

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

Instance Attribute Details

#alignment ⇒ String

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_color ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_opacity ⇒ Integer

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_color ⇒ String

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_opacity ⇒ Integer

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_resolution ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_script ⇒ String

Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions.

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_size ⇒ Integer

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_color ⇒ String

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_size ⇒ Integer

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_color ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_opacity ⇒ Integer

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_offset ⇒ Integer

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_offset ⇒ Integer

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_spacing ⇒ String

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_position ⇒ Integer

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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_position ⇒ Integer

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)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 5391

class DvbSubDestinationSettings < Struct.new(
  :alignment,
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_resolution,
  :font_script,
  :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