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

#include <CaptionDescriptionPreset.h>

Public Member Functions

 CaptionDescriptionPreset ()
 
 CaptionDescriptionPreset (Aws::Utils::Json::JsonView jsonValue)
 
CaptionDescriptionPresetoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetCustomLanguageCode () const
 
bool CustomLanguageCodeHasBeenSet () const
 
void SetCustomLanguageCode (const Aws::String &value)
 
void SetCustomLanguageCode (Aws::String &&value)
 
void SetCustomLanguageCode (const char *value)
 
CaptionDescriptionPresetWithCustomLanguageCode (const Aws::String &value)
 
CaptionDescriptionPresetWithCustomLanguageCode (Aws::String &&value)
 
CaptionDescriptionPresetWithCustomLanguageCode (const char *value)
 
const CaptionDestinationSettingsGetDestinationSettings () const
 
bool DestinationSettingsHasBeenSet () const
 
void SetDestinationSettings (const CaptionDestinationSettings &value)
 
void SetDestinationSettings (CaptionDestinationSettings &&value)
 
CaptionDescriptionPresetWithDestinationSettings (const CaptionDestinationSettings &value)
 
CaptionDescriptionPresetWithDestinationSettings (CaptionDestinationSettings &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
CaptionDescriptionPresetWithLanguageCode (const LanguageCode &value)
 
CaptionDescriptionPresetWithLanguageCode (LanguageCode &&value)
 
const Aws::StringGetLanguageDescription () const
 
bool LanguageDescriptionHasBeenSet () const
 
void SetLanguageDescription (const Aws::String &value)
 
void SetLanguageDescription (Aws::String &&value)
 
void SetLanguageDescription (const char *value)
 
CaptionDescriptionPresetWithLanguageDescription (const Aws::String &value)
 
CaptionDescriptionPresetWithLanguageDescription (Aws::String &&value)
 
CaptionDescriptionPresetWithLanguageDescription (const char *value)
 

Detailed Description

Caption Description for preset

See Also:

AWS API Reference

Definition at line 33 of file CaptionDescriptionPreset.h.

Constructor & Destructor Documentation

◆ CaptionDescriptionPreset() [1/2]

Aws::MediaConvert::Model::CaptionDescriptionPreset::CaptionDescriptionPreset ( )

◆ CaptionDescriptionPreset() [2/2]

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

Member Function Documentation

◆ CustomLanguageCodeHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDescriptionPreset::CustomLanguageCodeHasBeenSet ( ) const
inline

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Definition at line 66 of file CaptionDescriptionPreset.h.

◆ DestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDescriptionPreset::DestinationSettingsHasBeenSet ( ) const
inline

Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

Definition at line 165 of file CaptionDescriptionPreset.h.

◆ GetCustomLanguageCode()

const Aws::String& Aws::MediaConvert::Model::CaptionDescriptionPreset::GetCustomLanguageCode ( ) const
inline

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Definition at line 53 of file CaptionDescriptionPreset.h.

◆ GetDestinationSettings()

const CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDescriptionPreset::GetDestinationSettings ( ) const
inline

Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

Definition at line 155 of file CaptionDescriptionPreset.h.

◆ GetLanguageCode()

const LanguageCode& Aws::MediaConvert::Model::CaptionDescriptionPreset::GetLanguageCode ( ) const
inline

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Definition at line 215 of file CaptionDescriptionPreset.h.

◆ GetLanguageDescription()

const Aws::String& Aws::MediaConvert::Model::CaptionDescriptionPreset::GetLanguageDescription ( ) const
inline

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Definition at line 270 of file CaptionDescriptionPreset.h.

◆ Jsonize()

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

◆ LanguageCodeHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDescriptionPreset::LanguageCodeHasBeenSet ( ) const
inline

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Definition at line 224 of file CaptionDescriptionPreset.h.

◆ LanguageDescriptionHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDescriptionPreset::LanguageDescriptionHasBeenSet ( ) const
inline

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Definition at line 279 of file CaptionDescriptionPreset.h.

◆ operator=()

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

◆ SetCustomLanguageCode() [1/3]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetCustomLanguageCode ( Aws::String &&  value)
inline

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Definition at line 92 of file CaptionDescriptionPreset.h.

◆ SetCustomLanguageCode() [2/3]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetCustomLanguageCode ( const Aws::String value)
inline

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Definition at line 79 of file CaptionDescriptionPreset.h.

◆ SetCustomLanguageCode() [3/3]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetCustomLanguageCode ( const char *  value)
inline

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Definition at line 105 of file CaptionDescriptionPreset.h.

◆ SetDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetDestinationSettings ( CaptionDestinationSettings &&  value)
inline

Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

Definition at line 185 of file CaptionDescriptionPreset.h.

◆ SetDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetDestinationSettings ( const CaptionDestinationSettings value)
inline

Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

Definition at line 175 of file CaptionDescriptionPreset.h.

◆ SetLanguageCode() [1/2]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetLanguageCode ( const LanguageCode value)
inline

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Definition at line 233 of file CaptionDescriptionPreset.h.

◆ SetLanguageCode() [2/2]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetLanguageCode ( LanguageCode &&  value)
inline

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Definition at line 242 of file CaptionDescriptionPreset.h.

◆ SetLanguageDescription() [1/3]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetLanguageDescription ( Aws::String &&  value)
inline

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Definition at line 297 of file CaptionDescriptionPreset.h.

◆ SetLanguageDescription() [2/3]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetLanguageDescription ( const Aws::String value)
inline

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Definition at line 288 of file CaptionDescriptionPreset.h.

◆ SetLanguageDescription() [3/3]

void Aws::MediaConvert::Model::CaptionDescriptionPreset::SetLanguageDescription ( const char *  value)
inline

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Definition at line 306 of file CaptionDescriptionPreset.h.

◆ WithCustomLanguageCode() [1/3]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithCustomLanguageCode ( Aws::String &&  value)
inline

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Definition at line 131 of file CaptionDescriptionPreset.h.

◆ WithCustomLanguageCode() [2/3]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithCustomLanguageCode ( const Aws::String value)
inline

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Definition at line 118 of file CaptionDescriptionPreset.h.

◆ WithCustomLanguageCode() [3/3]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithCustomLanguageCode ( const char *  value)
inline

Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Definition at line 144 of file CaptionDescriptionPreset.h.

◆ WithDestinationSettings() [1/2]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithDestinationSettings ( CaptionDestinationSettings &&  value)
inline

Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

Definition at line 205 of file CaptionDescriptionPreset.h.

◆ WithDestinationSettings() [2/2]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithDestinationSettings ( const CaptionDestinationSettings value)
inline

Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.

Definition at line 195 of file CaptionDescriptionPreset.h.

◆ WithLanguageCode() [1/2]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithLanguageCode ( const LanguageCode value)
inline

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Definition at line 251 of file CaptionDescriptionPreset.h.

◆ WithLanguageCode() [2/2]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithLanguageCode ( LanguageCode &&  value)
inline

Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.

Definition at line 260 of file CaptionDescriptionPreset.h.

◆ WithLanguageDescription() [1/3]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithLanguageDescription ( Aws::String &&  value)
inline

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Definition at line 324 of file CaptionDescriptionPreset.h.

◆ WithLanguageDescription() [2/3]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithLanguageDescription ( const Aws::String value)
inline

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Definition at line 315 of file CaptionDescriptionPreset.h.

◆ WithLanguageDescription() [3/3]

CaptionDescriptionPreset& Aws::MediaConvert::Model::CaptionDescriptionPreset::WithLanguageDescription ( const char *  value)
inline

Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Definition at line 333 of file CaptionDescriptionPreset.h.


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