software.amazon.awssdk.services.transcribestreaming

Interface TranscribeStreamingAsyncClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface TranscribeStreamingAsyncClient
extends AwsClient

Service client for accessing Amazon Transcribe Streaming Service asynchronously. This can be created using the static builder() method.

Amazon Transcribe streaming offers three main types of real-time transcription: Standard, Medical, and Call Analytics.

• Standard transcriptions are the most common option. Refer to for details.

• Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to for details.

• Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static TranscribeStreamingAsyncClientBuilder	builder() Create a builder that can be used to configure and create a TranscribeStreamingAsyncClient.
static TranscribeStreamingAsyncClient	create() Create a TranscribeStreamingAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default TranscribeStreamingServiceClientConfiguration	serviceClientConfiguration()
default CompletableFuture<Void>	startCallAnalyticsStreamTranscription(Consumer<StartCallAnalyticsStreamTranscriptionRequest.Builder> startCallAnalyticsStreamTranscriptionRequest, org.reactivestreams.Publisher<AudioStream> requestStream, StartCallAnalyticsStreamTranscriptionResponseHandler asyncResponseHandler) Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
default CompletableFuture<Void>	startCallAnalyticsStreamTranscription(StartCallAnalyticsStreamTranscriptionRequest startCallAnalyticsStreamTranscriptionRequest, org.reactivestreams.Publisher<AudioStream> requestStream, StartCallAnalyticsStreamTranscriptionResponseHandler asyncResponseHandler) Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
default CompletableFuture<Void>	startMedicalStreamTranscription(Consumer<StartMedicalStreamTranscriptionRequest.Builder> startMedicalStreamTranscriptionRequest, org.reactivestreams.Publisher<AudioStream> requestStream, StartMedicalStreamTranscriptionResponseHandler asyncResponseHandler) Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.
default CompletableFuture<Void>	startMedicalStreamTranscription(StartMedicalStreamTranscriptionRequest startMedicalStreamTranscriptionRequest, org.reactivestreams.Publisher<AudioStream> requestStream, StartMedicalStreamTranscriptionResponseHandler asyncResponseHandler) Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.
default CompletableFuture<Void>	startStreamTranscription(Consumer<StartStreamTranscriptionRequest.Builder> startStreamTranscriptionRequest, org.reactivestreams.Publisher<AudioStream> requestStream, StartStreamTranscriptionResponseHandler asyncResponseHandler) Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
default CompletableFuture<Void>	startStreamTranscription(StartStreamTranscriptionRequest startStreamTranscriptionRequest, org.reactivestreams.Publisher<AudioStream> requestStream, StartStreamTranscriptionResponseHandler asyncResponseHandler) Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

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

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

startCallAnalyticsStreamTranscription

default CompletableFuture<Void> startCallAnalyticsStreamTranscription(StartCallAnalyticsStreamTranscriptionRequest startCallAnalyticsStreamTranscriptionRequest,
                                                                      org.reactivestreams.Publisher<AudioStream> requestStream,
                                                                      StartCallAnalyticsStreamTranscriptionResponseHandler asyncResponseHandler)

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. Use this operation for Call Analytics transcriptions.

The following parameters are required:

• language-code

• media-encoding

• sample-rate

For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.

Parameters:

startCallAnalyticsStreamTranscriptionRequest -

Returns:

A Java Future containing the result of the StartCallAnalyticsStreamTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
• LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
• InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
• ConflictException A new stream started with the same session ID. The current stream has been terminated.
• ServiceUnavailableException The service is currently unavailable. Try your request later.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranscribeStreamingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

startCallAnalyticsStreamTranscription

default CompletableFuture<Void> startCallAnalyticsStreamTranscription(Consumer<StartCallAnalyticsStreamTranscriptionRequest.Builder> startCallAnalyticsStreamTranscriptionRequest,
                                                                      org.reactivestreams.Publisher<AudioStream> requestStream,
                                                                      StartCallAnalyticsStreamTranscriptionResponseHandler asyncResponseHandler)

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. Use this operation for Call Analytics transcriptions.

The following parameters are required:

• language-code

• media-encoding

• sample-rate

For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.

This is a convenience which creates an instance of the StartCallAnalyticsStreamTranscriptionRequest.Builder avoiding the need to create one manually via StartCallAnalyticsStreamTranscriptionRequest.builder()

