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

#include <CaptionDestinationSettings.h>

Public Member Functions

 CaptionDestinationSettings ()
 
 CaptionDestinationSettings (Aws::Utils::Json::JsonView jsonValue)
 
CaptionDestinationSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const BurninDestinationSettingsGetBurninDestinationSettings () const
 
bool BurninDestinationSettingsHasBeenSet () const
 
void SetBurninDestinationSettings (const BurninDestinationSettings &value)
 
void SetBurninDestinationSettings (BurninDestinationSettings &&value)
 
CaptionDestinationSettingsWithBurninDestinationSettings (const BurninDestinationSettings &value)
 
CaptionDestinationSettingsWithBurninDestinationSettings (BurninDestinationSettings &&value)
 
const CaptionDestinationTypeGetDestinationType () const
 
bool DestinationTypeHasBeenSet () const
 
void SetDestinationType (const CaptionDestinationType &value)
 
void SetDestinationType (CaptionDestinationType &&value)
 
CaptionDestinationSettingsWithDestinationType (const CaptionDestinationType &value)
 
CaptionDestinationSettingsWithDestinationType (CaptionDestinationType &&value)
 
const DvbSubDestinationSettingsGetDvbSubDestinationSettings () const
 
bool DvbSubDestinationSettingsHasBeenSet () const
 
void SetDvbSubDestinationSettings (const DvbSubDestinationSettings &value)
 
void SetDvbSubDestinationSettings (DvbSubDestinationSettings &&value)
 
CaptionDestinationSettingsWithDvbSubDestinationSettings (const DvbSubDestinationSettings &value)
 
CaptionDestinationSettingsWithDvbSubDestinationSettings (DvbSubDestinationSettings &&value)
 
const EmbeddedDestinationSettingsGetEmbeddedDestinationSettings () const
 
bool EmbeddedDestinationSettingsHasBeenSet () const
 
void SetEmbeddedDestinationSettings (const EmbeddedDestinationSettings &value)
 
void SetEmbeddedDestinationSettings (EmbeddedDestinationSettings &&value)
 
CaptionDestinationSettingsWithEmbeddedDestinationSettings (const EmbeddedDestinationSettings &value)
 
CaptionDestinationSettingsWithEmbeddedDestinationSettings (EmbeddedDestinationSettings &&value)
 
const ImscDestinationSettingsGetImscDestinationSettings () const
 
bool ImscDestinationSettingsHasBeenSet () const
 
void SetImscDestinationSettings (const ImscDestinationSettings &value)
 
void SetImscDestinationSettings (ImscDestinationSettings &&value)
 
CaptionDestinationSettingsWithImscDestinationSettings (const ImscDestinationSettings &value)
 
CaptionDestinationSettingsWithImscDestinationSettings (ImscDestinationSettings &&value)
 
const SccDestinationSettingsGetSccDestinationSettings () const
 
bool SccDestinationSettingsHasBeenSet () const
 
void SetSccDestinationSettings (const SccDestinationSettings &value)
 
void SetSccDestinationSettings (SccDestinationSettings &&value)
 
CaptionDestinationSettingsWithSccDestinationSettings (const SccDestinationSettings &value)
 
CaptionDestinationSettingsWithSccDestinationSettings (SccDestinationSettings &&value)
 
const SrtDestinationSettingsGetSrtDestinationSettings () const
 
bool SrtDestinationSettingsHasBeenSet () const
 
void SetSrtDestinationSettings (const SrtDestinationSettings &value)
 
void SetSrtDestinationSettings (SrtDestinationSettings &&value)
 
CaptionDestinationSettingsWithSrtDestinationSettings (const SrtDestinationSettings &value)
 
CaptionDestinationSettingsWithSrtDestinationSettings (SrtDestinationSettings &&value)
 
const TeletextDestinationSettingsGetTeletextDestinationSettings () const
 
bool TeletextDestinationSettingsHasBeenSet () const
 
void SetTeletextDestinationSettings (const TeletextDestinationSettings &value)
 
void SetTeletextDestinationSettings (TeletextDestinationSettings &&value)
 
CaptionDestinationSettingsWithTeletextDestinationSettings (const TeletextDestinationSettings &value)
 
CaptionDestinationSettingsWithTeletextDestinationSettings (TeletextDestinationSettings &&value)
 
