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

#include <CaptionSourceSettings.h>

Public Member Functions

 CaptionSourceSettings ()
 
 CaptionSourceSettings (Aws::Utils::Json::JsonView jsonValue)
 
CaptionSourceSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const AncillarySourceSettingsGetAncillarySourceSettings () const
 
bool AncillarySourceSettingsHasBeenSet () const
 
void SetAncillarySourceSettings (const AncillarySourceSettings &value)
 
void SetAncillarySourceSettings (AncillarySourceSettings &&value)
 
CaptionSourceSettingsWithAncillarySourceSettings (const AncillarySourceSettings &value)
 
CaptionSourceSettingsWithAncillarySourceSettings (AncillarySourceSettings &&value)
 
const DvbSubSourceSettingsGetDvbSubSourceSettings () const
 
bool DvbSubSourceSettingsHasBeenSet () const
 
void SetDvbSubSourceSettings (const DvbSubSourceSettings &value)
 
void SetDvbSubSourceSettings (DvbSubSourceSettings &&value)
 
CaptionSourceSettingsWithDvbSubSourceSettings (const DvbSubSourceSettings &value)
 
CaptionSourceSettingsWithDvbSubSourceSettings (DvbSubSourceSettings &&value)
 
const EmbeddedSourceSettingsGetEmbeddedSourceSettings () const
 
bool EmbeddedSourceSettingsHasBeenSet () const
 
void SetEmbeddedSourceSettings (const EmbeddedSourceSettings &value)
 
void SetEmbeddedSourceSettings (EmbeddedSourceSettings &&value)
 
CaptionSourceSettingsWithEmbeddedSourceSettings (const EmbeddedSourceSettings &value)
 
CaptionSourceSettingsWithEmbeddedSourceSettings (EmbeddedSourceSettings &&value)
 
const FileSourceSettingsGetFileSourceSettings () const
 
bool FileSourceSettingsHasBeenSet () const
 
void SetFileSourceSettings (const FileSourceSettings &value)
 
void SetFileSourceSettings (FileSourceSettings &&value)
 
CaptionSourceSettingsWithFileSourceSettings (const FileSourceSettings &value)
 
CaptionSourceSettingsWithFileSourceSettings (FileSourceSettings &&value)
 
const CaptionSourceTypeGetSourceType () const
 
bool SourceTypeHasBeenSet () const
 
void SetSourceType (const CaptionSourceType &value)
 
void SetSourceType (CaptionSourceType &&value)
 
CaptionSourceSettingsWithSourceType (const CaptionSourceType &value)
 
CaptionSourceSettingsWithSourceType (CaptionSourceType &&value)
 
const TeletextSourceSettingsGetTeletextSourceSettings () const
 
bool TeletextSourceSettingsHasBeenSet () const
 
void SetTeletextSourceSettings (const TeletextSourceSettings &value)
 
void SetTeletextSourceSettings (TeletextSourceSettings &&value)
 
CaptionSourceSettingsWithTeletextSourceSettings (const TeletextSourceSettings &value)
 
CaptionSourceSettingsWithTeletextSourceSettings (TeletextSourceSettings &&value)
 
const TrackSourceSettingsGetTrackSourceSettings () const
 
bool TrackSourceSettingsHasBeenSet () const
 
void SetTrackSourceSettings (const TrackSourceSettings &value)
 
void SetTrackSourceSettings (TrackSourceSettings &&value)
 
CaptionSourceSettingsWithTrackSourceSettings (const TrackSourceSettings &value)
 
CaptionSourceSettingsWithTrackSourceSettings (TrackSourceSettings &&value)
 
const WebvttHlsSourceSettingsGetWebvttHlsSourceSettings () const
 
bool WebvttHlsSourceSettingsHasBeenSet () const
 
void SetWebvttHlsSourceSettings (const WebvttHlsSourceSettings &value)
 
void SetWebvttHlsSourceSettings (WebvttHlsSourceSettings &&value)
 
CaptionSourceSettingsWithWebvttHlsSourceSettings (const WebvttHlsSourceSettings &value)
 
CaptionSourceSettingsWithWebvttHlsSourceSettings (WebvttHlsSourceSettings &&value)
 

Detailed Description

If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

See Also:

AWS API Reference

Definition at line 41 of file CaptionSourceSettings.h.

Constructor & Destructor Documentation

◆ CaptionSourceSettings() [1/2]

Aws::MediaConvert::Model::CaptionSourceSettings::CaptionSourceSettings ( )

◆ CaptionSourceSettings() [2/2]

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

Member Function Documentation

◆ AncillarySourceSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionSourceSettings::AncillarySourceSettingsHasBeenSet ( ) const
inline

Settings for ancillary captions source.

Definition at line 58 of file CaptionSourceSettings.h.

◆ DvbSubSourceSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionSourceSettings::DvbSubSourceSettingsHasBeenSet ( ) const
inline

DVB Sub Source Settings

Definition at line 89 of file CaptionSourceSettings.h.

◆ EmbeddedSourceSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionSourceSettings::EmbeddedSourceSettingsHasBeenSet ( ) const
inline