Parameters:

startCallAnalyticsStreamTranscriptionRequest - A Consumer that will call methods on StartCallAnalyticsStreamTranscriptionRequest.Builder to create a request.

Returns:

A Java Future containing the result of the StartCallAnalyticsStreamTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
• LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
• InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
• ConflictException A new stream started with the same session ID. The current stream has been terminated.
• ServiceUnavailableException The service is currently unavailable. Try your request later.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranscribeStreamingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

startMedicalStreamTranscription

default CompletableFuture<Void> startMedicalStreamTranscription(StartMedicalStreamTranscriptionRequest startMedicalStreamTranscriptionRequest,
                                                                org.reactivestreams.Publisher<AudioStream> requestStream,
                                                                StartMedicalStreamTranscriptionResponseHandler asyncResponseHandler)

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

The following parameters are required:

• language-code

• media-encoding

• sample-rate

For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio.

Parameters:

startMedicalStreamTranscriptionRequest -

Returns:

A Java Future containing the result of the StartMedicalStreamTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
• LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
• InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
• ConflictException A new stream started with the same session ID. The current stream has been terminated.
• ServiceUnavailableException The service is currently unavailable. Try your request later.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranscribeStreamingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

startMedicalStreamTranscription

default CompletableFuture<Void> startMedicalStreamTranscription(Consumer<StartMedicalStreamTranscriptionRequest.Builder> startMedicalStreamTranscriptionRequest,
                                                                org.reactivestreams.Publisher<AudioStream> requestStream,
                                                                StartMedicalStreamTranscriptionResponseHandler asyncResponseHandler)

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

The following parameters are required:

• language-code

• media-encoding

• sample-rate

For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio.

This is a convenience which creates an instance of the StartMedicalStreamTranscriptionRequest.Builder avoiding the need to create one manually via StartMedicalStreamTranscriptionRequest.builder()

Parameters:

startMedicalStreamTranscriptionRequest - A Consumer that will call methods on StartMedicalStreamTranscriptionRequest.Builder to create a request.

Returns:

A Java Future containing the result of the StartMedicalStreamTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
• LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
• InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
• ConflictException A new stream started with the same session ID. The current stream has been terminated.
• ServiceUnavailableException The service is currently unavailable. Try your request later.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranscribeStreamingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

startStreamTranscription

default CompletableFuture<Void> startStreamTranscription(StartStreamTranscriptionRequest startStreamTranscriptionRequest,
                                                         org.reactivestreams.Publisher<AudioStream> requestStream,
                                                         StartStreamTranscriptionResponseHandler asyncResponseHandler)

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following parameters are required:

• language-code or identify-language

• media-encoding

• sample-rate

For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.

Parameters:

startStreamTranscriptionRequest -

Returns:

A Java Future containing the result of the StartStreamTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
• LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
• InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
• ConflictException A new stream started with the same session ID. The current stream has been terminated.
• ServiceUnavailableException The service is currently unavailable. Try your request later.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranscribeStreamingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

startStreamTranscription

default CompletableFuture<Void> startStreamTranscription(Consumer<StartStreamTranscriptionRequest.Builder> startStreamTranscriptionRequest,
                                                         org.reactivestreams.Publisher<AudioStream> requestStream,
                                                         StartStreamTranscriptionResponseHandler asyncResponseHandler)

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following parameters are required:

• language-code or identify-language

• media-encoding

• sample-rate

For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.

This is a convenience which creates an instance of the StartStreamTranscriptionRequest.Builder avoiding the need to create one manually via StartStreamTranscriptionRequest.builder()

Parameters:

startStreamTranscriptionRequest - A Consumer that will call methods on StartStreamTranscriptionRequest.Builder to create a request.

Returns:

A Java Future containing the result of the StartStreamTranscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
• LimitExceededException Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.
• InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
• ConflictException A new stream started with the same session ID. The current stream has been terminated.
• ServiceUnavailableException The service is currently unavailable. Try your request later.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranscribeStreamingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

serviceClientConfiguration

default TranscribeStreamingServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

create

static TranscribeStreamingAsyncClient create()

Create a TranscribeStreamingAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static TranscribeStreamingAsyncClientBuilder builder()

Create a builder that can be used to configure and create a TranscribeStreamingAsyncClient.