AWS SDK for C++  1.9.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::TranscribeService::Model::Settings Class Reference

#include <Settings.h>

Public Member Functions

 Settings ()
 
 Settings (Aws::Utils::Json::JsonView jsonValue)
 
Settingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetVocabularyName () const
 
bool VocabularyNameHasBeenSet () const
 
void SetVocabularyName (const Aws::String &value)
 
void SetVocabularyName (Aws::String &&value)
 
void SetVocabularyName (const char *value)
 
SettingsWithVocabularyName (const Aws::String &value)
 
SettingsWithVocabularyName (Aws::String &&value)
 
SettingsWithVocabularyName (const char *value)
 
bool GetShowSpeakerLabels () const
 
bool ShowSpeakerLabelsHasBeenSet () const
 
void SetShowSpeakerLabels (bool value)
 
SettingsWithShowSpeakerLabels (bool value)
 
int GetMaxSpeakerLabels () const
 
bool MaxSpeakerLabelsHasBeenSet () const
 
void SetMaxSpeakerLabels (int value)
 
SettingsWithMaxSpeakerLabels (int value)
 
bool GetChannelIdentification () const
 
bool ChannelIdentificationHasBeenSet () const
 
void SetChannelIdentification (bool value)
 
SettingsWithChannelIdentification (bool value)
 
bool GetShowAlternatives () const
 
bool ShowAlternativesHasBeenSet () const
 
void SetShowAlternatives (bool value)
 
SettingsWithShowAlternatives (bool value)
 
int GetMaxAlternatives () const
 
bool MaxAlternativesHasBeenSet () const
 
void SetMaxAlternatives (int value)
 
SettingsWithMaxAlternatives (int value)
 
const Aws::StringGetVocabularyFilterName () const
 
bool VocabularyFilterNameHasBeenSet () const
 
void SetVocabularyFilterName (const Aws::String &value)
 
void SetVocabularyFilterName (Aws::String &&value)
 
void SetVocabularyFilterName (const char *value)
 
SettingsWithVocabularyFilterName (const Aws::String &value)
 
SettingsWithVocabularyFilterName (Aws::String &&value)
 
SettingsWithVocabularyFilterName (const char *value)
 
const VocabularyFilterMethodGetVocabularyFilterMethod () const
 
bool VocabularyFilterMethodHasBeenSet () const
 
void SetVocabularyFilterMethod (const VocabularyFilterMethod &value)
 
void SetVocabularyFilterMethod (VocabularyFilterMethod &&value)
 
SettingsWithVocabularyFilterMethod (const VocabularyFilterMethod &value)
 
SettingsWithVocabularyFilterMethod (VocabularyFilterMethod &&value)
 

Detailed Description

Provides optional settings for the StartTranscriptionJob operation.

See Also:

AWS API Reference

Definition at line 33 of file Settings.h.

Constructor & Destructor Documentation

◆ Settings() [1/2]

Aws::TranscribeService::Model::Settings::Settings ( )

◆ Settings() [2/2]

Aws::TranscribeService::Model::Settings::Settings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ChannelIdentificationHasBeenSet()

bool Aws::TranscribeService::Model::Settings::ChannelIdentificationHasBeenSet ( ) const
inline

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Definition at line 187 of file Settings.h.

◆ GetChannelIdentification()

bool Aws::TranscribeService::Model::Settings::GetChannelIdentification ( ) const
inline

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Definition at line 175 of file Settings.h.

◆ GetMaxAlternatives()

int Aws::TranscribeService::Model::Settings::GetMaxAlternatives ( ) const
inline

The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

Definition at line 252 of file Settings.h.

◆ GetMaxSpeakerLabels()

int Aws::TranscribeService::Model::Settings::GetMaxSpeakerLabels ( ) const
inline

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Definition at line 138 of file Settings.h.

◆ GetShowAlternatives()

bool Aws::TranscribeService::Model::Settings::GetShowAlternatives ( ) const
inline

Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

Definition at line 220 of file Settings.h.

◆ GetShowSpeakerLabels()

