Class ITransport

Transport Interface for Janus API

export
abstract

Hierarchy

ITransport

Index

Methods

Methods

Abstract dispose

dispose(): Promise<void>

- Defined in src/transports/ITransport.ts:37
Cleanup, important in order to prevent connection and memory leaks

memberof

HTTPTransport

Returns Promise<void>

Abstract isAdminEndpoint

isAdminEndpoint(): boolean

- Defined in src/transports/ITransport.ts:19
True if this transport is pointing to Admin API

memberof

HTTPTransport

Returns boolean

Abstract request

request<ResponseT>(req: IRequest, session?: JanusSession, pluginHandle?: PluginHandle): Promise<ResponseT>

- Defined in src/transports/ITransport.ts:30
Executes a request against Janus API

template

ResponseT response type

memberof

HTTPTransport

Type parameters
- ResponseT
Parameters
- req: IRequest
  
  request data
- Optional session: JanusSession
  
  Janus Session to use
- Optional pluginHandle: PluginHandle
  
  Janus Plugin Handle to use
Returns Promise<ResponseT>

Abstract waitForReady

waitForReady(): Promise<boolean>

- Defined in src/transports/ITransport.ts:45
Waits for the Transport to be ready

memberof

HTTPTransport

Returns Promise<boolean>

Generated using TypeDoc