software.amazon.awssdk.services.transcribestreaming.model

Interface Result.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Result.Builder,Result>, SdkBuilder<Result.Builder,Result>, SdkPojo

Enclosing class:

Result

public static interface Result.Builder
extends SdkPojo, CopyableBuilder<Result.Builder,Result>

Method Summary

Modifier and Type	Method and Description
Result.Builder	alternatives(Alternative... alternatives) A list of possible transcriptions for the audio.
Result.Builder	alternatives(Collection<Alternative> alternatives) A list of possible transcriptions for the audio.
Result.Builder	alternatives(Consumer<Alternative.Builder>... alternatives) A list of possible transcriptions for the audio.
Result.Builder	channelId(String channelId) When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.
Result.Builder	endTime(Double endTime) The offset in seconds from the beginning of the audio stream to the end of the result.
Result.Builder	isPartial(Boolean isPartial) Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio.
Result.Builder	languageCode(LanguageCode languageCode) The language code of the identified language in your media stream.
Result.Builder	languageCode(String languageCode) The language code of the identified language in your media stream.
Result.Builder	languageIdentification(Collection<LanguageWithScore> languageIdentification) The language code of the dominant language identified in your media.
Result.Builder	languageIdentification(Consumer<LanguageWithScore.Builder>... languageIdentification) The language code of the dominant language identified in your media.
Result.Builder	languageIdentification(LanguageWithScore... languageIdentification) The language code of the dominant language identified in your media.
Result.Builder	resultId(String resultId) A unique identifier for the result.
Result.Builder	startTime(Double startTime) The offset in seconds from the beginning of the audio stream to the beginning of the result.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

resultId

Result.Builder resultId(String resultId)

A unique identifier for the result.

Parameters:

resultId - A unique identifier for the result.

Returns:

Returns a reference to this object so that method calls can be chained together.

startTime

Result.Builder startTime(Double startTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

Result.Builder endTime(Double endTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isPartial

Result.Builder isPartial(Boolean isPartial)

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.

Parameters:

isPartial - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

alternatives

Result.Builder alternatives(Collection<Alternative> alternatives)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

alternatives

Result.Builder alternatives(Alternative... alternatives)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

alternatives

Result.Builder alternatives(Consumer<Alternative.Builder>... alternatives)

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

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #alternatives(List).

Parameters:

alternatives - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#alternatives(List)

channelId

Result.Builder channelId(String channelId)

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.

Parameters:

channelId - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

languageCode

Result.Builder languageCode(String languageCode)

The language code of the identified language in your media stream.

Parameters:

languageCode - The language code of the identified language in your media stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

languageCode

Result.Builder languageCode(LanguageCode languageCode)

The language code of the identified language in your media stream.

Parameters:

languageCode - The language code of the identified language in your media stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode, LanguageCode

languageIdentification

Result.Builder languageIdentification(Collection<LanguageWithScore> languageIdentification)

The language code of the dominant language identified in your media.

Parameters:

languageIdentification - The language code of the dominant language identified in your media.

Returns:

Returns a reference to this object so that method calls can be chained together.

languageIdentification

Result.Builder languageIdentification(LanguageWithScore... languageIdentification)

The language code of the dominant language identified in your media.

Parameters:

languageIdentification - The language code of the dominant language identified in your media.

Returns:

Returns a reference to this object so that method calls can be chained together.

languageIdentification

Result.Builder languageIdentification(Consumer<LanguageWithScore.Builder>... languageIdentification)

The language code of the dominant language identified in your media.

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #languageIdentification(List).

Parameters:

languageIdentification - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#languageIdentification(List)