AWS SDK for C++  1.9.71
AWS SDK for C++
Public Member Functions | List of all members
Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest Class Reference

#include <StartStreamTranscriptionRequest.h>

+ Inheritance diagram for Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest:

Public Member Functions

 StartStreamTranscriptionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
virtual bool IsEventStreamRequest () const override
 
Aws::String SerializePayload () const override
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
Aws::Utils::Event::EventStreamDecoderGetEventStreamDecoder ()
 
const StartStreamTranscriptionHandlerGetEventStreamHandler () const
 
void SetEventStreamHandler (const StartStreamTranscriptionHandler &value)
 
StartStreamTranscriptionRequestWithEventStreamHandler (const StartStreamTranscriptionHandler &value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
StartStreamTranscriptionRequestWithLanguageCode (const LanguageCode &value)
 
StartStreamTranscriptionRequestWithLanguageCode (LanguageCode &&value)
 
int GetMediaSampleRateHertz () const
 
bool MediaSampleRateHertzHasBeenSet () const
 
void SetMediaSampleRateHertz (int value)
 
StartStreamTranscriptionRequestWithMediaSampleRateHertz (int value)
 
const MediaEncodingGetMediaEncoding () const
 
bool MediaEncodingHasBeenSet () const
 
void SetMediaEncoding (const MediaEncoding &value)
 
void SetMediaEncoding (MediaEncoding &&value)
 
StartStreamTranscriptionRequestWithMediaEncoding (const MediaEncoding &value)
 
StartStreamTranscriptionRequestWithMediaEncoding (MediaEncoding &&value)
 
const Aws::StringGetVocabularyName () const
 
bool VocabularyNameHasBeenSet () const
 
void SetVocabularyName (const Aws::String &value)
 
void SetVocabularyName (Aws::String &&value)
 
void SetVocabularyName (const char *value)
 
StartStreamTranscriptionRequestWithVocabularyName (const Aws::String &value)
 
StartStreamTranscriptionRequestWithVocabularyName (Aws::String &&value)
 
StartStreamTranscriptionRequestWithVocabularyName (const char *value)
 
const Aws::StringGetSessionId () const
 
bool SessionIdHasBeenSet () const
 
void SetSessionId (const Aws::String &value)
 
void SetSessionId (Aws::String &&value)
 
void SetSessionId (const char *value)
 
StartStreamTranscriptionRequestWithSessionId (const Aws::String &value)
 
StartStreamTranscriptionRequestWithSessionId (Aws::String &&value)
 
StartStreamTranscriptionRequestWithSessionId (const char *value)
 
std::shared_ptr< AudioStreamGetAudioStream () const
 
void SetAudioStream (const std::shared_ptr< AudioStream > &value)
 
StartStreamTranscriptionRequestWithAudioStream (const std::shared_ptr< AudioStream > &value)
 
const Aws::StringGetVocabularyFilterName () const
 
bool VocabularyFilterNameHasBeenSet () const
 
void SetVocabularyFilterName (const Aws::String &value)
 
void SetVocabularyFilterName (Aws::String &&value)
 
void SetVocabularyFilterName (const char *value)
 
StartStreamTranscriptionRequestWithVocabularyFilterName (const Aws::String &value)
 
StartStreamTranscriptionRequestWithVocabularyFilterName (Aws::String &&value)
 
StartStreamTranscriptionRequestWithVocabularyFilterName (const char *value)
 
const VocabularyFilterMethodGetVocabularyFilterMethod () const
 
bool VocabularyFilterMethodHasBeenSet () const
 
void SetVocabularyFilterMethod (const VocabularyFilterMethod &value)
 
void SetVocabularyFilterMethod (VocabularyFilterMethod &&value)
 
StartStreamTranscriptionRequestWithVocabularyFilterMethod (const VocabularyFilterMethod &value)
 
StartStreamTranscriptionRequestWithVocabularyFilterMethod (VocabularyFilterMethod &&value)
 
bool GetShowSpeakerLabel () const
 
bool ShowSpeakerLabelHasBeenSet () const
 
void SetShowSpeakerLabel (bool value)
 
StartStreamTranscriptionRequestWithShowSpeakerLabel (bool value)
 
bool GetEnableChannelIdentification () const
 
bool EnableChannelIdentificationHasBeenSet () const
 
void SetEnableChannelIdentification (bool value)
 
StartStreamTranscriptionRequestWithEnableChannelIdentification (bool value)
 
int GetNumberOfChannels () const
 
bool NumberOfChannelsHasBeenSet () const
 
void SetNumberOfChannels (int value)
 
StartStreamTranscriptionRequestWithNumberOfChannels (int value)
 
bool GetEnablePartialResultsStabilization () const
 
bool EnablePartialResultsStabilizationHasBeenSet () const
 
void SetEnablePartialResultsStabilization (bool value)
 
StartStreamTranscriptionRequestWithEnablePartialResultsStabilization (bool value)
 
const PartialResultsStabilityGetPartialResultsStability () const
 
bool PartialResultsStabilityHasBeenSet () const
 
void SetPartialResultsStability (const PartialResultsStability &value)
 
void SetPartialResultsStability (PartialResultsStability &&value)
 
StartStreamTranscriptionRequestWithPartialResultsStability (const PartialResultsStability &value)
 
StartStreamTranscriptionRequestWithPartialResultsStability (PartialResultsStability &&value)
 
- Public Member Functions inherited from Aws::TranscribeStreamingService::TranscribeStreamingServiceRequest
virtual ~TranscribeStreamingServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 29 of file StartStreamTranscriptionRequest.h.

Constructor & Destructor Documentation

◆ StartStreamTranscriptionRequest()

Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::StartStreamTranscriptionRequest ( )

Member Function Documentation

◆ EnableChannelIdentificationHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::EnableChannelIdentificationHasBeenSet ( ) const
inline

When true, 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. An item includes the start time, end time, and any alternative transcriptions.

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

Definition at line 427 of file StartStreamTranscriptionRequest.h.

◆ EnablePartialResultsStabilizationHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::EnablePartialResultsStabilizationHasBeenSet ( ) const
inline

When true, instructs Amazon Transcribe to present transcription results that have the partial results stabilized. Normally, any word or phrase from one partial result can change in a subsequent partial result. With partial results stabilization enabled, only the last few words of one partial result can change in another partial result.

Definition at line 489 of file StartStreamTranscriptionRequest.h.

◆ GetAudioStream()

std::shared_ptr<AudioStream> Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetAudioStream ( ) const
inline

PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP2 data frame.

Definition at line 257 of file StartStreamTranscriptionRequest.h.

◆ GetBody()

std::shared_ptr<Aws::IOStream> Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetBody ( ) const
overridevirtual

Loads serialized payload into string buf and returns the stream

Reimplemented from Aws::AmazonSerializableWebServiceRequest.

◆ GetEnableChannelIdentification()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetEnableChannelIdentification ( ) const
inline

When true, 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. An item includes the start time, end time, and any alternative transcriptions.

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

Definition at line 416 of file StartStreamTranscriptionRequest.h.

◆ GetEnablePartialResultsStabilization()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetEnablePartialResultsStabilization ( ) const
inline

When true, instructs Amazon Transcribe to present transcription results that have the partial results stabilized. Normally, any word or phrase from one partial result can change in a subsequent partial result. With partial results stabilization enabled, only the last few words of one partial result can change in another partial result.

Definition at line 480 of file StartStreamTranscriptionRequest.h.

◆ GetEventStreamDecoder()

Aws::Utils::Event::EventStreamDecoder& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetEventStreamDecoder ( )
inline

Underlying Event Stream Decoder.

Definition at line 50 of file StartStreamTranscriptionRequest.h.

◆ GetEventStreamHandler()

const StartStreamTranscriptionHandler& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetEventStreamHandler ( ) const
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 55 of file StartStreamTranscriptionRequest.h.

◆ GetLanguageCode()

const LanguageCode& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetLanguageCode ( ) const
inline

Indicates the source language used in the input audio stream.

Definition at line 71 of file StartStreamTranscriptionRequest.h.

◆ GetMediaEncoding()

const MediaEncoding& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetMediaEncoding ( ) const
inline

The encoding used for the input audio.

Definition at line 127 of file StartStreamTranscriptionRequest.h.

◆ GetMediaSampleRateHertz()

int Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetMediaSampleRateHertz ( ) const
inline

The sample rate, in Hertz, of the input audio. We suggest that you use 8000 Hz for low quality audio and 16000 Hz for high quality audio.

Definition at line 103 of file StartStreamTranscriptionRequest.h.

◆ GetNumberOfChannels()

int Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetNumberOfChannels ( ) const
inline

The number of channels that are in your audio stream.

Definition at line 455 of file StartStreamTranscriptionRequest.h.

◆ GetPartialResultsStability()

const PartialResultsStability& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetPartialResultsStability ( ) const
inline

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

Definition at line 516 of file StartStreamTranscriptionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file StartStreamTranscriptionRequest.h.

◆ GetSessionId()

const Aws::String& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetSessionId ( ) const
inline

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Definition at line 201 of file StartStreamTranscriptionRequest.h.

◆ GetShowSpeakerLabel()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetShowSpeakerLabel ( ) const
inline

When true, enables speaker identification in your real-time stream.

Definition at line 386 of file StartStreamTranscriptionRequest.h.

◆ GetVocabularyFilterMethod()

const VocabularyFilterMethod& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetVocabularyFilterMethod ( ) const
inline

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks those words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True

Definition at line 329 of file StartStreamTranscriptionRequest.h.

◆ GetVocabularyFilterName()

const Aws::String& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetVocabularyFilterName ( ) const
inline

The name of the vocabulary filter you've created that is unique to your AWS account. Provide the name in this field to successfully use it in a stream.

Definition at line 276 of file StartStreamTranscriptionRequest.h.

◆ GetVocabularyName()

const Aws::String& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::GetVocabularyName ( ) const
inline

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

Definition at line 158 of file StartStreamTranscriptionRequest.h.

◆ IsEventStreamRequest()

virtual bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::IsEventStreamRequest ( ) const
inlineoverridevirtual

Defaults to false, if this is set to true in derived class, it's an event stream request, which means the payload is consisted by multiple structured events.

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 40 of file StartStreamTranscriptionRequest.h.

◆ LanguageCodeHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::LanguageCodeHasBeenSet ( ) const
inline

Indicates the source language used in the input audio stream.

Definition at line 76 of file StartStreamTranscriptionRequest.h.

◆ MediaEncodingHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::MediaEncodingHasBeenSet ( ) const
inline

The encoding used for the input audio.

Definition at line 132 of file StartStreamTranscriptionRequest.h.

◆ MediaSampleRateHertzHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::MediaSampleRateHertzHasBeenSet ( ) const
inline

The sample rate, in Hertz, of the input audio. We suggest that you use 8000 Hz for low quality audio and 16000 Hz for high quality audio.

Definition at line 109 of file StartStreamTranscriptionRequest.h.

◆ NumberOfChannelsHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::NumberOfChannelsHasBeenSet ( ) const
inline

The number of channels that are in your audio stream.

Definition at line 460 of file StartStreamTranscriptionRequest.h.

◆ PartialResultsStabilityHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::PartialResultsStabilityHasBeenSet ( ) const
inline

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

Definition at line 524 of file StartStreamTranscriptionRequest.h.

◆ SerializePayload()

Aws::String Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SerializePayload ( ) const
inlineoverridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

Definition at line 43 of file StartStreamTranscriptionRequest.h.

◆ SessionIdHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SessionIdHasBeenSet ( ) const
inline

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Definition at line 208 of file StartStreamTranscriptionRequest.h.

◆ SetAudioStream()

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetAudioStream ( const std::shared_ptr< AudioStream > &  value)
inline

PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP2 data frame.

Definition at line 263 of file StartStreamTranscriptionRequest.h.

◆ SetEnableChannelIdentification()

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetEnableChannelIdentification ( bool  value)
inline

When true, 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. An item includes the start time, end time, and any alternative transcriptions.

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

Definition at line 438 of file StartStreamTranscriptionRequest.h.

◆ SetEnablePartialResultsStabilization()

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetEnablePartialResultsStabilization ( bool  value)
inline

When true, instructs Amazon Transcribe to present transcription results that have the partial results stabilized. Normally, any word or phrase from one partial result can change in a subsequent partial result. With partial results stabilization enabled, only the last few words of one partial result can change in another partial result.

Definition at line 498 of file StartStreamTranscriptionRequest.h.

◆ SetEventStreamHandler()

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetEventStreamHandler ( const StartStreamTranscriptionHandler value)
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 60 of file StartStreamTranscriptionRequest.h.

◆ SetLanguageCode() [1/2]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetLanguageCode ( const LanguageCode value)
inline

Indicates the source language used in the input audio stream.

Definition at line 81 of file StartStreamTranscriptionRequest.h.

◆ SetLanguageCode() [2/2]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetLanguageCode ( LanguageCode &&  value)
inline

Indicates the source language used in the input audio stream.

Definition at line 86 of file StartStreamTranscriptionRequest.h.

◆ SetMediaEncoding() [1/2]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetMediaEncoding ( const MediaEncoding value)
inline

The encoding used for the input audio.

Definition at line 137 of file StartStreamTranscriptionRequest.h.

◆ SetMediaEncoding() [2/2]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetMediaEncoding ( MediaEncoding &&  value)
inline

The encoding used for the input audio.

Definition at line 142 of file StartStreamTranscriptionRequest.h.

◆ SetMediaSampleRateHertz()

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetMediaSampleRateHertz ( int  value)
inline

The sample rate, in Hertz, of the input audio. We suggest that you use 8000 Hz for low quality audio and 16000 Hz for high quality audio.

Definition at line 115 of file StartStreamTranscriptionRequest.h.

◆ SetNumberOfChannels()

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetNumberOfChannels ( int  value)
inline

The number of channels that are in your audio stream.

Definition at line 465 of file StartStreamTranscriptionRequest.h.

◆ SetPartialResultsStability() [1/2]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetPartialResultsStability ( const PartialResultsStability value)
inline

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

Definition at line 532 of file StartStreamTranscriptionRequest.h.

◆ SetPartialResultsStability() [2/2]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetPartialResultsStability ( PartialResultsStability &&  value)
inline

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

Definition at line 540 of file StartStreamTranscriptionRequest.h.

◆ SetSessionId() [1/3]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetSessionId ( Aws::String &&  value)
inline

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Definition at line 222 of file StartStreamTranscriptionRequest.h.

◆ SetSessionId() [2/3]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetSessionId ( const Aws::String value)
inline

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Definition at line 215 of file StartStreamTranscriptionRequest.h.

◆ SetSessionId() [3/3]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetSessionId ( const char *  value)
inline

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Definition at line 229 of file StartStreamTranscriptionRequest.h.

◆ SetShowSpeakerLabel()

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetShowSpeakerLabel ( bool  value)
inline

When true, enables speaker identification in your real-time stream.

Definition at line 398 of file StartStreamTranscriptionRequest.h.

◆ SetVocabularyFilterMethod() [1/2]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetVocabularyFilterMethod ( const VocabularyFilterMethod value)
inline

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks those words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True

Definition at line 349 of file StartStreamTranscriptionRequest.h.

◆ SetVocabularyFilterMethod() [2/2]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetVocabularyFilterMethod ( VocabularyFilterMethod &&  value)
inline

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks those words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True

Definition at line 359 of file StartStreamTranscriptionRequest.h.

◆ SetVocabularyFilterName() [1/3]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetVocabularyFilterName ( Aws::String &&  value)
inline

The name of the vocabulary filter you've created that is unique to your AWS account. Provide the name in this field to successfully use it in a stream.

Definition at line 294 of file StartStreamTranscriptionRequest.h.

◆ SetVocabularyFilterName() [2/3]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetVocabularyFilterName ( const Aws::String value)
inline

The name of the vocabulary filter you've created that is unique to your AWS account. Provide the name in this field to successfully use it in a stream.

Definition at line 288 of file StartStreamTranscriptionRequest.h.

◆ SetVocabularyFilterName() [3/3]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetVocabularyFilterName ( const char *  value)
inline

The name of the vocabulary filter you've created that is unique to your AWS account. Provide the name in this field to successfully use it in a stream.

Definition at line 300 of file StartStreamTranscriptionRequest.h.

◆ SetVocabularyName() [1/3]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetVocabularyName ( Aws::String &&  value)
inline

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

Definition at line 173 of file StartStreamTranscriptionRequest.h.

◆ SetVocabularyName() [2/3]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetVocabularyName ( const Aws::String value)
inline

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

Definition at line 168 of file StartStreamTranscriptionRequest.h.

◆ SetVocabularyName() [3/3]

void Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::SetVocabularyName ( const char *  value)
inline

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

Definition at line 178 of file StartStreamTranscriptionRequest.h.

◆ ShowSpeakerLabelHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::ShowSpeakerLabelHasBeenSet ( ) const
inline

When true, enables speaker identification in your real-time stream.

Definition at line 392 of file StartStreamTranscriptionRequest.h.

◆ VocabularyFilterMethodHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::VocabularyFilterMethodHasBeenSet ( ) const
inline

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks those words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True

Definition at line 339 of file StartStreamTranscriptionRequest.h.

◆ VocabularyFilterNameHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::VocabularyFilterNameHasBeenSet ( ) const
inline

The name of the vocabulary filter you've created that is unique to your AWS account. Provide the name in this field to successfully use it in a stream.

Definition at line 282 of file StartStreamTranscriptionRequest.h.

◆ VocabularyNameHasBeenSet()

bool Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::VocabularyNameHasBeenSet ( ) const
inline

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

Definition at line 163 of file StartStreamTranscriptionRequest.h.

◆ WithAudioStream()

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithAudioStream ( const std::shared_ptr< AudioStream > &  value)
inline

PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP2 data frame.

Definition at line 269 of file StartStreamTranscriptionRequest.h.

◆ WithEnableChannelIdentification()

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithEnableChannelIdentification ( bool  value)
inline

When true, 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. An item includes the start time, end time, and any alternative transcriptions.

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

Definition at line 449 of file StartStreamTranscriptionRequest.h.

◆ WithEnablePartialResultsStabilization()

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithEnablePartialResultsStabilization ( bool  value)
inline

When true, instructs Amazon Transcribe to present transcription results that have the partial results stabilized. Normally, any word or phrase from one partial result can change in a subsequent partial result. With partial results stabilization enabled, only the last few words of one partial result can change in another partial result.

Definition at line 507 of file StartStreamTranscriptionRequest.h.

◆ WithEventStreamHandler()

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithEventStreamHandler ( const StartStreamTranscriptionHandler value)
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 65 of file StartStreamTranscriptionRequest.h.

◆ WithLanguageCode() [1/2]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithLanguageCode ( const LanguageCode value)
inline

Indicates the source language used in the input audio stream.

Definition at line 91 of file StartStreamTranscriptionRequest.h.

◆ WithLanguageCode() [2/2]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithLanguageCode ( LanguageCode &&  value)
inline

Indicates the source language used in the input audio stream.

Definition at line 96 of file StartStreamTranscriptionRequest.h.

◆ WithMediaEncoding() [1/2]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithMediaEncoding ( const MediaEncoding value)
inline

The encoding used for the input audio.

Definition at line 147 of file StartStreamTranscriptionRequest.h.

◆ WithMediaEncoding() [2/2]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithMediaEncoding ( MediaEncoding &&  value)
inline

The encoding used for the input audio.

Definition at line 152 of file StartStreamTranscriptionRequest.h.

◆ WithMediaSampleRateHertz()

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithMediaSampleRateHertz ( int  value)
inline

The sample rate, in Hertz, of the input audio. We suggest that you use 8000 Hz for low quality audio and 16000 Hz for high quality audio.

Definition at line 121 of file StartStreamTranscriptionRequest.h.

◆ WithNumberOfChannels()

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithNumberOfChannels ( int  value)
inline

The number of channels that are in your audio stream.

Definition at line 470 of file StartStreamTranscriptionRequest.h.

◆ WithPartialResultsStability() [1/2]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithPartialResultsStability ( const PartialResultsStability value)
inline

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

Definition at line 548 of file StartStreamTranscriptionRequest.h.

◆ WithPartialResultsStability() [2/2]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithPartialResultsStability ( PartialResultsStability &&  value)
inline

You can use this field to set the stability level of the transcription results. A higher stability level means that the transcription results are less likely to change. Higher stability levels can come with lower overall transcription accuracy.

Definition at line 556 of file StartStreamTranscriptionRequest.h.

◆ WithSessionId() [1/3]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithSessionId ( Aws::String &&  value)
inline

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Definition at line 243 of file StartStreamTranscriptionRequest.h.

◆ WithSessionId() [2/3]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithSessionId ( const Aws::String value)
inline

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Definition at line 236 of file StartStreamTranscriptionRequest.h.

◆ WithSessionId() [3/3]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithSessionId ( const char *  value)
inline

A identifier for the transcription session. Use this parameter when you want to retry a session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in the response.

Definition at line 250 of file StartStreamTranscriptionRequest.h.

◆ WithShowSpeakerLabel()

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithShowSpeakerLabel ( bool  value)
inline

When true, enables speaker identification in your real-time stream.

Definition at line 404 of file StartStreamTranscriptionRequest.h.

◆ WithVocabularyFilterMethod() [1/2]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithVocabularyFilterMethod ( const VocabularyFilterMethod value)
inline

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks those words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True

Definition at line 369 of file StartStreamTranscriptionRequest.h.

◆ WithVocabularyFilterMethod() [2/2]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithVocabularyFilterMethod ( VocabularyFilterMethod &&  value)
inline

The manner in which you use your vocabulary filter to filter words in your transcript. Remove removes filtered words from your transcription results. Mask masks those words with a *** in your transcription results. Tag keeps the filtered words in your transcription results and tags them. The tag appears as VocabularyFilterMatch equal to True

Definition at line 379 of file StartStreamTranscriptionRequest.h.

◆ WithVocabularyFilterName() [1/3]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithVocabularyFilterName ( Aws::String &&  value)
inline

The name of the vocabulary filter you've created that is unique to your AWS account. Provide the name in this field to successfully use it in a stream.

Definition at line 312 of file StartStreamTranscriptionRequest.h.

◆ WithVocabularyFilterName() [2/3]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithVocabularyFilterName ( const Aws::String value)
inline

The name of the vocabulary filter you've created that is unique to your AWS account. Provide the name in this field to successfully use it in a stream.

Definition at line 306 of file StartStreamTranscriptionRequest.h.

◆ WithVocabularyFilterName() [3/3]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithVocabularyFilterName ( const char *  value)
inline

The name of the vocabulary filter you've created that is unique to your AWS account. Provide the name in this field to successfully use it in a stream.

Definition at line 318 of file StartStreamTranscriptionRequest.h.

◆ WithVocabularyName() [1/3]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithVocabularyName ( Aws::String &&  value)
inline

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

Definition at line 188 of file StartStreamTranscriptionRequest.h.

◆ WithVocabularyName() [2/3]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithVocabularyName ( const Aws::String value)
inline

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

Definition at line 183 of file StartStreamTranscriptionRequest.h.

◆ WithVocabularyName() [3/3]

StartStreamTranscriptionRequest& Aws::TranscribeStreamingService::Model::StartStreamTranscriptionRequest::WithVocabularyName ( const char *  value)
inline

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

Definition at line 193 of file StartStreamTranscriptionRequest.h.


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