AWS SDK for C++  1.9.67
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaConvert::Model::DvbSubDestinationSettings Class Reference

#include <DvbSubDestinationSettings.h>

Public Member Functions

 DvbSubDestinationSettings ()
 
 DvbSubDestinationSettings (Aws::Utils::Json::JsonView jsonValue)
 
DvbSubDestinationSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const DvbSubtitleAlignmentGetAlignment () const
 
bool AlignmentHasBeenSet () const
 
void SetAlignment (const DvbSubtitleAlignment &value)
 
void SetAlignment (DvbSubtitleAlignment &&value)
 
DvbSubDestinationSettingsWithAlignment (const DvbSubtitleAlignment &value)
 
DvbSubDestinationSettingsWithAlignment (DvbSubtitleAlignment &&value)
 
const DvbSubtitleBackgroundColorGetBackgroundColor () const
 
bool BackgroundColorHasBeenSet () const
 
void SetBackgroundColor (const DvbSubtitleBackgroundColor &value)
 
void SetBackgroundColor (DvbSubtitleBackgroundColor &&value)
 
DvbSubDestinationSettingsWithBackgroundColor (const DvbSubtitleBackgroundColor &value)
 
DvbSubDestinationSettingsWithBackgroundColor (DvbSubtitleBackgroundColor &&value)
 
int GetBackgroundOpacity () const
 
bool BackgroundOpacityHasBeenSet () const
 
void SetBackgroundOpacity (int value)
 
DvbSubDestinationSettingsWithBackgroundOpacity (int value)
 
const DvbddsHandlingGetDdsHandling () const
 
bool DdsHandlingHasBeenSet () const
 
void SetDdsHandling (const DvbddsHandling &value)
 
void SetDdsHandling (DvbddsHandling &&value)
 
DvbSubDestinationSettingsWithDdsHandling (const DvbddsHandling &value)
 
DvbSubDestinationSettingsWithDdsHandling (DvbddsHandling &&value)
 
int GetDdsXCoordinate () const
 
bool DdsXCoordinateHasBeenSet () const
 
void SetDdsXCoordinate (int value)
 
DvbSubDestinationSettingsWithDdsXCoordinate (int value)
 
int GetDdsYCoordinate () const
 
bool DdsYCoordinateHasBeenSet () const
 
void SetDdsYCoordinate (int value)
 
DvbSubDestinationSettingsWithDdsYCoordinate (int value)
 
const DvbSubtitleFontColorGetFontColor () const
 
bool FontColorHasBeenSet () const
 
void SetFontColor (const DvbSubtitleFontColor &value)
 
void SetFontColor (DvbSubtitleFontColor &&value)
 
DvbSubDestinationSettingsWithFontColor (const DvbSubtitleFontColor &value)
 
DvbSubDestinationSettingsWithFontColor (DvbSubtitleFontColor &&value)
 
int GetFontOpacity () const
 
bool FontOpacityHasBeenSet () const
 
void SetFontOpacity (int value)
 
DvbSubDestinationSettingsWithFontOpacity (int value)
 
int GetFontResolution () const
 
bool FontResolutionHasBeenSet () const
 
void SetFontResolution (int value)
 
DvbSubDestinationSettingsWithFontResolution (int value)
 
const FontScriptGetFontScript () const
 
bool FontScriptHasBeenSet () const
 
void SetFontScript (const FontScript &value)
 
void SetFontScript (FontScript &&value)
 
DvbSubDestinationSettingsWithFontScript (const FontScript &value)
 
DvbSubDestinationSettingsWithFontScript (FontScript &&value)
 
int GetFontSize () const
 
bool FontSizeHasBeenSet () const
 
void SetFontSize (int value)
 
DvbSubDestinationSettingsWithFontSize (int value)
 
int GetHeight () const
 
bool HeightHasBeenSet () const
 
void SetHeight (int value)
 
DvbSubDestinationSettingsWithHeight (int value)
 
const DvbSubtitleOutlineColorGetOutlineColor () const
 
bool OutlineColorHasBeenSet () const
 
void SetOutlineColor (const DvbSubtitleOutlineColor &value)
 
void SetOutlineColor (DvbSubtitleOutlineColor &&value)
 
DvbSubDestinationSettingsWithOutlineColor (const DvbSubtitleOutlineColor &value)
 
DvbSubDestinationSettingsWithOutlineColor (DvbSubtitleOutlineColor &&value)
 