bool Aws::TranscribeService::Model::Settings::GetShowSpeakerLabels ( ) const
inline

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Definition at line 93 of file Settings.h.

◆ GetVocabularyFilterMethod()

const VocabularyFilterMethod& Aws::TranscribeService::Model::Settings::GetVocabularyFilterMethod ( ) const
inline

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

Definition at line 342 of file Settings.h.

◆ GetVocabularyFilterName()

const Aws::String& Aws::TranscribeService::Model::Settings::GetVocabularyFilterName ( ) const
inline

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

Definition at line 281 of file Settings.h.

◆ GetVocabularyName()

const Aws::String& Aws::TranscribeService::Model::Settings::GetVocabularyName ( ) const
inline

The name of a vocabulary to use when processing the transcription job.

Definition at line 45 of file Settings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::TranscribeService::Model::Settings::Jsonize ( ) const

◆ MaxAlternativesHasBeenSet()

bool Aws::TranscribeService::Model::Settings::MaxAlternativesHasBeenSet ( ) const
inline

The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

Definition at line 259 of file Settings.h.

◆ MaxSpeakerLabelsHasBeenSet()

bool Aws::TranscribeService::Model::Settings::MaxSpeakerLabelsHasBeenSet ( ) const
inline

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Definition at line 146 of file Settings.h.

◆ operator=()

Settings& Aws::TranscribeService::Model::Settings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetChannelIdentification()

void Aws::TranscribeService::Model::Settings::SetChannelIdentification ( bool  value)
inline

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Definition at line 199 of file Settings.h.

◆ SetMaxAlternatives()

void Aws::TranscribeService::Model::Settings::SetMaxAlternatives ( int  value)
inline

The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

Definition at line 266 of file Settings.h.

◆ SetMaxSpeakerLabels()

void Aws::TranscribeService::Model::Settings::SetMaxSpeakerLabels ( int  value)
inline

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Definition at line 154 of file Settings.h.

◆ SetShowAlternatives()

void Aws::TranscribeService::Model::Settings::SetShowAlternatives ( bool  value)
inline

Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

Definition at line 236 of file Settings.h.

◆ SetShowSpeakerLabels()

void Aws::TranscribeService::Model::Settings::SetShowSpeakerLabels ( bool  value)
inline

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Definition at line 117 of file Settings.h.

◆ SetVocabularyFilterMethod() [1/2]

void Aws::TranscribeService::Model::Settings::SetVocabularyFilterMethod ( const VocabularyFilterMethod value)
inline

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

Definition at line 364 of file Settings.h.

◆ SetVocabularyFilterMethod() [2/2]

void Aws::TranscribeService::Model::Settings::SetVocabularyFilterMethod ( VocabularyFilterMethod &&  value)
inline

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

Definition at line 375 of file Settings.h.

◆ SetVocabularyFilterName() [1/3]

void Aws::TranscribeService::Model::Settings::SetVocabularyFilterName ( Aws::String &&  value)
inline

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

Definition at line 302 of file Settings.h.

◆ SetVocabularyFilterName() [2/3]

void Aws::TranscribeService::Model::Settings::SetVocabularyFilterName ( const Aws::String value)
inline

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

Definition at line 295 of file Settings.h.

◆ SetVocabularyFilterName() [3/3]

void Aws::TranscribeService::Model::Settings::SetVocabularyFilterName ( const char *  value)
inline

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

Definition at line 309 of file Settings.h.

◆ SetVocabularyName() [1/3]

void Aws::TranscribeService::Model::Settings::SetVocabularyName ( Aws::String &&  value)
inline

The name of a vocabulary to use when processing the transcription job.

Definition at line 60 of file Settings.h.

◆ SetVocabularyName() [2/3]

void Aws::TranscribeService::Model::Settings::SetVocabularyName ( const Aws::String value)
inline

The name of a vocabulary to use when processing the transcription job.

Definition at line 55 of file Settings.h.

◆ SetVocabularyName() [3/3]

void Aws::TranscribeService::Model::Settings::SetVocabularyName ( const char *  value)
inline

The name of a vocabulary to use when processing the transcription job.