Settings for embedded captions Source

Definition at line 120 of file CaptionSourceSettings.h.

◆ FileSourceSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionSourceSettings::FileSourceSettingsHasBeenSet ( ) const
inline

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Definition at line 157 of file CaptionSourceSettings.h.

◆ GetAncillarySourceSettings()

const AncillarySourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::GetAncillarySourceSettings ( ) const
inline

Settings for ancillary captions source.

Definition at line 53 of file CaptionSourceSettings.h.

◆ GetDvbSubSourceSettings()

const DvbSubSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::GetDvbSubSourceSettings ( ) const
inline

DVB Sub Source Settings

Definition at line 84 of file CaptionSourceSettings.h.

◆ GetEmbeddedSourceSettings()

const EmbeddedSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::GetEmbeddedSourceSettings ( ) const
inline

Settings for embedded captions Source

Definition at line 115 of file CaptionSourceSettings.h.

◆ GetFileSourceSettings()

const FileSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::GetFileSourceSettings ( ) const
inline

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Definition at line 149 of file CaptionSourceSettings.h.

◆ GetSourceType()

const CaptionSourceType& Aws::MediaConvert::Model::CaptionSourceSettings::GetSourceType ( ) const
inline

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Definition at line 196 of file CaptionSourceSettings.h.

◆ GetTeletextSourceSettings()

const TeletextSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::GetTeletextSourceSettings ( ) const
inline

Settings specific to Teletext caption sources, including Page number.

Definition at line 232 of file CaptionSourceSettings.h.

◆ GetTrackSourceSettings()

const TrackSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::GetTrackSourceSettings ( ) const
inline

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Definition at line 266 of file CaptionSourceSettings.h.

◆ GetWebvttHlsSourceSettings()

const WebvttHlsSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::GetWebvttHlsSourceSettings ( ) const
inline

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Definition at line 319 of file CaptionSourceSettings.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetAncillarySourceSettings() [1/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetAncillarySourceSettings ( AncillarySourceSettings &&  value)
inline

Settings for ancillary captions source.

Definition at line 68 of file CaptionSourceSettings.h.

◆ SetAncillarySourceSettings() [2/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetAncillarySourceSettings ( const AncillarySourceSettings value)
inline

Settings for ancillary captions source.

Definition at line 63 of file CaptionSourceSettings.h.

◆ SetDvbSubSourceSettings() [1/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetDvbSubSourceSettings ( const DvbSubSourceSettings value)
inline

DVB Sub Source Settings

Definition at line 94 of file CaptionSourceSettings.h.

◆ SetDvbSubSourceSettings() [2/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetDvbSubSourceSettings ( DvbSubSourceSettings &&  value)
inline

DVB Sub Source Settings

Definition at line 99 of file CaptionSourceSettings.h.

◆ SetEmbeddedSourceSettings() [1/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetEmbeddedSourceSettings ( const EmbeddedSourceSettings value)
inline

Settings for embedded captions Source

Definition at line 125 of file CaptionSourceSettings.h.

◆ SetEmbeddedSourceSettings() [2/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetEmbeddedSourceSettings ( EmbeddedSourceSettings &&  value)
inline

Settings for embedded captions Source

Definition at line 130 of file CaptionSourceSettings.h.

◆ SetFileSourceSettings() [1/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetFileSourceSettings ( const FileSourceSettings value)
inline

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Definition at line 165 of file CaptionSourceSettings.h.

◆ SetFileSourceSettings() [2/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetFileSourceSettings ( FileSourceSettings &&  value)
inline

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Definition at line 173 of file CaptionSourceSettings.h.

◆ SetSourceType() [1/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetSourceType ( CaptionSourceType &&  value)
inline

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Definition at line 214 of file CaptionSourceSettings.h.

◆ SetSourceType() [2/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetSourceType ( const CaptionSourceType value)
inline

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Definition at line 208 of file CaptionSourceSettings.h.

◆ SetTeletextSourceSettings() [1/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetTeletextSourceSettings ( const TeletextSourceSettings value)
inline

Settings specific to Teletext caption sources, including Page number.

Definition at line 242 of file CaptionSourceSettings.h.

◆ SetTeletextSourceSettings() [2/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetTeletextSourceSettings ( TeletextSourceSettings &&  value)
inline

Settings specific to Teletext caption sources, including Page number.

Definition at line 247 of file CaptionSourceSettings.h.

◆ SetTrackSourceSettings() [1/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetTrackSourceSettings ( const TrackSourceSettings value)
inline

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Definition at line 282 of file CaptionSourceSettings.h.

◆ SetTrackSourceSettings() [2/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetTrackSourceSettings ( TrackSourceSettings &&  value)
inline

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Definition at line 290 of file CaptionSourceSettings.h.

◆ SetWebvttHlsSourceSettings() [1/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetWebvttHlsSourceSettings ( const WebvttHlsSourceSettings value)
inline

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Definition at line 343 of file CaptionSourceSettings.h.

◆ SetWebvttHlsSourceSettings() [2/2]

void Aws::MediaConvert::Model::CaptionSourceSettings::SetWebvttHlsSourceSettings ( WebvttHlsSourceSettings &&  value)
inline

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Definition at line 355 of file CaptionSourceSettings.h.

◆ SourceTypeHasBeenSet()

bool Aws::MediaConvert::Model::CaptionSourceSettings::SourceTypeHasBeenSet ( ) const
inline

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Definition at line 202 of file CaptionSourceSettings.h.

◆ TeletextSourceSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionSourceSettings::TeletextSourceSettingsHasBeenSet ( ) const
inline

Settings specific to Teletext caption sources, including Page number.

Definition at line 237 of file CaptionSourceSettings.h.

◆ TrackSourceSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionSourceSettings::TrackSourceSettingsHasBeenSet ( ) const
inline

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Definition at line 274 of file CaptionSourceSettings.h.

◆ WebvttHlsSourceSettingsHasBeenSet()

bool Aws::MediaConvert::Model::CaptionSourceSettings::WebvttHlsSourceSettingsHasBeenSet ( ) const
inline

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Definition at line 331 of file CaptionSourceSettings.h.

◆ WithAncillarySourceSettings() [1/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithAncillarySourceSettings ( AncillarySourceSettings &&  value)
inline

Settings for ancillary captions source.

Definition at line 78 of file CaptionSourceSettings.h.

◆ WithAncillarySourceSettings() [2/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithAncillarySourceSettings ( const AncillarySourceSettings value)
inline

Settings for ancillary captions source.

Definition at line 73 of file CaptionSourceSettings.h.

◆ WithDvbSubSourceSettings() [1/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithDvbSubSourceSettings ( const DvbSubSourceSettings value)
inline

DVB Sub Source Settings

Definition at line 104 of file CaptionSourceSettings.h.

◆ WithDvbSubSourceSettings() [2/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithDvbSubSourceSettings ( DvbSubSourceSettings &&  value)
inline

DVB Sub Source Settings

Definition at line 109 of file CaptionSourceSettings.h.

◆ WithEmbeddedSourceSettings() [1/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithEmbeddedSourceSettings ( const EmbeddedSourceSettings value)
inline

Settings for embedded captions Source

Definition at line 135 of file CaptionSourceSettings.h.

◆ WithEmbeddedSourceSettings() [2/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithEmbeddedSourceSettings ( EmbeddedSourceSettings &&  value)
inline

Settings for embedded captions Source

Definition at line 140 of file CaptionSourceSettings.h.

◆ WithFileSourceSettings() [1/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithFileSourceSettings ( const FileSourceSettings value)
inline

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Definition at line 181 of file CaptionSourceSettings.h.

◆ WithFileSourceSettings() [2/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithFileSourceSettings ( FileSourceSettings &&  value)
inline

If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.

Definition at line 189 of file CaptionSourceSettings.h.

◆ WithSourceType() [1/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithSourceType ( CaptionSourceType &&  value)
inline

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Definition at line 226 of file CaptionSourceSettings.h.

◆ WithSourceType() [2/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithSourceType ( const CaptionSourceType value)
inline

Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.

Definition at line 220 of file CaptionSourceSettings.h.

◆ WithTeletextSourceSettings() [1/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithTeletextSourceSettings ( const TeletextSourceSettings value)
inline

Settings specific to Teletext caption sources, including Page number.

Definition at line 252 of file CaptionSourceSettings.h.

◆ WithTeletextSourceSettings() [2/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithTeletextSourceSettings ( TeletextSourceSettings &&  value)
inline

Settings specific to Teletext caption sources, including Page number.

Definition at line 257 of file CaptionSourceSettings.h.

◆ WithTrackSourceSettings() [1/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithTrackSourceSettings ( const TrackSourceSettings value)
inline

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Definition at line 298 of file CaptionSourceSettings.h.

◆ WithTrackSourceSettings() [2/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithTrackSourceSettings ( TrackSourceSettings &&  value)
inline

Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.

Definition at line 306 of file CaptionSourceSettings.h.

◆ WithWebvttHlsSourceSettings() [1/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithWebvttHlsSourceSettings ( const WebvttHlsSourceSettings value)
inline

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Definition at line 367 of file CaptionSourceSettings.h.

◆ WithWebvttHlsSourceSettings() [2/2]

CaptionSourceSettings& Aws::MediaConvert::Model::CaptionSourceSettings::WithWebvttHlsSourceSettings ( WebvttHlsSourceSettings &&  value)
inline

Settings specific to WebVTT sources in HLS alternative rendition group. Specify the properties (renditionGroupId, renditionName or renditionLanguageCode) to identify the unique subtitle track among the alternative rendition groups present in the HLS manifest. If no unique track is found, or multiple tracks match the specified properties, the job fails. If there is only one subtitle track in the rendition group, the settings can be left empty and the default subtitle track will be chosen. If your caption source is a sidecar file, use FileSourceSettings instead of WebvttHlsSourceSettings.

Definition at line 379 of file CaptionSourceSettings.h.


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