int GetOutlineSize () const
 
bool OutlineSizeHasBeenSet () const
 
void SetOutlineSize (int value)
 
DvbSubDestinationSettingsWithOutlineSize (int value)
 
const DvbSubtitleShadowColorGetShadowColor () const
 
bool ShadowColorHasBeenSet () const
 
void SetShadowColor (const DvbSubtitleShadowColor &value)
 
void SetShadowColor (DvbSubtitleShadowColor &&value)
 
DvbSubDestinationSettingsWithShadowColor (const DvbSubtitleShadowColor &value)
 
DvbSubDestinationSettingsWithShadowColor (DvbSubtitleShadowColor &&value)
 
int GetShadowOpacity () const
 
bool ShadowOpacityHasBeenSet () const
 
void SetShadowOpacity (int value)
 
DvbSubDestinationSettingsWithShadowOpacity (int value)
 
int GetShadowXOffset () const
 
bool ShadowXOffsetHasBeenSet () const
 
void SetShadowXOffset (int value)
 
DvbSubDestinationSettingsWithShadowXOffset (int value)
 
int GetShadowYOffset () const
 
bool ShadowYOffsetHasBeenSet () const
 
void SetShadowYOffset (int value)
 
DvbSubDestinationSettingsWithShadowYOffset (int value)
 
const DvbSubtitlingTypeGetSubtitlingType () const
 
bool SubtitlingTypeHasBeenSet () const
 
void SetSubtitlingType (const DvbSubtitlingType &value)
 
void SetSubtitlingType (DvbSubtitlingType &&value)
 
DvbSubDestinationSettingsWithSubtitlingType (const DvbSubtitlingType &value)
 
DvbSubDestinationSettingsWithSubtitlingType (DvbSubtitlingType &&value)
 
const DvbSubtitleTeletextSpacingGetTeletextSpacing () const
 
bool TeletextSpacingHasBeenSet () const
 
void SetTeletextSpacing (const DvbSubtitleTeletextSpacing &value)
 
void SetTeletextSpacing (DvbSubtitleTeletextSpacing &&value)
 
DvbSubDestinationSettingsWithTeletextSpacing (const DvbSubtitleTeletextSpacing &value)
 
DvbSubDestinationSettingsWithTeletextSpacing (DvbSubtitleTeletextSpacing &&value)
 
int GetWidth () const
 
bool WidthHasBeenSet () const
 
void SetWidth (int value)
 
DvbSubDestinationSettingsWithWidth (int value)
 
int GetXPosition () const
 
bool XPositionHasBeenSet () const
 
void SetXPosition (int value)
 
DvbSubDestinationSettingsWithXPosition (int value)
 
int GetYPosition () const
 
bool YPositionHasBeenSet () const
 
void SetYPosition (int value)
 
DvbSubDestinationSettingsWithYPosition (int value)
 

Detailed Description

Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.

See Also:

AWS API Reference

Definition at line 44 of file DvbSubDestinationSettings.h.

Constructor & Destructor Documentation

◆ DvbSubDestinationSettings() [1/2]

Aws::MediaConvert::Model::DvbSubDestinationSettings::DvbSubDestinationSettings ( )

◆ DvbSubDestinationSettings() [2/2]

Aws::MediaConvert::Model::DvbSubDestinationSettings::DvbSubDestinationSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AlignmentHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::AlignmentHasBeenSet ( ) const
inline

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.

Definition at line 75 of file DvbSubDestinationSettings.h.

◆ BackgroundColorHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::BackgroundColorHasBeenSet ( ) const
inline
   Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 138 of file DvbSubDestinationSettings.h.

◆ BackgroundOpacityHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::BackgroundOpacityHasBeenSet ( ) const
inline

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.

Definition at line 181 of file DvbSubDestinationSettings.h.

◆ DdsHandlingHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::DdsHandlingHasBeenSet ( ) const
inline

Specify how MediaConvert handles the display definition segment (DDS). Keep the default, None (NONE), to exclude the DDS from this set of captions. Choose No display window (NO_DISPLAY_WINDOW) to have MediaConvert include the DDS but not include display window data. In this case, MediaConvert writes that information to the page composition segment (PCS) instead. Choose Specify (SPECIFIED) to have MediaConvert set up the display window based on the values that you specify in related job settings. For video resolutions that are 576 pixels or smaller in height, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling (ddsHandling). In this case, it doesn't write the display window data to the PCS either. Related settings: Use the settings DDS x-coordinate (ddsXCoordinate) and DDS y-coordinate (ddsYCoordinate) to specify the offset between the top left corner of the display window and the top left corner of the video frame. All burn-in and DVB-Sub font settings must match.

