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

#include <CaptionDescription.h>

Public Member Functions

 CaptionDescription ()
 
 CaptionDescription (Aws::Utils::Json::JsonView jsonValue)
 
CaptionDescriptionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetCaptionSelectorName () const
 
bool CaptionSelectorNameHasBeenSet () const
 
void SetCaptionSelectorName (const Aws::String &value)
 
void SetCaptionSelectorName (Aws::String &&value)
 
void SetCaptionSelectorName (const char *value)
 
CaptionDescriptionWithCaptionSelectorName (const Aws::String &value)
 
CaptionDescriptionWithCaptionSelectorName (Aws::String &&value)
 
CaptionDescriptionWithCaptionSelectorName (const char *value)
 
const Aws::StringGetCustomLanguageCode () const
 
bool CustomLanguageCodeHasBeenSet () const
 
void SetCustomLanguageCode (const Aws::String &value)
 
void SetCustomLanguageCode (Aws::String &&value)
 
void SetCustomLanguageCode (const char *value)
 
CaptionDescriptionWithCustomLanguageCode (const Aws::String &value)
 
CaptionDescriptionWithCustomLanguageCode (Aws::String &&value)
 
CaptionDescriptionWithCustomLanguageCode (const char *value)
 
const CaptionDestinationSettingsGetDestinationSettings () const
 
bool DestinationSettingsHasBeenSet () const
 
void SetDestinationSettings (const CaptionDestinationSettings &value)
 
void SetDestinationSettings (CaptionDestinationSettings &&value)
 
CaptionDescriptionWithDestinationSettings (const CaptionDestinationSettings &value)
 
CaptionDescriptionWithDestinationSettings (CaptionDestinationSettings &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
CaptionDescriptionWithLanguageCode (const LanguageCode &value)
 
CaptionDescriptionWithLanguageCode (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)
 
CaptionDescriptionWithLanguageDescription (const Aws::String &value)
 
CaptionDescriptionWithLanguageDescription (Aws::String &&value)
 
CaptionDescriptionWithLanguageDescription (const char *value)
 

Detailed Description

This object holds groups of settings related to captions for one output. For each output that has captions, include one instance of CaptionDescriptions.

See Also:

AWS API Reference

Definition at line 35 of file CaptionDescription.h.

Constructor & Destructor Documentation

◆ CaptionDescription() [1/2]

Aws::MediaConvert::Model::CaptionDescription::CaptionDescription ( )

◆ CaptionDescription() [2/2]

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

Member Function Documentation

◆ CaptionSelectorNameHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDescription::CaptionSelectorNameHasBeenSet ( ) const
inline

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

Definition at line 58 of file CaptionDescription.h.

◆ CustomLanguageCodeHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDescription::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 133 of file CaptionDescription.h.

◆ DestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDescription::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 232 of file CaptionDescription.h.

◆ GetCaptionSelectorName()

const Aws::String& Aws::MediaConvert::Model::CaptionDescription::GetCaptionSelectorName ( ) const
inline

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

Definition at line 50 of file CaptionDescription.h.

◆ GetCustomLanguageCode()

const Aws::String& Aws::MediaConvert::Model::CaptionDescription::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 120 of file CaptionDescription.h.

◆ GetDestinationSettings()

const CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDescription::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 222 of file CaptionDescription.h.

◆ GetLanguageCode()

const LanguageCode& Aws::MediaConvert::Model::CaptionDescription::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 282 of file CaptionDescription.h.

◆ GetLanguageDescription()

const Aws::String& Aws::MediaConvert::Model::CaptionDescription::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 337 of file CaptionDescription.h.

◆ Jsonize()

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

◆ LanguageCodeHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDescription::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 291 of file CaptionDescription.h.

◆ LanguageDescriptionHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDescription::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 346 of file CaptionDescription.h.

◆ operator=()

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

◆ SetCaptionSelectorName() [1/3]

void Aws::MediaConvert::Model::CaptionDescription::SetCaptionSelectorName ( Aws::String &&  value)
inline

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

Definition at line 74 of file CaptionDescription.h.

◆ SetCaptionSelectorName() [2/3]

void Aws::MediaConvert::Model::CaptionDescription::SetCaptionSelectorName ( const Aws::String value)
inline

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

Definition at line 66 of file CaptionDescription.h.

◆ SetCaptionSelectorName() [3/3]

void Aws::MediaConvert::Model::CaptionDescription::SetCaptionSelectorName ( const char *  value)
inline

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

Definition at line 82 of file CaptionDescription.h.

◆ SetCustomLanguageCode() [1/3]

void Aws::MediaConvert::Model::CaptionDescription::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 159 of file CaptionDescription.h.

◆ SetCustomLanguageCode() [2/3]

void Aws::MediaConvert::Model::CaptionDescription::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 146 of file CaptionDescription.h.

◆ SetCustomLanguageCode() [3/3]

void Aws::MediaConvert::Model::CaptionDescription::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 172 of file CaptionDescription.h.

◆ SetDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDescription::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 252 of file CaptionDescription.h.

◆ SetDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDescription::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 242 of file CaptionDescription.h.

◆ SetLanguageCode() [1/2]

void Aws::MediaConvert::Model::CaptionDescription::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 300 of file CaptionDescription.h.

◆ SetLanguageCode() [2/2]

void Aws::MediaConvert::Model::CaptionDescription::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 309 of file CaptionDescription.h.

◆ SetLanguageDescription() [1/3]

void Aws::MediaConvert::Model::CaptionDescription::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 364 of file CaptionDescription.h.

◆ SetLanguageDescription() [2/3]

void Aws::MediaConvert::Model::CaptionDescription::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 355 of file CaptionDescription.h.

◆ SetLanguageDescription() [3/3]

void Aws::MediaConvert::Model::CaptionDescription::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 373 of file CaptionDescription.h.

◆ WithCaptionSelectorName() [1/3]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::WithCaptionSelectorName ( Aws::String &&  value)
inline

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

Definition at line 98 of file CaptionDescription.h.

◆ WithCaptionSelectorName() [2/3]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::WithCaptionSelectorName ( const Aws::String value)
inline

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

Definition at line 90 of file CaptionDescription.h.

◆ WithCaptionSelectorName() [3/3]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::WithCaptionSelectorName ( const char *  value)
inline

Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The name should be of the format "Caption Selector <N>", which denotes that the Nth Caption Selector will be used from each input.

Definition at line 106 of file CaptionDescription.h.

◆ WithCustomLanguageCode() [1/3]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 198 of file CaptionDescription.h.

◆ WithCustomLanguageCode() [2/3]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 185 of file CaptionDescription.h.

◆ WithCustomLanguageCode() [3/3]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 211 of file CaptionDescription.h.

◆ WithDestinationSettings() [1/2]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 272 of file CaptionDescription.h.

◆ WithDestinationSettings() [2/2]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 262 of file CaptionDescription.h.

◆ WithLanguageCode() [1/2]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 318 of file CaptionDescription.h.

◆ WithLanguageCode() [2/2]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 327 of file CaptionDescription.h.

◆ WithLanguageDescription() [1/3]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 391 of file CaptionDescription.h.

◆ WithLanguageDescription() [2/3]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 382 of file CaptionDescription.h.

◆ WithLanguageDescription() [3/3]

CaptionDescription& Aws::MediaConvert::Model::CaptionDescription::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 400 of file CaptionDescription.h.


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