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

Class: Aws::MediaLive::Types::CaptionDestinationSettings

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

Overview

Note:

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

{
  arib_destination_settings: {
  },
  burn_in_destination_settings: {
    alignment: "CENTERED", # accepts CENTERED, LEFT, SMART
    background_color: "BLACK", # accepts BLACK, NONE, WHITE
    background_opacity: 1,
    font: {
      password_param: "__string",
      uri: "__string", # required
      username: "__string",
    },
    font_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
    font_opacity: 1,
    font_resolution: 1,
    font_size: "__string",
    outline_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
    outline_size: 1,
    shadow_color: "BLACK", # accepts BLACK, NONE, WHITE
    shadow_opacity: 1,
    shadow_x_offset: 1,
    shadow_y_offset: 1,
    teletext_grid_control: "FIXED", # accepts FIXED, SCALED
    x_position: 1,
    y_position: 1,
  },
  dvb_sub_destination_settings: {
    alignment: "CENTERED", # accepts CENTERED, LEFT, SMART
    background_color: "BLACK", # accepts BLACK, NONE, WHITE
    background_opacity: 1,
    font: {
      password_param: "__string",
      uri: "__string", # required
      username: "__string",
    },
    font_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
    font_opacity: 1,
    font_resolution: 1,
    font_size: "__string",
    outline_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
    outline_size: 1,
    shadow_color: "BLACK", # accepts BLACK, NONE, WHITE
    shadow_opacity: 1,
    shadow_x_offset: 1,
    shadow_y_offset: 1,
    teletext_grid_control: "FIXED", # accepts FIXED, SCALED
    x_position: 1,
    y_position: 1,
  },
  embedded_destination_settings: {
  },
  embedded_plus_scte_20_destination_settings: {
  },
  rtmp_caption_info_destination_settings: {
  },
  scte_20_plus_embedded_destination_settings: {
  },
  scte_27_destination_settings: {
  },
  smpte_tt_destination_settings: {
  },
  teletext_destination_settings: {
  },
  ttml_destination_settings: {
    style_control: "PASSTHROUGH", # accepts PASSTHROUGH, USE_CONFIGURED
  },
  webvtt_destination_settings: {
  },
}

Caption Destination Settings

Instance Attribute Summary collapse

Instance Attribute Details

#arib_destination_settingsTypes::AribDestinationSettings

Arib Destination Settings

Returns:

  • (Types::AribDestinationSettings)


1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#burn_in_destination_settingsTypes::BurnInDestinationSettings

Burn In Destination Settings



1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#dvb_sub_destination_settingsTypes::DvbSubDestinationSettings

Dvb Sub Destination Settings



1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#embedded_destination_settingsTypes::EmbeddedDestinationSettings

Embedded Destination Settings

Returns:

  • (Types::EmbeddedDestinationSettings)


1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#embedded_plus_scte_20_destination_settingsTypes::EmbeddedPlusScte20DestinationSettings

Embedded Plus Scte20 Destination Settings

Returns:

  • (Types::EmbeddedPlusScte20DestinationSettings)


1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#rtmp_caption_info_destination_settingsTypes::RtmpCaptionInfoDestinationSettings

Rtmp Caption Info Destination Settings

Returns:

  • (Types::RtmpCaptionInfoDestinationSettings)


1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#scte_20_plus_embedded_destination_settingsTypes::Scte20PlusEmbeddedDestinationSettings

Scte20 Plus Embedded Destination Settings

Returns:

  • (Types::Scte20PlusEmbeddedDestinationSettings)


1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#scte_27_destination_settingsTypes::Scte27DestinationSettings

Scte27 Destination Settings

Returns:

  • (Types::Scte27DestinationSettings)


1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#smpte_tt_destination_settingsTypes::SmpteTtDestinationSettings

Smpte Tt Destination Settings

Returns:

  • (Types::SmpteTtDestinationSettings)


1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#teletext_destination_settingsTypes::TeletextDestinationSettings

Teletext Destination Settings

Returns:

  • (Types::TeletextDestinationSettings)


1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#ttml_destination_settingsTypes::TtmlDestinationSettings

Ttml Destination Settings



1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end

#webvtt_destination_settingsTypes::WebvttDestinationSettings

Webvtt Destination Settings

Returns:

  • (Types::WebvttDestinationSettings)


1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1792

class CaptionDestinationSettings < Struct.new(
  :arib_destination_settings,
  :burn_in_destination_settings,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :embedded_plus_scte_20_destination_settings,
  :rtmp_caption_info_destination_settings,
  :scte_20_plus_embedded_destination_settings,
  :scte_27_destination_settings,
  :smpte_tt_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings,
  :webvtt_destination_settings)
  include Aws::Structure
end