TranscribeStreaming | Transcribe Streaming Client

Operations and objects for transcribing streaming speech to text.

Hierarchy

TranscribeStreamingClient
TranscribeStreamingClient
- TranscribeStreaming

Implements

Client<ServiceInputTypes, ServiceOutputTypes, TranscribeStreamingClientResolvedConfig>
Client<ServiceInputTypes, ServiceOutputTypes, TranscribeStreamingClientResolvedConfig>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TranscribeStreaming(configuration: TranscribeStreamingClientConfig): TranscribeStreaming

Inherited from TranscribeStreamingClient.constructor

Overrides Client.constructor
- Defined in clients/client-transcribe-streaming/dist-types/TranscribeStreamingClient.d.ts:149
Parameters
- configuration: TranscribeStreamingClientConfig
Returns TranscribeStreaming

Properties

Readonly config

config: TranscribeStreamingClientResolvedConfig

The resolved configuration of TranscribeStreamingClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

destroy

destroy(): void

Inherited from TranscribeStreamingClient.destroy

Overrides Client.destroy
- Defined in clients/client-transcribe-streaming/dist-types/TranscribeStreamingClient.d.ts:156
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void

send

send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options?: HandlerOptions): Promise<OutputType>
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, cb: (err: any, data?: OutputType) => void): void
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options: __HttpHandlerOptions, cb: (err: any, data?: OutputType) => void): void

Inherited from TranscribeStreamingClient.send

Overrides TranscribeStreamingClient.send
- Defined in packages/smithy-client/dist-types/client.d.ts:16
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- Optional options: HandlerOptions
Returns Promise<OutputType>
Inherited from TranscribeStreamingClient.send

Overrides TranscribeStreamingClient.send
- Defined in packages/smithy-client/dist-types/client.d.ts:17
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void
Inherited from TranscribeStreamingClient.send

Overrides TranscribeStreamingClient.send
- Defined in packages/smithy-client/dist-types/client.d.ts:18
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- options: __HttpHandlerOptions
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void

startMedicalStreamTranscription

startMedicalStreamTranscription(args: StartMedicalStreamTranscriptionCommandInput, options?: __HttpHandlerOptions): Promise<StartMedicalStreamTranscriptionCommandOutput>
startMedicalStreamTranscription(args: StartMedicalStreamTranscriptionCommandInput, cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void): void
startMedicalStreamTranscription(args: StartMedicalStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void): void
startMedicalStreamTranscription(args: StartMedicalStreamTranscriptionCommandInput, options?: __HttpHandlerOptions): Promise<StartMedicalStreamTranscriptionCommandOutput>
startMedicalStreamTranscription(args: StartMedicalStreamTranscriptionCommandInput, cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void): void
startMedicalStreamTranscription(args: StartMedicalStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void): void

- Defined in clients/client-transcribe-streaming/dist-types/TranscribeStreaming.d.ts:13
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

Parameters
- args: StartMedicalStreamTranscriptionCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<StartMedicalStreamTranscriptionCommandOutput>
- Defined in clients/client-transcribe-streaming/dist-types/TranscribeStreaming.d.ts:14
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

