Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

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>

Const getIterator

  • getIterator(stream: any): AsyncIterable<any>
  • 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

Const injectSessionIdMiddleware

Const isReadableStream

  • isReadableStream(payload: any): payload is ReadableStream

Const isWebSocket

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

Const resolveWebSocketConfig

Const toReadableStream

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

Const validateSigner

  • validateSigner(signer: any): signer is BaseSignatureV4

Const waitForReady

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

Const websocketURLMiddleware

Object literals

Const eventStreamPayloadHandler

eventStreamPayloadHandler: object

handle

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"