Definition at line 230 of file DvbSubDestinationSettings.h.

◆ DdsXCoordinateHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::DdsXCoordinateHasBeenSet ( ) const
inline

Use this setting, along with DDS y-coordinate (ddsYCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the left side of the frame and the left side of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.

Definition at line 325 of file DvbSubDestinationSettings.h.

◆ DdsYCoordinateHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::DdsYCoordinateHasBeenSet ( ) const
inline

Use this setting, along with DDS x-coordinate (ddsXCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the top of the frame and the top of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.

Definition at line 378 of file DvbSubDestinationSettings.h.

◆ FontColorHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::FontColorHasBeenSet ( ) const
inline

Specifies the color of the DVB-SUB 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.

Definition at line 421 of file DvbSubDestinationSettings.h.

◆ FontOpacityHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::FontOpacityHasBeenSet ( ) const
inline
   Specifies the opacity of the burned-in captions. 255 is opaque; 0 is
   transparent.

All burn-in and DVB-Sub font settings must match.

Definition at line 468 of file DvbSubDestinationSettings.h.

◆ FontResolutionHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::FontResolutionHasBeenSet ( ) const
inline
   Font resolution in DPI (dots per inch); default is 96 dpi.

All burn-in and DVB-Sub font settings must match.

Definition at line 497 of file DvbSubDestinationSettings.h.

◆ FontScriptHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::FontScriptHasBeenSet ( ) const
inline

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.

Definition at line 528 of file DvbSubDestinationSettings.h.

◆ FontSizeHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::FontSizeHasBeenSet ( ) const
inline

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.

Definition at line 573 of file DvbSubDestinationSettings.h.

◆ GetAlignment()

const DvbSubtitleAlignment& Aws::MediaConvert::Model::DvbSubDestinationSettings::GetAlignment ( ) const
inline

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.

Definition at line 63 of file DvbSubDestinationSettings.h.

◆ GetBackgroundColor()

const DvbSubtitleBackgroundColor& Aws::MediaConvert::Model::DvbSubDestinationSettings::GetBackgroundColor ( ) const
inline
   Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 131 of file DvbSubDestinationSettings.h.

◆ GetBackgroundOpacity()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetBackgroundOpacity ( ) const
inline

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.

Definition at line 174 of file DvbSubDestinationSettings.h.

◆ GetDdsHandling()

const DvbddsHandling& Aws::MediaConvert::Model::DvbSubDestinationSettings::GetDdsHandling ( ) const
inline

Specify how MediaConvert handles the display definition segment (DDS). Keep the default, None (NONE), to exclude the DDS from this set of captions. Choose No display window (NO_DISPLAY_WINDOW) to have MediaConvert include the DDS but not include display window data. In this case, MediaConvert writes that information to the page composition segment (PCS) instead. Choose Specify (SPECIFIED) to have MediaConvert set up the display window based on the values that you specify in related job settings. For video resolutions that are 576 pixels or smaller in height, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling (ddsHandling). In this case, it doesn't write the display window data to the PCS either. Related settings: Use the settings DDS x-coordinate (ddsXCoordinate) and DDS y-coordinate (ddsYCoordinate) to specify the offset between the top left corner of the display window and the top left corner of the video frame. All burn-in and DVB-Sub font settings must match.

Definition at line 213 of file DvbSubDestinationSettings.h.

◆ GetDdsXCoordinate()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetDdsXCoordinate ( ) const
inline

Use this setting, along with DDS y-coordinate (ddsYCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the left side of the frame and the left side of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.

Definition at line 312 of file DvbSubDestinationSettings.h.

◆ GetDdsYCoordinate()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetDdsYCoordinate ( ) const
inline

Use this setting, along with DDS x-coordinate (ddsXCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the top of the frame and the top of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.

Definition at line 365 of file DvbSubDestinationSettings.h.

◆ GetFontColor()

const DvbSubtitleFontColor& Aws::MediaConvert::Model::DvbSubDestinationSettings::GetFontColor ( ) const
inline

Specifies the color of the DVB-SUB 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.

Definition at line 413 of file DvbSubDestinationSettings.h.

◆ GetFontOpacity()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetFontOpacity ( ) const
inline
   Specifies the opacity of the burned-in captions. 255 is opaque; 0 is
   transparent.

All burn-in and DVB-Sub font settings must match.

Definition at line 461 of file DvbSubDestinationSettings.h.

◆ GetFontResolution()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetFontResolution ( ) const
inline
   Font resolution in DPI (dots per inch); default is 96 dpi.

All burn-in and DVB-Sub font settings must match.

Definition at line 490 of file DvbSubDestinationSettings.h.

◆ GetFontScript()

const FontScript& Aws::MediaConvert::Model::DvbSubDestinationSettings::GetFontScript ( ) const
inline

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.

Definition at line 520 of file DvbSubDestinationSettings.h.

◆ GetFontSize()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetFontSize ( ) const
inline

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.

Definition at line 567 of file DvbSubDestinationSettings.h.

◆ GetHeight()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetHeight ( ) const
inline

Specify the height, in pixels, of this set of DVB-Sub captions. The default value is 576 pixels. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match.

Definition at line 594 of file DvbSubDestinationSettings.h.

◆ GetOutlineColor()

const DvbSubtitleOutlineColor& Aws::MediaConvert::Model::DvbSubDestinationSettings::GetOutlineColor ( ) const
inline

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.

Definition at line 627 of file DvbSubDestinationSettings.h.

◆ GetOutlineSize()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetOutlineSize ( ) const
inline

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.

Definition at line 676 of file DvbSubDestinationSettings.h.

◆ GetShadowColor()

const DvbSubtitleShadowColor& Aws::MediaConvert::Model::DvbSubDestinationSettings::GetShadowColor ( ) const
inline
   Specifies the color of the shadow cast by the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 708 of file DvbSubDestinationSettings.h.

◆ GetShadowOpacity()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetShadowOpacity ( ) const
inline

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.

Definition at line 751 of file DvbSubDestinationSettings.h.

◆ GetShadowXOffset()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetShadowXOffset ( ) const
inline

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.

Definition at line 780 of file DvbSubDestinationSettings.h.

◆ GetShadowYOffset()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetShadowYOffset ( ) const
inline

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.

Definition at line 809 of file DvbSubDestinationSettings.h.

◆ GetSubtitlingType()

const DvbSubtitlingType& Aws::MediaConvert::Model::DvbSubDestinationSettings::GetSubtitlingType ( ) const
inline

Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.

Definition at line 838 of file DvbSubDestinationSettings.h.

◆ GetTeletextSpacing()

const DvbSubtitleTeletextSpacing& Aws::MediaConvert::Model::DvbSubDestinationSettings::GetTeletextSpacing ( ) const
inline

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.

Definition at line 883 of file DvbSubDestinationSettings.h.

◆ GetWidth()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetWidth ( ) const
inline

Specify the width, in pixels, of this set of DVB-Sub captions. The default value is 720 pixels. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match.

Definition at line 937 of file DvbSubDestinationSettings.h.

◆ GetXPosition()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetXPosition ( ) const
inline

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.

Definition at line 973 of file DvbSubDestinationSettings.h.

◆ GetYPosition()

int Aws::MediaConvert::Model::DvbSubDestinationSettings::GetYPosition ( ) const
inline

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.

Definition at line 1018 of file DvbSubDestinationSettings.h.

◆ HeightHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::HeightHasBeenSet ( ) const
inline

Specify the height, in pixels, of this set of DVB-Sub captions. The default value is 576 pixels. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match.

Definition at line 602 of file DvbSubDestinationSettings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::DvbSubDestinationSettings::Jsonize ( ) const

◆ operator=()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutlineColorHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::OutlineColorHasBeenSet ( ) const
inline

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.

Definition at line 635 of file DvbSubDestinationSettings.h.

◆ OutlineSizeHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::OutlineSizeHasBeenSet ( ) const
inline

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.

Definition at line 684 of file DvbSubDestinationSettings.h.

◆ SetAlignment() [1/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetAlignment ( const DvbSubtitleAlignment value)
inline

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.

Definition at line 87 of file DvbSubDestinationSettings.h.

◆ SetAlignment() [2/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetAlignment ( DvbSubtitleAlignment &&  value)
inline

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.

Definition at line 99 of file DvbSubDestinationSettings.h.

◆ SetBackgroundColor() [1/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetBackgroundColor ( const DvbSubtitleBackgroundColor value)
inline
   Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 145 of file DvbSubDestinationSettings.h.

◆ SetBackgroundColor() [2/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetBackgroundColor ( DvbSubtitleBackgroundColor &&  value)
inline
   Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 152 of file DvbSubDestinationSettings.h.

◆ SetBackgroundOpacity()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetBackgroundOpacity ( int  value)
inline

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.

Definition at line 188 of file DvbSubDestinationSettings.h.

◆ SetDdsHandling() [1/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetDdsHandling ( const DvbddsHandling value)
inline

Specify how MediaConvert handles the display definition segment (DDS). Keep the default, None (NONE), to exclude the DDS from this set of captions. Choose No display window (NO_DISPLAY_WINDOW) to have MediaConvert include the DDS but not include display window data. In this case, MediaConvert writes that information to the page composition segment (PCS) instead. Choose Specify (SPECIFIED) to have MediaConvert set up the display window based on the values that you specify in related job settings. For video resolutions that are 576 pixels or smaller in height, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling (ddsHandling). In this case, it doesn't write the display window data to the PCS either. Related settings: Use the settings DDS x-coordinate (ddsXCoordinate) and DDS y-coordinate (ddsYCoordinate) to specify the offset between the top left corner of the display window and the top left corner of the video frame. All burn-in and DVB-Sub font settings must match.

Definition at line 247 of file DvbSubDestinationSettings.h.

◆ SetDdsHandling() [2/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetDdsHandling ( DvbddsHandling &&  value)
inline

Specify how MediaConvert handles the display definition segment (DDS). Keep the default, None (NONE), to exclude the DDS from this set of captions. Choose No display window (NO_DISPLAY_WINDOW) to have MediaConvert include the DDS but not include display window data. In this case, MediaConvert writes that information to the page composition segment (PCS) instead. Choose Specify (SPECIFIED) to have MediaConvert set up the display window based on the values that you specify in related job settings. For video resolutions that are 576 pixels or smaller in height, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling (ddsHandling). In this case, it doesn't write the display window data to the PCS either. Related settings: Use the settings DDS x-coordinate (ddsXCoordinate) and DDS y-coordinate (ddsYCoordinate) to specify the offset between the top left corner of the display window and the top left corner of the video frame. All burn-in and DVB-Sub font settings must match.

Definition at line 264 of file DvbSubDestinationSettings.h.

◆ SetDdsXCoordinate()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetDdsXCoordinate ( int  value)
inline

Use this setting, along with DDS y-coordinate (ddsYCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the left side of the frame and the left side of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.

Definition at line 338 of file DvbSubDestinationSettings.h.

◆ SetDdsYCoordinate()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetDdsYCoordinate ( int  value)
inline

Use this setting, along with DDS x-coordinate (ddsXCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the top of the frame and the top of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.

Definition at line 391 of file DvbSubDestinationSettings.h.

◆ SetFontColor() [1/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetFontColor ( const DvbSubtitleFontColor value)
inline

Specifies the color of the DVB-SUB 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.

Definition at line 429 of file DvbSubDestinationSettings.h.

◆ SetFontColor() [2/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetFontColor ( DvbSubtitleFontColor &&  value)
inline

Specifies the color of the DVB-SUB 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.

Definition at line 437 of file DvbSubDestinationSettings.h.

◆ SetFontOpacity()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetFontOpacity ( int  value)
inline
   Specifies the opacity of the burned-in captions. 255 is opaque; 0 is
   transparent.

All burn-in and DVB-Sub font settings must match.

Definition at line 475 of file DvbSubDestinationSettings.h.

◆ SetFontResolution()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetFontResolution ( int  value)
inline
   Font resolution in DPI (dots per inch); default is 96 dpi.

All burn-in and DVB-Sub font settings must match.

Definition at line 504 of file DvbSubDestinationSettings.h.

◆ SetFontScript() [1/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetFontScript ( const FontScript value)
inline

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.

Definition at line 536 of file DvbSubDestinationSettings.h.

◆ SetFontScript() [2/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetFontScript ( FontScript &&  value)
inline

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.

Definition at line 544 of file DvbSubDestinationSettings.h.

◆ SetFontSize()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetFontSize ( int  value)
inline

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.

Definition at line 579 of file DvbSubDestinationSettings.h.

◆ SetHeight()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetHeight ( int  value)
inline

Specify the height, in pixels, of this set of DVB-Sub captions. The default value is 576 pixels. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match.

Definition at line 610 of file DvbSubDestinationSettings.h.

◆ SetOutlineColor() [1/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetOutlineColor ( const DvbSubtitleOutlineColor value)
inline

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.

Definition at line 643 of file DvbSubDestinationSettings.h.

◆ SetOutlineColor() [2/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetOutlineColor ( DvbSubtitleOutlineColor &&  value)
inline

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.

Definition at line 651 of file DvbSubDestinationSettings.h.

◆ SetOutlineSize()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetOutlineSize ( int  value)
inline

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.

Definition at line 692 of file DvbSubDestinationSettings.h.

◆ SetShadowColor() [1/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetShadowColor ( const DvbSubtitleShadowColor value)
inline
   Specifies the color of the shadow cast by the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 722 of file DvbSubDestinationSettings.h.

◆ SetShadowColor() [2/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetShadowColor ( DvbSubtitleShadowColor &&  value)
inline
   Specifies the color of the shadow cast by the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 729 of file DvbSubDestinationSettings.h.

◆ SetShadowOpacity()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetShadowOpacity ( int  value)
inline

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.

Definition at line 765 of file DvbSubDestinationSettings.h.

◆ SetShadowXOffset()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetShadowXOffset ( int  value)
inline

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.

Definition at line 794 of file DvbSubDestinationSettings.h.

◆ SetShadowYOffset()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetShadowYOffset ( int  value)
inline

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.

Definition at line 823 of file DvbSubDestinationSettings.h.

◆ SetSubtitlingType() [1/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetSubtitlingType ( const DvbSubtitlingType value)
inline

Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.

Definition at line 852 of file DvbSubDestinationSettings.h.

◆ SetSubtitlingType() [2/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetSubtitlingType ( DvbSubtitlingType &&  value)
inline

Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.

Definition at line 859 of file DvbSubDestinationSettings.h.

◆ SetTeletextSpacing() [1/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetTeletextSpacing ( const DvbSubtitleTeletextSpacing value)
inline

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.

Definition at line 901 of file DvbSubDestinationSettings.h.

◆ SetTeletextSpacing() [2/2]

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetTeletextSpacing ( DvbSubtitleTeletextSpacing &&  value)
inline

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.

Definition at line 910 of file DvbSubDestinationSettings.h.

◆ SetWidth()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetWidth ( int  value)
inline

Specify the width, in pixels, of this set of DVB-Sub captions. The default value is 720 pixels. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match.

Definition at line 953 of file DvbSubDestinationSettings.h.

◆ SetXPosition()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetXPosition ( int  value)
inline

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.

Definition at line 995 of file DvbSubDestinationSettings.h.

◆ SetYPosition()

void Aws::MediaConvert::Model::DvbSubDestinationSettings::SetYPosition ( int  value)
inline

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.

Definition at line 1040 of file DvbSubDestinationSettings.h.

◆ ShadowColorHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::ShadowColorHasBeenSet ( ) const
inline
   Specifies the color of the shadow cast by the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 715 of file DvbSubDestinationSettings.h.

◆ ShadowOpacityHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::ShadowOpacityHasBeenSet ( ) const
inline

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.

Definition at line 758 of file DvbSubDestinationSettings.h.

◆ ShadowXOffsetHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::ShadowXOffsetHasBeenSet ( ) const
inline

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.

Definition at line 787 of file DvbSubDestinationSettings.h.

◆ ShadowYOffsetHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::ShadowYOffsetHasBeenSet ( ) const
inline

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.

Definition at line 816 of file DvbSubDestinationSettings.h.

◆ SubtitlingTypeHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::SubtitlingTypeHasBeenSet ( ) const
inline

Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.

Definition at line 845 of file DvbSubDestinationSettings.h.

◆ TeletextSpacingHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::TeletextSpacingHasBeenSet ( ) const
inline

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.

Definition at line 892 of file DvbSubDestinationSettings.h.

◆ WidthHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::WidthHasBeenSet ( ) const
inline

Specify the width, in pixels, of this set of DVB-Sub captions. The default value is 720 pixels. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match.

Definition at line 945 of file DvbSubDestinationSettings.h.

◆ WithAlignment() [1/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithAlignment ( const DvbSubtitleAlignment value)
inline

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.

Definition at line 111 of file DvbSubDestinationSettings.h.

◆ WithAlignment() [2/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithAlignment ( DvbSubtitleAlignment &&  value)
inline

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.

Definition at line 123 of file DvbSubDestinationSettings.h.

◆ WithBackgroundColor() [1/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithBackgroundColor ( const DvbSubtitleBackgroundColor value)
inline
   Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 159 of file DvbSubDestinationSettings.h.

◆ WithBackgroundColor() [2/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithBackgroundColor ( DvbSubtitleBackgroundColor &&  value)
inline
   Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 166 of file DvbSubDestinationSettings.h.

◆ WithBackgroundOpacity()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithBackgroundOpacity ( int  value)
inline

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.

Definition at line 195 of file DvbSubDestinationSettings.h.

◆ WithDdsHandling() [1/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithDdsHandling ( const DvbddsHandling value)
inline

Specify how MediaConvert handles the display definition segment (DDS). Keep the default, None (NONE), to exclude the DDS from this set of captions. Choose No display window (NO_DISPLAY_WINDOW) to have MediaConvert include the DDS but not include display window data. In this case, MediaConvert writes that information to the page composition segment (PCS) instead. Choose Specify (SPECIFIED) to have MediaConvert set up the display window based on the values that you specify in related job settings. For video resolutions that are 576 pixels or smaller in height, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling (ddsHandling). In this case, it doesn't write the display window data to the PCS either. Related settings: Use the settings DDS x-coordinate (ddsXCoordinate) and DDS y-coordinate (ddsYCoordinate) to specify the offset between the top left corner of the display window and the top left corner of the video frame. All burn-in and DVB-Sub font settings must match.

Definition at line 281 of file DvbSubDestinationSettings.h.

◆ WithDdsHandling() [2/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithDdsHandling ( DvbddsHandling &&  value)
inline

Specify how MediaConvert handles the display definition segment (DDS). Keep the default, None (NONE), to exclude the DDS from this set of captions. Choose No display window (NO_DISPLAY_WINDOW) to have MediaConvert include the DDS but not include display window data. In this case, MediaConvert writes that information to the page composition segment (PCS) instead. Choose Specify (SPECIFIED) to have MediaConvert set up the display window based on the values that you specify in related job settings. For video resolutions that are 576 pixels or smaller in height, MediaConvert doesn't include the DDS, regardless of the value you choose for DDS handling (ddsHandling). In this case, it doesn't write the display window data to the PCS either. Related settings: Use the settings DDS x-coordinate (ddsXCoordinate) and DDS y-coordinate (ddsYCoordinate) to specify the offset between the top left corner of the display window and the top left corner of the video frame. All burn-in and DVB-Sub font settings must match.

Definition at line 298 of file DvbSubDestinationSettings.h.

◆ WithDdsXCoordinate()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithDdsXCoordinate ( int  value)
inline

Use this setting, along with DDS y-coordinate (ddsYCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the left side of the frame and the left side of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.

Definition at line 351 of file DvbSubDestinationSettings.h.

◆ WithDdsYCoordinate()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithDdsYCoordinate ( int  value)
inline

Use this setting, along with DDS x-coordinate (ddsXCoordinate), to specify the upper left corner of the display definition segment (DDS) display window. With this setting, specify the distance, in pixels, between the top of the frame and the top of the DDS display window. Keep the default value, 0, to have MediaConvert automatically choose this offset. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). MediaConvert uses these values to determine whether to write page position data to the DDS or to the page composition segment (PCS). All burn-in and DVB-Sub font settings must match.

Definition at line 404 of file DvbSubDestinationSettings.h.

◆ WithFontColor() [1/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithFontColor ( const DvbSubtitleFontColor value)
inline

Specifies the color of the DVB-SUB 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.

Definition at line 445 of file DvbSubDestinationSettings.h.

◆ WithFontColor() [2/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithFontColor ( DvbSubtitleFontColor &&  value)
inline

Specifies the color of the DVB-SUB 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.

Definition at line 453 of file DvbSubDestinationSettings.h.

◆ WithFontOpacity()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithFontOpacity ( int  value)
inline
   Specifies the opacity of the burned-in captions. 255 is opaque; 0 is
   transparent.

All burn-in and DVB-Sub font settings must match.

Definition at line 482 of file DvbSubDestinationSettings.h.

◆ WithFontResolution()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithFontResolution ( int  value)
inline
   Font resolution in DPI (dots per inch); default is 96 dpi.

All burn-in and DVB-Sub font settings must match.

Definition at line 511 of file DvbSubDestinationSettings.h.

◆ WithFontScript() [1/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithFontScript ( const FontScript value)
inline

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.

Definition at line 552 of file DvbSubDestinationSettings.h.

◆ WithFontScript() [2/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithFontScript ( FontScript &&  value)
inline

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.

Definition at line 560 of file DvbSubDestinationSettings.h.

◆ WithFontSize()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithFontSize ( int  value)
inline

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.

Definition at line 585 of file DvbSubDestinationSettings.h.

◆ WithHeight()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithHeight ( int  value)
inline

Specify the height, in pixels, of this set of DVB-Sub captions. The default value is 576 pixels. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match.

Definition at line 618 of file DvbSubDestinationSettings.h.

◆ WithOutlineColor() [1/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithOutlineColor ( const DvbSubtitleOutlineColor value)
inline

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.

Definition at line 659 of file DvbSubDestinationSettings.h.

◆ WithOutlineColor() [2/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithOutlineColor ( DvbSubtitleOutlineColor &&  value)
inline

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.

Definition at line 667 of file DvbSubDestinationSettings.h.

◆ WithOutlineSize()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithOutlineSize ( int  value)
inline

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.

Definition at line 700 of file DvbSubDestinationSettings.h.

◆ WithShadowColor() [1/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithShadowColor ( const DvbSubtitleShadowColor value)
inline
   Specifies the color of the shadow cast by the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 736 of file DvbSubDestinationSettings.h.

◆ WithShadowColor() [2/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithShadowColor ( DvbSubtitleShadowColor &&  value)
inline
   Specifies the color of the shadow cast by the captions.

All burn-in and DVB-Sub font settings must match.

Definition at line 743 of file DvbSubDestinationSettings.h.

◆ WithShadowOpacity()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithShadowOpacity ( int  value)
inline

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.

Definition at line 772 of file DvbSubDestinationSettings.h.

◆ WithShadowXOffset()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithShadowXOffset ( int  value)
inline

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.

Definition at line 801 of file DvbSubDestinationSettings.h.

◆ WithShadowYOffset()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithShadowYOffset ( int  value)
inline

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.

Definition at line 830 of file DvbSubDestinationSettings.h.

◆ WithSubtitlingType() [1/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithSubtitlingType ( const DvbSubtitlingType value)
inline

Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.

Definition at line 866 of file DvbSubDestinationSettings.h.

◆ WithSubtitlingType() [2/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithSubtitlingType ( DvbSubtitlingType &&  value)
inline

Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.

Definition at line 873 of file DvbSubDestinationSettings.h.

◆ WithTeletextSpacing() [1/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithTeletextSpacing ( const DvbSubtitleTeletextSpacing value)
inline

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.

Definition at line 919 of file DvbSubDestinationSettings.h.

◆ WithTeletextSpacing() [2/2]

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithTeletextSpacing ( DvbSubtitleTeletextSpacing &&  value)
inline

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.

Definition at line 928 of file DvbSubDestinationSettings.h.

◆ WithWidth()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithWidth ( int  value)
inline

Specify the width, in pixels, of this set of DVB-Sub captions. The default value is 720 pixels. Related setting: When you use this setting, you must set DDS handling (ddsHandling) to a value other than None (NONE). All burn-in and DVB-Sub font settings must match.

Definition at line 961 of file DvbSubDestinationSettings.h.

◆ WithXPosition()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithXPosition ( int  value)
inline

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.

Definition at line 1006 of file DvbSubDestinationSettings.h.

◆ WithYPosition()

DvbSubDestinationSettings& Aws::MediaConvert::Model::DvbSubDestinationSettings::WithYPosition ( int  value)
inline

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.

Definition at line 1051 of file DvbSubDestinationSettings.h.

◆ XPositionHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::XPositionHasBeenSet ( ) const
inline

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.

Definition at line 984 of file DvbSubDestinationSettings.h.

◆ YPositionHasBeenSet()

bool Aws::MediaConvert::Model::DvbSubDestinationSettings::YPositionHasBeenSet ( ) const
inline

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.

Definition at line 1029 of file DvbSubDestinationSettings.h.


The documentation for this class was generated from the following file: