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

#include <Result.h>

Public Member Functions

 Result ()
 
 Result (Aws::Utils::Json::JsonView jsonValue)
 
Resultoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetResultId () const
 
bool ResultIdHasBeenSet () const
 
void SetResultId (const Aws::String &value)
 
void SetResultId (Aws::String &&value)
 
void SetResultId (const char *value)
 
ResultWithResultId (const Aws::String &value)
 
ResultWithResultId (Aws::String &&value)
 
ResultWithResultId (const char *value)
 
double GetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (double value)
 
ResultWithStartTime (double value)
 
double GetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (double value)
 
ResultWithEndTime (double value)
 
bool GetIsPartial () const
 
bool IsPartialHasBeenSet () const
 
void SetIsPartial (bool value)
 
ResultWithIsPartial (bool value)
 
const Aws::Vector< Alternative > & GetAlternatives () const
 
bool AlternativesHasBeenSet () const
 
void SetAlternatives (const Aws::Vector< Alternative > &value)
 
void SetAlternatives (Aws::Vector< Alternative > &&value)
 
ResultWithAlternatives (const Aws::Vector< Alternative > &value)
 
ResultWithAlternatives (Aws::Vector< Alternative > &&value)
 
ResultAddAlternatives (const Alternative &value)
 
ResultAddAlternatives (Alternative &&value)
 
const Aws::StringGetChannelId () const
 
bool ChannelIdHasBeenSet () const
 
void SetChannelId (const Aws::String &value)
 
void SetChannelId (Aws::String &&value)
 
void SetChannelId (const char *value)
 
ResultWithChannelId (const Aws::String &value)
 
ResultWithChannelId (Aws::String &&value)
 
ResultWithChannelId (const char *value)
 

Detailed Description

The result of transcribing a portion of the input audio stream.

See Also:

AWS API Reference

Definition at line 34 of file Result.h.

Constructor & Destructor Documentation

◆ Result() [1/2]

Aws::TranscribeStreamingService::Model::Result::Result ( )

◆ Result() [2/2]

Aws::TranscribeStreamingService::Model::Result::Result ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddAlternatives() [1/2]

Result& Aws::TranscribeStreamingService::Model::Result::AddAlternatives ( Alternative &&  value)
inline

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

Definition at line 225 of file Result.h.

◆ AddAlternatives() [2/2]

Result& Aws::TranscribeStreamingService::Model::Result::AddAlternatives ( const Alternative value)
inline

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

Definition at line 218 of file Result.h.

◆ AlternativesHasBeenSet()

bool Aws::TranscribeStreamingService::Model::Result::AlternativesHasBeenSet ( ) const
inline

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

Definition at line 183 of file Result.h.

◆ ChannelIdHasBeenSet()

bool Aws::TranscribeStreamingService::Model::Result::ChannelIdHasBeenSet ( ) const
inline

When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

Definition at line 242 of file Result.h.

◆ EndTimeHasBeenSet()

bool Aws::TranscribeStreamingService::Model::Result::EndTimeHasBeenSet ( ) const
inline

The offset in seconds from the beginning of the audio stream to the end of the result.

Definition at line 119 of file Result.h.

◆ GetAlternatives()

const Aws::Vector<Alternative>& Aws::TranscribeStreamingService::Model::Result::GetAlternatives ( ) const
inline

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

Definition at line 176 of file Result.h.

◆ GetChannelId()

const Aws::String& Aws::TranscribeStreamingService::Model::Result::GetChannelId ( ) const
inline

When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

Definition at line 234 of file Result.h.

◆ GetEndTime()

double Aws::TranscribeStreamingService::Model::Result::GetEndTime ( ) const
inline

The offset in seconds from the beginning of the audio stream to the end of the result.

Definition at line 113 of file Result.h.

◆ GetIsPartial()

bool Aws::TranscribeStreamingService::Model::Result::GetIsPartial ( ) const
inline

Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.

The IsPartial field is true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the segment.

Definition at line 141 of file Result.h.

◆ GetResultId()

const Aws::String& Aws::TranscribeStreamingService::Model::Result::GetResultId ( ) const
inline

A unique identifier for the result.

Definition at line 46 of file Result.h.

◆ GetStartTime()

double Aws::TranscribeStreamingService::Model::Result::GetStartTime ( ) const
inline

The offset in seconds from the beginning of the audio stream to the beginning of the result.

Definition at line 88 of file Result.h.

◆ IsPartialHasBeenSet()

bool Aws::TranscribeStreamingService::Model::Result::IsPartialHasBeenSet ( ) const
inline

Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.

The IsPartial field is true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the segment.

Definition at line 150 of file Result.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::TranscribeStreamingService::Model::Result::Jsonize ( ) const

◆ operator=()

Result& Aws::TranscribeStreamingService::Model::Result::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ResultIdHasBeenSet()

bool Aws::TranscribeStreamingService::Model::Result::ResultIdHasBeenSet ( ) const
inline

A unique identifier for the result.

Definition at line 51 of file Result.h.

◆ SetAlternatives() [1/2]

void Aws::TranscribeStreamingService::Model::Result::SetAlternatives ( Aws::Vector< Alternative > &&  value)
inline

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

Definition at line 197 of file Result.h.

◆ SetAlternatives() [2/2]

void Aws::TranscribeStreamingService::Model::Result::SetAlternatives ( const Aws::Vector< Alternative > &  value)
inline

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

Definition at line 190 of file Result.h.

◆ SetChannelId() [1/3]

void Aws::TranscribeStreamingService::Model::Result::SetChannelId ( Aws::String &&  value)
inline

When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

Definition at line 258 of file Result.h.

◆ SetChannelId() [2/3]

void Aws::TranscribeStreamingService::Model::Result::SetChannelId ( const Aws::String value)
inline

When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

Definition at line 250 of file Result.h.

◆ SetChannelId() [3/3]

void Aws::TranscribeStreamingService::Model::Result::SetChannelId ( const char *  value)
inline

When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

Definition at line 266 of file Result.h.

◆ SetEndTime()

void Aws::TranscribeStreamingService::Model::Result::SetEndTime ( double  value)
inline

The offset in seconds from the beginning of the audio stream to the end of the result.

Definition at line 125 of file Result.h.

◆ SetIsPartial()

void Aws::TranscribeStreamingService::Model::Result::SetIsPartial ( bool  value)
inline

Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.

The IsPartial field is true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the segment.

Definition at line 159 of file Result.h.

◆ SetResultId() [1/3]

void Aws::TranscribeStreamingService::Model::Result::SetResultId ( Aws::String &&  value)
inline

A unique identifier for the result.

Definition at line 61 of file Result.h.

◆ SetResultId() [2/3]

void Aws::TranscribeStreamingService::Model::Result::SetResultId ( const Aws::String value)
inline

A unique identifier for the result.

Definition at line 56 of file Result.h.

◆ SetResultId() [3/3]

void Aws::TranscribeStreamingService::Model::Result::SetResultId ( const char *  value)
inline

A unique identifier for the result.

Definition at line 66 of file Result.h.

◆ SetStartTime()

void Aws::TranscribeStreamingService::Model::Result::SetStartTime ( double  value)
inline

The offset in seconds from the beginning of the audio stream to the beginning of the result.

Definition at line 100 of file Result.h.

◆ StartTimeHasBeenSet()

bool Aws::TranscribeStreamingService::Model::Result::StartTimeHasBeenSet ( ) const
inline

The offset in seconds from the beginning of the audio stream to the beginning of the result.

Definition at line 94 of file Result.h.

◆ WithAlternatives() [1/2]

Result& Aws::TranscribeStreamingService::Model::Result::WithAlternatives ( Aws::Vector< Alternative > &&  value)
inline

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

Definition at line 211 of file Result.h.

◆ WithAlternatives() [2/2]

Result& Aws::TranscribeStreamingService::Model::Result::WithAlternatives ( const Aws::Vector< Alternative > &  value)
inline

A list of possible transcriptions for the audio. Each alternative typically contains one item that contains the result of the transcription.

Definition at line 204 of file Result.h.

◆ WithChannelId() [1/3]

Result& Aws::TranscribeStreamingService::Model::Result::WithChannelId ( Aws::String &&  value)
inline

When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

Definition at line 282 of file Result.h.

◆ WithChannelId() [2/3]

Result& Aws::TranscribeStreamingService::Model::Result::WithChannelId ( const Aws::String value)
inline

When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

Definition at line 274 of file Result.h.

◆ WithChannelId() [3/3]

Result& Aws::TranscribeStreamingService::Model::Result::WithChannelId ( const char *  value)
inline

When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

Definition at line 290 of file Result.h.

◆ WithEndTime()

Result& Aws::TranscribeStreamingService::Model::Result::WithEndTime ( double  value)
inline

The offset in seconds from the beginning of the audio stream to the end of the result.

Definition at line 131 of file Result.h.

◆ WithIsPartial()

Result& Aws::TranscribeStreamingService::Model::Result::WithIsPartial ( bool  value)
inline

Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.

The IsPartial field is true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the segment.

Definition at line 168 of file Result.h.

◆ WithResultId() [1/3]

Result& Aws::TranscribeStreamingService::Model::Result::WithResultId ( Aws::String &&  value)
inline

A unique identifier for the result.

Definition at line 76 of file Result.h.

◆ WithResultId() [2/3]

Result& Aws::TranscribeStreamingService::Model::Result::WithResultId ( const Aws::String value)
inline

A unique identifier for the result.

Definition at line 71 of file Result.h.

◆ WithResultId() [3/3]

Result& Aws::TranscribeStreamingService::Model::Result::WithResultId ( const char *  value)
inline

A unique identifier for the result.

Definition at line 81 of file Result.h.

◆ WithStartTime()

Result& Aws::TranscribeStreamingService::Model::Result::WithStartTime ( double  value)
inline

The offset in seconds from the beginning of the audio stream to the beginning of the result.

Definition at line 106 of file Result.h.


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