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

Class: Aws::MediaConvert::Types::CaptionDestinationSettings

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 CaptionDestinationSettings data as a hash:

{
  burnin_destination_settings: {
    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,
  },
  destination_type: "BURN_IN", # accepts BURN_IN, DVB_SUB, EMBEDDED, EMBEDDED_PLUS_SCTE20, IMSC, SCTE20_PLUS_EMBEDDED, SCC, SRT, SMI, TELETEXT, TTML, WEBVTT
  dvb_sub_destination_settings: {
    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,
  },
  embedded_destination_settings: {
    destination_608_channel_number: 1,
    destination_708_service_number: 1,
  },
  imsc_destination_settings: {
    style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
  },
  scc_destination_settings: {
    framerate: "FRAMERATE_23_97", # accepts FRAMERATE_23_97, FRAMERATE_24, FRAMERATE_29_97_DROPFRAME, FRAMERATE_29_97_NON_DROPFRAME
  },
  teletext_destination_settings: {
    page_number: "__stringMin3Max3Pattern1809aFAF09aEAE",
    page_types: ["PAGE_TYPE_INITIAL"], # accepts PAGE_TYPE_INITIAL, PAGE_TYPE_SUBTITLE, PAGE_TYPE_ADDL_INFO, PAGE_TYPE_PROGRAM_SCHEDULE, PAGE_TYPE_HEARING_IMPAIRED_SUBTITLE
  },
  ttml_destination_settings: {
    style_passthrough: "ENABLED", # accepts ENABLED, DISABLED
  },
}

Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#burnin_destination_settings ⇒ Types::BurninDestinationSettings

Burn-In Destination Settings.

Returns:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1447

class CaptionDestinationSettings < Struct.new(
  :burnin_destination_settings,
  :destination_type,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :imsc_destination_settings,
  :scc_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings)
  include Aws::Structure
end

#destination_type ⇒ String

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

Returns:

  • (String) 


1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1447

class CaptionDestinationSettings < Struct.new(
  :burnin_destination_settings,
  :destination_type,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :imsc_destination_settings,
  :scc_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings)
  include Aws::Structure
end

#dvb_sub_destination_settings ⇒ Types::DvbSubDestinationSettings

DVB-Sub Destination Settings

Returns:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1447

class CaptionDestinationSettings < Struct.new(
  :burnin_destination_settings,
  :destination_type,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :imsc_destination_settings,
  :scc_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings)
  include Aws::Structure
end

#embedded_destination_settings ⇒ Types::EmbeddedDestinationSettings

Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.

Returns:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1447

class CaptionDestinationSettings < Struct.new(
  :burnin_destination_settings,
  :destination_type,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :imsc_destination_settings,
  :scc_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings)
  include Aws::Structure
end

#imsc_destination_settings ⇒ Types::ImscDestinationSettings

Settings specific to IMSC caption outputs.

Returns:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1447

class CaptionDestinationSettings < Struct.new(
  :burnin_destination_settings,
  :destination_type,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :imsc_destination_settings,
  :scc_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings)
  include Aws::Structure
end

#scc_destination_settings ⇒ Types::SccDestinationSettings

Settings for SCC caption output.

Returns:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1447

class CaptionDestinationSettings < Struct.new(
  :burnin_destination_settings,
  :destination_type,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :imsc_destination_settings,
  :scc_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings)
  include Aws::Structure
end

#teletext_destination_settings ⇒ Types::TeletextDestinationSettings

Settings for Teletext caption output

Returns:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1447

class CaptionDestinationSettings < Struct.new(
  :burnin_destination_settings,
  :destination_type,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :imsc_destination_settings,
  :scc_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings)
  include Aws::Structure
end

#ttml_destination_settings ⇒ Types::TtmlDestinationSettings

Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).

Returns:



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 1447

class CaptionDestinationSettings < Struct.new(
  :burnin_destination_settings,
  :destination_type,
  :dvb_sub_destination_settings,
  :embedded_destination_settings,
  :imsc_destination_settings,
  :scc_destination_settings,
  :teletext_destination_settings,
  :ttml_destination_settings)
  include Aws::Structure
end