Module @aws-sdk/middleware-sdk-transcribe-streaming

@aws-sdk/middleware-sdk-transcribe-streaming

Index

References

Classes

Interfaces

Type aliases

WithSession

Functions

Object literals

References

SignatureV4

Re-exports SignatureV4

WebSocketHandler

Re-exports WebSocketHandler

WebSocketHandlerOptions

Re-exports WebSocketHandlerOptions

WebSocketInputConfig

Re-exports WebSocketInputConfig

WebSocketResolvedConfig

Re-exports WebSocketResolvedConfig

eventStreamPayloadHandler

Re-exports eventStreamPayloadHandler

getWebSocketPlugin

Re-exports getWebSocketPlugin

injectSessionIdMiddleware

Re-exports injectSessionIdMiddleware

injectSessionIdMiddlewareOptions

Re-exports injectSessionIdMiddlewareOptions

resolveWebSocketConfig

Re-exports resolveWebSocketConfig

websocketURLMiddleware

Re-exports websocketURLMiddleware

websocketURLMiddlewareOptions

Re-exports websocketURLMiddlewareOptions

Type aliases

WithSession

WithSession: { SessionId?: string }

Type declaration

[key: string]: any
Optional SessionId?: string

Functions

Const connect

connect(socket: WebSocket, data: AsyncIterable<Uint8Array>): AsyncIterable<Uint8Array>

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:64
Parameters
- socket: WebSocket
- data: AsyncIterable<Uint8Array>
Returns AsyncIterable<Uint8Array>

Const getIterator

getIterator(stream: any): AsyncIterable<any>

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:124
Transfer payload data to an AsyncIterable. When the ReadableStream API is available in the runtime(e.g. browser), and the request body is ReadableStream, so we need to transfer it to AsyncIterable to make the stream consumable by WebSocket.

Parameters
- stream: any
Returns AsyncIterable<any>

Const getWebSocketPlugin

getWebSocketPlugin(config: WebSocketResolvedConfig): Pluggable<any, any>

- Defined in packages/middleware-sdk-transcribe-streaming/src/plugin.ts:7
Parameters
- config: WebSocketResolvedConfig
Returns Pluggable<any, any>

Const injectSessionIdMiddleware

injectSessionIdMiddleware(config: { requestHandler: RequestHandler<any, any> }): InitializeMiddleware<any, any>

- Defined in packages/middleware-sdk-transcribe-streaming/src/middleware-session-id.ts:22
Middleware that inject default sessionId for operations, and inject the parameters from request to the response metadata. This is necessary because the SDK cannot access any parameters other than the result stream. So it copies the parameters from input to the same parameters in the output.

Parameters
- config: { requestHandler: RequestHandler<any, any> }
  - requestHandler: RequestHandler<any, any>
Returns InitializeMiddleware<any, any>

Const isReadableStream

isReadableStream(payload: any): payload is ReadableStream

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:147
Parameters
- payload: any
Returns payload is ReadableStream

Const isWebSocket

isWebSocket(config: { requestHandler: RequestHandler<any, any> }): boolean

- Defined in packages/middleware-sdk-transcribe-streaming/src/middleware-session-id.ts:42
Parameters
- config: { requestHandler: RequestHandler<any, any> }
  - requestHandler: RequestHandler<any, any>
Returns boolean

Const resolveWebSocketConfig

resolveWebSocketConfig<T>(input: T & WebSocketInputConfig & PreviouslyResolved): T & WebSocketResolvedConfig

- Defined in packages/middleware-sdk-transcribe-streaming/src/configuration.ts:24
Type parameters
- T
Parameters
- input: T & WebSocketInputConfig & PreviouslyResolved
Returns T & WebSocketResolvedConfig

Const toReadableStream

toReadableStream<T>(asyncIterable: AsyncIterable<T>): AsyncIterable<T> | ReadableStream<T>

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:144
Convert async iterable to a ReadableStream when ReadableStream API is available(browsers). Otherwise, leave as it is(ReactNative).

Type parameters
- T
Parameters
- asyncIterable: AsyncIterable<T>
Returns AsyncIterable<T> | ReadableStream<T>

Const validateSigner

validateSigner(signer: any): signer is BaseSignatureV4

- Defined in packages/middleware-sdk-transcribe-streaming/src/configuration.ts:40
Parameters
- signer: any
Returns signer is BaseSignatureV4

Const waitForReady

waitForReady(socket: WebSocket, connectionTimeout: number): Promise<void>

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:49
Parameters
- socket: WebSocket
- connectionTimeout: number
Returns Promise<void>

Const websocketURLMiddleware

websocketURLMiddleware(options: { requestHandler: RequestHandler<any, any> }): BuildMiddleware<any, any>

- Defined in packages/middleware-sdk-transcribe-streaming/src/middleware-endpoint.ts:14
Middleware that generates WebSocket URL to TranscribeStreaming service Reference: https://docs.aws.amazon.com/transcribe/latest/dg/websocket.html

Parameters
- options: { requestHandler: RequestHandler<any, any> }
  - requestHandler: RequestHandler<any, any>
Returns BuildMiddleware<any, any>

Object literals

Const eventStreamPayloadHandler

eventStreamPayloadHandler: object

handle

handle(next: BuildHandler<any, any>, args: BuildHandlerArguments<any>): Promise<BuildHandlerOutput<any>>

- Defined in packages/middleware-sdk-transcribe-streaming/src/eventstream-handler.ts:8
Parameters
- next: BuildHandler<any, any>
- args: BuildHandlerArguments<any>
Returns Promise<BuildHandlerOutput<any>>

Const injectSessionIdMiddlewareOptions

injectSessionIdMiddlewareOptions: object

name

name: string = "injectSessionIdMiddleware"

override

override: true = true

step

step: "initialize" = "initialize"

tags

tags: string[] = ["WEBSOCKET", "EVENT_STREAM"]

Const websocketURLMiddlewareOptions

websocketURLMiddlewareOptions: object

name

name: string = "websocketURLMiddleware"

override

override: true = true

relation

relation: "after" = "after"

tags

tags: string[] = ["WEBSOCKET", "EVENT_STREAM"]

toMiddleware

toMiddleware: string = "eventStreamHeaderMiddleware"