software.amazon.awssdk.services.transcribestreaming

Interface TranscribeStreamingAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

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

Operations and objects for transcribing streaming speech to text.

Field Summary

Fields

Modifier and Type	Field and Description
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 CompletableFuture<Void>	startStreamTranscription(Consumer<StartStreamTranscriptionRequest.Builder> startStreamTranscriptionRequest, org.reactivestreams.Publisher<AudioStream> requestStream, StartStreamTranscriptionResponseHandler asyncResponseHandler) Starts a bidirectional HTTP2 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 HTTP2 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

Method Detail

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.

startStreamTranscription

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

Starts a bidirectional HTTP2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following are encoded as HTTP2 headers:

• x-amzn-transcribe-language-code

• x-amzn-transcribe-media-encoding

• x-amzn-transcribe-sample-rate

• x-amzn-transcribe-session-id

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 operation was invalid. For example, MediaEncoding was not set to pcm or LanguageCode was not set to a valid code. Check the parameters and try your request again.
• LimitExceededException You have exceeded the maximum number of concurrent transcription streams, are starting transcription streams too quickly, or the maximum audio length of 4 hours. Wait until a stream has finished processing, or break your audio stream into smaller chunks and try your request again.
• InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. Try your request again.
• ConflictException A new stream started with the same session ID. The current stream has been terminated.
• 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 HTTP2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following are encoded as HTTP2 headers:

• x-amzn-transcribe-language-code

• x-amzn-transcribe-media-encoding

• x-amzn-transcribe-sample-rate

• x-amzn-transcribe-session-id

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 operation was invalid. For example, MediaEncoding was not set to pcm or LanguageCode was not set to a valid code. Check the parameters and try your request again.
• LimitExceededException You have exceeded the maximum number of concurrent transcription streams, are starting transcription streams too quickly, or the maximum audio length of 4 hours. Wait until a stream has finished processing, or break your audio stream into smaller chunks and try your request again.
• InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing. Try your request again.
• ConflictException A new stream started with the same session ID. The current stream has been terminated.
• 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