Class WebSocketTransport

WebSocket Transport for Janus API

export

Hierarchy

ITransport
- WebSocketTransport

Index

Constructors

constructor

Methods

Constructors

constructor

new WebSocketTransport(janus_websocket_url?: string, janus_protocol?: string): WebSocketTransport

- Defined in src/transports/WebSocketTransport.ts:46
Creates an instance of WebSocketTransport.

memberof

WebSocketTransport

Parameters
- Optional janus_websocket_url: string
  
  Janus API WebSocket URL
- Optional janus_protocol: string
  
  Janus Protocol to use, could be 'janus-admin-protocol' or 'janus-protocol'
Returns WebSocketTransport

Methods

dispose

dispose(): Promise<void>

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

Returns Promise<void>

isAdminEndpoint

isAdminEndpoint(): boolean

Overrides ITransport.isAdminEndpoint
- Defined in src/transports/WebSocketTransport.ts:44
True if this transport is pointing to Admin API

Returns boolean

request

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

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

template

ResponseT response type

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>

waitForReady

waitForReady(): Promise<boolean>

Overrides ITransport.waitForReady
- Defined in src/transports/WebSocketTransport.ts:161
Waits for the Transport to be ready

Returns Promise<boolean>

Generated using TypeDoc