const TtmlDestinationSettingsGetTtmlDestinationSettings () const
 
bool TtmlDestinationSettingsHasBeenSet () const
 
void SetTtmlDestinationSettings (const TtmlDestinationSettings &value)
 
void SetTtmlDestinationSettings (TtmlDestinationSettings &&value)
 
CaptionDestinationSettingsWithTtmlDestinationSettings (const TtmlDestinationSettings &value)
 
CaptionDestinationSettingsWithTtmlDestinationSettings (TtmlDestinationSettings &&value)
 
const WebvttDestinationSettingsGetWebvttDestinationSettings () const
 
bool WebvttDestinationSettingsHasBeenSet () const
 
void SetWebvttDestinationSettings (const WebvttDestinationSettings &value)
 
void SetWebvttDestinationSettings (WebvttDestinationSettings &&value)
 
CaptionDestinationSettingsWithWebvttDestinationSettings (const WebvttDestinationSettings &value)
 
CaptionDestinationSettingsWithWebvttDestinationSettings (WebvttDestinationSettings &&value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 46 of file CaptionDestinationSettings.h.

Constructor & Destructor Documentation

◆ CaptionDestinationSettings() [1/2]

Aws::MediaConvert::Model::CaptionDestinationSettings::CaptionDestinationSettings ( )

◆ CaptionDestinationSettings() [2/2]

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

Member Function Documentation

◆ BurninDestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::BurninDestinationSettingsHasBeenSet ( ) const
inline

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

Definition at line 71 of file CaptionDestinationSettings.h.

◆ DestinationTypeHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::DestinationTypeHasBeenSet ( ) const
inline

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

Definition at line 132 of file CaptionDestinationSettings.h.

◆ DvbSubDestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::DvbSubDestinationSettingsHasBeenSet ( ) const
inline

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.

Definition at line 199 of file CaptionDestinationSettings.h.

◆ EmbeddedDestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::EmbeddedDestinationSettingsHasBeenSet ( ) const
inline

Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.

Definition at line 258 of file CaptionDestinationSettings.h.

◆ GetBurninDestinationSettings()

const BurninDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::GetBurninDestinationSettings ( ) const
inline

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

Definition at line 62 of file CaptionDestinationSettings.h.

◆ GetDestinationType()

const CaptionDestinationType& Aws::MediaConvert::Model::CaptionDestinationSettings::GetDestinationType ( ) const
inline

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

Definition at line 120 of file CaptionDestinationSettings.h.

◆ GetDvbSubDestinationSettings()

const DvbSubDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::GetDvbSubDestinationSettings ( ) const
inline

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.

Definition at line 190 of file CaptionDestinationSettings.h.

◆ GetEmbeddedDestinationSettings()

const EmbeddedDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::GetEmbeddedDestinationSettings ( ) const
inline

Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.

Definition at line 247 of file CaptionDestinationSettings.h.

◆ GetImscDestinationSettings()

const ImscDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::GetImscDestinationSettings ( ) const
inline

Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.

Definition at line 314 of file CaptionDestinationSettings.h.

◆ GetSccDestinationSettings()

const SccDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::GetSccDestinationSettings ( ) const
inline

Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.

Definition at line 381 of file CaptionDestinationSettings.h.

◆ GetSrtDestinationSettings()

const SrtDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::GetSrtDestinationSettings ( ) const
inline

SRT Destination Settings

Definition at line 442 of file CaptionDestinationSettings.h.

◆ GetTeletextDestinationSettings()

const TeletextDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::GetTeletextDestinationSettings ( ) const
inline

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

Definition at line 477 of file CaptionDestinationSettings.h.

◆ GetTtmlDestinationSettings()

const TtmlDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::GetTtmlDestinationSettings ( ) const
inline

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.

Definition at line 534 of file CaptionDestinationSettings.h.

◆ GetWebvttDestinationSettings()

const WebvttDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::GetWebvttDestinationSettings ( ) const
inline

WEBVTT Destination Settings

Definition at line 595 of file CaptionDestinationSettings.h.

◆ ImscDestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::ImscDestinationSettingsHasBeenSet ( ) const
inline

Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.

Definition at line 325 of file CaptionDestinationSettings.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SccDestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::SccDestinationSettingsHasBeenSet ( ) const
inline

Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.

Definition at line 392 of file CaptionDestinationSettings.h.

◆ SetBurninDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetBurninDestinationSettings ( BurninDestinationSettings &&  value)
inline

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

Definition at line 89 of file CaptionDestinationSettings.h.

◆ SetBurninDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetBurninDestinationSettings ( const BurninDestinationSettings value)
inline

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

Definition at line 80 of file CaptionDestinationSettings.h.

◆ SetDestinationType() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetDestinationType ( CaptionDestinationType &&  value)
inline

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

Definition at line 156 of file CaptionDestinationSettings.h.

◆ SetDestinationType() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetDestinationType ( const CaptionDestinationType value)
inline

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

Definition at line 144 of file CaptionDestinationSettings.h.

◆ SetDvbSubDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetDvbSubDestinationSettings ( const DvbSubDestinationSettings value)
inline

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.

Definition at line 208 of file CaptionDestinationSettings.h.

◆ SetDvbSubDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetDvbSubDestinationSettings ( DvbSubDestinationSettings &&  value)
inline

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.

Definition at line 217 of file CaptionDestinationSettings.h.

◆ SetEmbeddedDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetEmbeddedDestinationSettings ( const EmbeddedDestinationSettings value)
inline

Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.

Definition at line 269 of file CaptionDestinationSettings.h.

◆ SetEmbeddedDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetEmbeddedDestinationSettings ( EmbeddedDestinationSettings &&  value)
inline

Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.

Definition at line 280 of file CaptionDestinationSettings.h.

◆ SetImscDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetImscDestinationSettings ( const ImscDestinationSettings value)
inline

Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.

Definition at line 336 of file CaptionDestinationSettings.h.

◆ SetImscDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetImscDestinationSettings ( ImscDestinationSettings &&  value)
inline

Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.

Definition at line 347 of file CaptionDestinationSettings.h.

◆ SetSccDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetSccDestinationSettings ( const SccDestinationSettings value)
inline

Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.

Definition at line 403 of file CaptionDestinationSettings.h.

◆ SetSccDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetSccDestinationSettings ( SccDestinationSettings &&  value)
inline

Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.

Definition at line 414 of file CaptionDestinationSettings.h.

◆ SetSrtDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetSrtDestinationSettings ( const SrtDestinationSettings value)
inline

SRT Destination Settings

Definition at line 452 of file CaptionDestinationSettings.h.

◆ SetSrtDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetSrtDestinationSettings ( SrtDestinationSettings &&  value)
inline

SRT Destination Settings

Definition at line 457 of file CaptionDestinationSettings.h.

◆ SetTeletextDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetTeletextDestinationSettings ( const TeletextDestinationSettings value)
inline

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

Definition at line 495 of file CaptionDestinationSettings.h.

◆ SetTeletextDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetTeletextDestinationSettings ( TeletextDestinationSettings &&  value)
inline

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

Definition at line 504 of file CaptionDestinationSettings.h.

◆ SetTtmlDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetTtmlDestinationSettings ( const TtmlDestinationSettings value)
inline

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.

Definition at line 556 of file CaptionDestinationSettings.h.

◆ SetTtmlDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetTtmlDestinationSettings ( TtmlDestinationSettings &&  value)
inline

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.

Definition at line 567 of file CaptionDestinationSettings.h.

◆ SetWebvttDestinationSettings() [1/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetWebvttDestinationSettings ( const WebvttDestinationSettings value)
inline

WEBVTT Destination Settings

Definition at line 605 of file CaptionDestinationSettings.h.

◆ SetWebvttDestinationSettings() [2/2]

void Aws::MediaConvert::Model::CaptionDestinationSettings::SetWebvttDestinationSettings ( WebvttDestinationSettings &&  value)
inline

WEBVTT Destination Settings

Definition at line 610 of file CaptionDestinationSettings.h.

◆ SrtDestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::SrtDestinationSettingsHasBeenSet ( ) const
inline

SRT Destination Settings

Definition at line 447 of file CaptionDestinationSettings.h.

◆ TeletextDestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::TeletextDestinationSettingsHasBeenSet ( ) const
inline

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

Definition at line 486 of file CaptionDestinationSettings.h.

◆ TtmlDestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::TtmlDestinationSettingsHasBeenSet ( ) const
inline

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.

Definition at line 545 of file CaptionDestinationSettings.h.

◆ WebvttDestinationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionDestinationSettings::WebvttDestinationSettingsHasBeenSet ( ) const
inline

WEBVTT Destination Settings

Definition at line 600 of file CaptionDestinationSettings.h.

◆ WithBurninDestinationSettings() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithBurninDestinationSettings ( BurninDestinationSettings &&  value)
inline

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

Definition at line 107 of file CaptionDestinationSettings.h.

◆ WithBurninDestinationSettings() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithBurninDestinationSettings ( const BurninDestinationSettings value)
inline

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

Definition at line 98 of file CaptionDestinationSettings.h.

◆ WithDestinationType() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithDestinationType ( CaptionDestinationType &&  value)
inline

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

Definition at line 180 of file CaptionDestinationSettings.h.

◆ WithDestinationType() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithDestinationType ( const CaptionDestinationType value)
inline

Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).

Definition at line 168 of file CaptionDestinationSettings.h.

◆ WithDvbSubDestinationSettings() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithDvbSubDestinationSettings ( const DvbSubDestinationSettings value)
inline

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.

Definition at line 226 of file CaptionDestinationSettings.h.

◆ WithDvbSubDestinationSettings() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithDvbSubDestinationSettings ( DvbSubDestinationSettings &&  value)
inline

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.

Definition at line 235 of file CaptionDestinationSettings.h.

◆ WithEmbeddedDestinationSettings() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithEmbeddedDestinationSettings ( const EmbeddedDestinationSettings value)
inline

Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.

Definition at line 291 of file CaptionDestinationSettings.h.

◆ WithEmbeddedDestinationSettings() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithEmbeddedDestinationSettings ( EmbeddedDestinationSettings &&  value)
inline

Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED.

Definition at line 302 of file CaptionDestinationSettings.h.

◆ WithImscDestinationSettings() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithImscDestinationSettings ( const ImscDestinationSettings value)
inline

Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.

Definition at line 358 of file CaptionDestinationSettings.h.

◆ WithImscDestinationSettings() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithImscDestinationSettings ( ImscDestinationSettings &&  value)
inline

Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC.

Definition at line 369 of file CaptionDestinationSettings.h.

◆ WithSccDestinationSettings() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithSccDestinationSettings ( const SccDestinationSettings value)
inline

Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.

Definition at line 425 of file CaptionDestinationSettings.h.

◆ WithSccDestinationSettings() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithSccDestinationSettings ( SccDestinationSettings &&  value)
inline

Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC.

Definition at line 436 of file CaptionDestinationSettings.h.

◆ WithSrtDestinationSettings() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithSrtDestinationSettings ( const SrtDestinationSettings value)
inline

SRT Destination Settings

Definition at line 462 of file CaptionDestinationSettings.h.

◆ WithSrtDestinationSettings() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithSrtDestinationSettings ( SrtDestinationSettings &&  value)
inline

SRT Destination Settings

Definition at line 467 of file CaptionDestinationSettings.h.

◆ WithTeletextDestinationSettings() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithTeletextDestinationSettings ( const TeletextDestinationSettings value)
inline

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

Definition at line 513 of file CaptionDestinationSettings.h.

◆ WithTeletextDestinationSettings() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithTeletextDestinationSettings ( TeletextDestinationSettings &&  value)
inline

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

Definition at line 522 of file CaptionDestinationSettings.h.

◆ WithTtmlDestinationSettings() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithTtmlDestinationSettings ( const TtmlDestinationSettings value)
inline

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.

Definition at line 578 of file CaptionDestinationSettings.h.

◆ WithTtmlDestinationSettings() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithTtmlDestinationSettings ( TtmlDestinationSettings &&  value)
inline

Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML.

Definition at line 589 of file CaptionDestinationSettings.h.

◆ WithWebvttDestinationSettings() [1/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithWebvttDestinationSettings ( const WebvttDestinationSettings value)
inline

WEBVTT Destination Settings

Definition at line 615 of file CaptionDestinationSettings.h.

◆ WithWebvttDestinationSettings() [2/2]

CaptionDestinationSettings& Aws::MediaConvert::Model::CaptionDestinationSettings::WithWebvttDestinationSettings ( WebvttDestinationSettings &&  value)
inline

WEBVTT Destination Settings

Definition at line 620 of file CaptionDestinationSettings.h.


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