Class: Aws::MediaConvert::Types::TtmlDestinationSettings

Inherits:

Struct

• Object
• Struct
• Aws::MediaConvert::Types::TtmlDestinationSettings

Defined in:

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

Overview

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #background_color ⇒ String

  Specify the color of the rectangle behind the captions.

• #background_opacity ⇒ Integer

  Specify the opacity of the background rectangle.

• #font_color ⇒ String

  Specify the color of the captions text.

• #font_opacity ⇒ Integer

  Specify the opacity of the captions.

• #font_size ⇒ Integer

  Specify the Font size in pixels.

• #font_style ⇒ String

  Specify the font style of the caption text.

• #font_weight ⇒ String

  Specify the font weight of the caption text.

• #style_passthrough ⇒ String

  Pass through style and position information from a TTML-like input source (TTML, IMSC, SMPTE-TT) to the TTML output.

• #text_decoration ⇒ String

  Specify the text decoration of the caption text.

Instance Attribute Details

#background_color ⇒ String

Specify the color of the rectangle behind the captions. If Style passthrough is set to enabled, leave blank or set to Auto to pass through the background color from your input captions. If Style passthrough is set to disabled, leave blank or set to Auto to use the default black.

Returns:

• (String)

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

class TtmlDestinationSettings < Struct.new(
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_size,
  :font_style,
  :font_weight,
  :style_passthrough,
  :text_decoration)
  SENSITIVE = []
  include Aws::Structure
end

#background_opacity ⇒ Integer

Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled and backgroundColor is set, leave blank to use a value of 255 (opaque).

Returns:

• (Integer)

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

class TtmlDestinationSettings < Struct.new(
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_size,
  :font_style,
  :font_weight,
  :style_passthrough,
  :text_decoration)
  SENSITIVE = []
  include Aws::Structure
end

#font_color ⇒ String

Specify the color of the captions text. If Style passthrough is set to enabled, leave blank or set to Auto to pass through the font color from your input captions. If Style passthrough is set to disabled, leave blank or set to Auto to use the default white.

Returns:

• (String)

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

class TtmlDestinationSettings < Struct.new(
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_size,
  :font_style,
  :font_weight,
  :style_passthrough,
  :text_decoration)
  SENSITIVE = []
  include Aws::Structure
end

#font_opacity ⇒ Integer

Specify the opacity of the captions. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the font opacity information in your input captions to your output captions. If Style passthrough is set to disabled and fontColor is set, leave blank to use a value of 255 (opaque).

Returns:

• (Integer)

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

class TtmlDestinationSettings < Struct.new(
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_size,
  :font_style,
  :font_weight,
  :style_passthrough,
  :text_decoration)
  SENSITIVE = []
  include Aws::Structure
end

#font_size ⇒ Integer

Specify the Font size in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.

Returns:

• (Integer)

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

class TtmlDestinationSettings < Struct.new(
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_size,
  :font_style,
  :font_weight,
  :style_passthrough,
  :text_decoration)
  SENSITIVE = []
  include Aws::Structure
end

#font_style ⇒ String

Specify the font style of the caption text. If Style passthrough is set to enabled, leave blank to pass through the font style from your input captions. If Style passthrough is set to disabled, leave blank to use the default normal style.

Returns:

• (String)

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

class TtmlDestinationSettings < Struct.new(
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_size,
  :font_style,
  :font_weight,
  :style_passthrough,
  :text_decoration)
  SENSITIVE = []
  include Aws::Structure
end

#font_weight ⇒ String

Specify the font weight of the caption text. If Style passthrough is set to enabled, leave blank to pass through the font weight from your input captions. If Style passthrough is set to disabled, leave blank to use the default normal weight.

Returns:

• (String)

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

class TtmlDestinationSettings < Struct.new(
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_size,
  :font_style,
  :font_weight,
  :style_passthrough,
  :text_decoration)
  SENSITIVE = []
  include Aws::Structure
end

#style_passthrough ⇒ String

Pass through style and position information from a TTML-like input source (TTML, IMSC, SMPTE-TT) to the TTML output.

Returns:

• (String)

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

class TtmlDestinationSettings < Struct.new(
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_size,
  :font_style,
  :font_weight,
  :style_passthrough,
  :text_decoration)
  SENSITIVE = []
  include Aws::Structure
end

#text_decoration ⇒ String

Specify the text decoration of the caption text. If Style passthrough is set to enabled, leave blank to pass through the text decoration from your input captions. If Style passthrough is set to disabled, leave blank to use the default of none.

Returns:

• (String)

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

class TtmlDestinationSettings < Struct.new(
  :background_color,
  :background_opacity,
  :font_color,
  :font_opacity,
  :font_size,
  :font_style,
  :font_weight,
  :style_passthrough,
  :text_decoration)
  SENSITIVE = []
  include Aws::Structure
end