Parameters
- args: StartMedicalStreamTranscriptionCommandInput
- cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void
  - - (err: any, data?: StartMedicalStreamTranscriptionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: StartMedicalStreamTranscriptionCommandOutput
      Returns void
Returns void
- Defined in clients/client-transcribe-streaming/dist-types/TranscribeStreaming.d.ts:15
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

Parameters
- args: StartMedicalStreamTranscriptionCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void
  - - (err: any, data?: StartMedicalStreamTranscriptionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: StartMedicalStreamTranscriptionCommandOutput
      Returns void
Returns void
- Defined in clients/client-transcribe-streaming/src/TranscribeStreaming.ts:24
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

Parameters
- args: StartMedicalStreamTranscriptionCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<StartMedicalStreamTranscriptionCommandOutput>
- Defined in clients/client-transcribe-streaming/src/TranscribeStreaming.ts:28
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

Parameters
- args: StartMedicalStreamTranscriptionCommandInput
- cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void
  - - (err: any, data?: StartMedicalStreamTranscriptionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: StartMedicalStreamTranscriptionCommandOutput
      Returns void
Returns void
- Defined in clients/client-transcribe-streaming/src/TranscribeStreaming.ts:32
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

Parameters
- args: StartMedicalStreamTranscriptionCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void
  - - (err: any, data?: StartMedicalStreamTranscriptionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: StartMedicalStreamTranscriptionCommandOutput
      Returns void
Returns void

startStreamTranscription

startStreamTranscription(args: StartStreamTranscriptionCommandInput, options?: __HttpHandlerOptions): Promise<StartStreamTranscriptionCommandOutput>
startStreamTranscription(args: StartStreamTranscriptionCommandInput, cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void): void
startStreamTranscription(args: StartStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void): void
startStreamTranscription(args: StartStreamTranscriptionCommandInput, options?: __HttpHandlerOptions): Promise<StartStreamTranscriptionCommandOutput>
startStreamTranscription(args: StartStreamTranscriptionCommandInput, cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void): void
startStreamTranscription(args: StartStreamTranscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void): void

- Defined in clients/client-transcribe-streaming/dist-types/TranscribeStreaming.d.ts:36
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following are encoded as HTTP/2 headers:
- x-amzn-transcribe-language-code
- x-amzn-transcribe-media-encoding
- x-amzn-transcribe-sample-rate
- x-amzn-transcribe-session-id
See the SDK for Go API Reference for more detail.
Parameters
- args: StartStreamTranscriptionCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<StartStreamTranscriptionCommandOutput>
- Defined in clients/client-transcribe-streaming/dist-types/TranscribeStreaming.d.ts:37
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following are encoded as HTTP/2 headers:
- x-amzn-transcribe-language-code
- x-amzn-transcribe-media-encoding
- x-amzn-transcribe-sample-rate
- x-amzn-transcribe-session-id
See the SDK for Go API Reference for more detail.
Parameters
- args: StartStreamTranscriptionCommandInput
- cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void
  - - (err: any, data?: StartStreamTranscriptionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: StartStreamTranscriptionCommandOutput
      Returns void
Returns void
- Defined in clients/client-transcribe-streaming/dist-types/TranscribeStreaming.d.ts:38
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following are encoded as HTTP/2 headers:
- x-amzn-transcribe-language-code
- x-amzn-transcribe-media-encoding
- x-amzn-transcribe-sample-rate
- x-amzn-transcribe-session-id
See the SDK for Go API Reference for more detail.
Parameters
- args: StartStreamTranscriptionCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void
  - - (err: any, data?: StartStreamTranscriptionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: StartStreamTranscriptionCommandOutput
      Returns void
Returns void
- Defined in clients/client-transcribe-streaming/src/TranscribeStreaming.ts:73
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following are encoded as HTTP/2 headers:
- x-amzn-transcribe-language-code
- x-amzn-transcribe-media-encoding
- x-amzn-transcribe-sample-rate
- x-amzn-transcribe-session-id
See the SDK for Go API Reference for more detail.
Parameters
- args: StartStreamTranscriptionCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<StartStreamTranscriptionCommandOutput>
- Defined in clients/client-transcribe-streaming/src/TranscribeStreaming.ts:77
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following are encoded as HTTP/2 headers:
- x-amzn-transcribe-language-code
- x-amzn-transcribe-media-encoding
- x-amzn-transcribe-sample-rate
- x-amzn-transcribe-session-id
See the SDK for Go API Reference for more detail.
Parameters
- args: StartStreamTranscriptionCommandInput
- cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void
  - - (err: any, data?: StartStreamTranscriptionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: StartStreamTranscriptionCommandOutput
      Returns void
Returns void
- Defined in clients/client-transcribe-streaming/src/TranscribeStreaming.ts:81
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following are encoded as HTTP/2 headers:
- x-amzn-transcribe-language-code
- x-amzn-transcribe-media-encoding
- x-amzn-transcribe-sample-rate
- x-amzn-transcribe-session-id
See the SDK for Go API Reference for more detail.
Parameters
- args: StartStreamTranscriptionCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: StartStreamTranscriptionCommandOutput) => void
  - - (err: any, data?: StartStreamTranscriptionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: StartStreamTranscriptionCommandOutput
      Returns void
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: TranscribeStreamingClientConfig

Returns TranscribeStreaming

Properties

Readonly config

middlewareStack

Methods

destroy

Returns void

send

Type parameters

InputType: ServiceInputTypes

OutputType: ServiceOutputTypes

Parameters

command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>

Optional options: HandlerOptions

Returns Promise<OutputType>

Type parameters

InputType: ServiceInputTypes

OutputType: ServiceOutputTypes

Parameters

command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>

cb: (err: any, data?: OutputType) => void

Parameters

err: any

Optional data: OutputType

Returns void

Returns void

Type parameters

InputType: ServiceInputTypes

OutputType: ServiceOutputTypes

Parameters

command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>

options: __HttpHandlerOptions

cb: (err: any, data?: OutputType) => void

Parameters

err: any

Optional data: OutputType

Returns void

Returns void

startMedicalStreamTranscription

Parameters

args: StartMedicalStreamTranscriptionCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<StartMedicalStreamTranscriptionCommandOutput>

Parameters

args: StartMedicalStreamTranscriptionCommandInput

cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void

Parameters

err: any

Optional data: StartMedicalStreamTranscriptionCommandOutput

Returns void

Returns void

Parameters

args: StartMedicalStreamTranscriptionCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void

Parameters

err: any

Optional data: StartMedicalStreamTranscriptionCommandOutput

Returns void

Returns void

Parameters

args: StartMedicalStreamTranscriptionCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<StartMedicalStreamTranscriptionCommandOutput>

Parameters

args: StartMedicalStreamTranscriptionCommandInput

cb: (err: any, data?: StartMedicalStreamTranscriptionCommandOutput) => void

Parameters

err: any

Optional data: StartMedicalStreamTranscriptionCommandOutput