Definition at line 65 of file Settings.h.

◆ ShowAlternativesHasBeenSet()

bool Aws::TranscribeService::Model::Settings::ShowAlternativesHasBeenSet ( ) const
inline

Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

Definition at line 228 of file Settings.h.

◆ ShowSpeakerLabelsHasBeenSet()

bool Aws::TranscribeService::Model::Settings::ShowSpeakerLabelsHasBeenSet ( ) const
inline

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Definition at line 105 of file Settings.h.

◆ VocabularyFilterMethodHasBeenSet()

bool Aws::TranscribeService::Model::Settings::VocabularyFilterMethodHasBeenSet ( ) const
inline

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

Definition at line 353 of file Settings.h.

◆ VocabularyFilterNameHasBeenSet()

bool Aws::TranscribeService::Model::Settings::VocabularyFilterNameHasBeenSet ( ) const
inline

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

Definition at line 288 of file Settings.h.

◆ VocabularyNameHasBeenSet()

bool Aws::TranscribeService::Model::Settings::VocabularyNameHasBeenSet ( ) const
inline

The name of a vocabulary to use when processing the transcription job.

Definition at line 50 of file Settings.h.

◆ WithChannelIdentification()

Settings& Aws::TranscribeService::Model::Settings::WithChannelIdentification ( bool  value)
inline

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Definition at line 211 of file Settings.h.

◆ WithMaxAlternatives()

Settings& Aws::TranscribeService::Model::Settings::WithMaxAlternatives ( int  value)
inline

The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.

Definition at line 273 of file Settings.h.

◆ WithMaxSpeakerLabels()

Settings& Aws::TranscribeService::Model::Settings::WithMaxSpeakerLabels ( int  value)
inline

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Definition at line 162 of file Settings.h.

◆ WithShowAlternatives()

Settings& Aws::TranscribeService::Model::Settings::WithShowAlternatives ( bool  value)
inline

Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.

Definition at line 244 of file Settings.h.

◆ WithShowSpeakerLabels()

Settings& Aws::TranscribeService::Model::Settings::WithShowSpeakerLabels ( bool  value)
inline

Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

Definition at line 129 of file Settings.h.

◆ WithVocabularyFilterMethod() [1/2]

Settings& Aws::TranscribeService::Model::Settings::WithVocabularyFilterMethod ( const VocabularyFilterMethod value)
inline

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

Definition at line 386 of file Settings.h.

◆ WithVocabularyFilterMethod() [2/2]

Settings& Aws::TranscribeService::Model::Settings::WithVocabularyFilterMethod ( VocabularyFilterMethod &&  value)
inline

Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.

Definition at line 397 of file Settings.h.

◆ WithVocabularyFilterName() [1/3]

Settings& Aws::TranscribeService::Model::Settings::WithVocabularyFilterName ( Aws::String &&  value)
inline

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

Definition at line 323 of file Settings.h.

◆ WithVocabularyFilterName() [2/3]

Settings& Aws::TranscribeService::Model::Settings::WithVocabularyFilterName ( const Aws::String value)
inline

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

Definition at line 316 of file Settings.h.

◆ WithVocabularyFilterName() [3/3]

Settings& Aws::TranscribeService::Model::Settings::WithVocabularyFilterName ( const char *  value)
inline

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.

Definition at line 330 of file Settings.h.

◆ WithVocabularyName() [1/3]

Settings& Aws::TranscribeService::Model::Settings::WithVocabularyName ( Aws::String &&  value)
inline

The name of a vocabulary to use when processing the transcription job.

Definition at line 75 of file Settings.h.

◆ WithVocabularyName() [2/3]

Settings& Aws::TranscribeService::Model::Settings::WithVocabularyName ( const Aws::String value)
inline

The name of a vocabulary to use when processing the transcription job.

Definition at line 70 of file Settings.h.

◆ WithVocabularyName() [3/3]

Settings& Aws::TranscribeService::Model::Settings::WithVocabularyName ( const char *  value)
inline

The name of a vocabulary to use when processing the transcription job.

Definition at line 80 of file Settings.h.


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