Class SIPConnector`Abstract`

SIPConnector is a common abstract class for negotiating a new RTCPeerConnection connection with the server.

The child class must implement the _sip method to send the offer to the server and get the answer.

Hierarchy (View Summary)

EventEmitter
- SIPConnector
  - HTTPConnector
  - WSController

Implements

IConnector

Index

Constructors

constructor

new SIPConnector(connectParams: Params, stream?: MediaStream): SIPConnector
Create a new SIPConnector instance. The RTCPeerConnection is created only when calling _open().

By default, a listener channel is negotiated. To create a streamer channel, pass a stream parameter.
Parameters
- connectParams: Params
- Optionalstream: MediaStream
Returns SIPConnector
Overrides EventEmitter.constructor
- Defined in src/connectors/SIPConnector.ts:131

Properties

log

log: ILog

Start a log

Param: args

Returns

a Log object with the levels of log to call

Accessors

closed

get closed(): boolean
True when connector is closed, in other words when onClose event is fired

Returns boolean
Implementation of IConnector.closed
- Defined in src/connectors/SIPConnector.ts:91

codecs

get codecs(): Set<string>
Indicate codecs supported, should be set before than onOpen happen

Returns Set<string>
Implementation of IConnector.codecs
- Defined in src/connectors/SIPConnector.ts:112

opened

get opened(): boolean
True when connector is opened, in other words when onOpen event is fired

Returns boolean
Implementation of IConnector.opened
- Defined in src/connectors/SIPConnector.ts:84

stream

get stream(): MediaStream | undefined
Media Stream description delivred from the server if we are player, or build from the local camera if we are the streamer.

Returns MediaStream | undefined
Implementation of IConnector.stream
- Defined in src/connectors/SIPConnector.ts:98

streamName

get streamName(): string
Stream name, for example as+bc3f535f-37f3-458b-8171-b4c5e77a6137

Returns string
Implementation of IConnector.streamName
- Defined in src/connectors/SIPConnector.ts:105

Methods

`Protected`_open

_open(iceServer?: RTCIceServer): void
Main function which creates the RTCPeerConnection, creates the offer, calls the _sip method, then set the answer and calls onOpen
Parameters
- OptionaliceServer: RTCIceServer
Returns void
- Defined in src/connectors/SIPConnector.ts:241

`Protected` `Abstract`_sip

_sip(offer: string): Promise<string>
Operates Session Initiation Protocol, this method implement the logic to send the SDP offer to the server and get the SDP answer in response.
Parameters
- offer: string
  SIP Offer
Returns Promise<string>
a Promise with SIP Answer as result
- Defined in src/connectors/SIPConnector.ts:235

close

close(error?: ConnectorError): void
Close the connector
Parameters
- Optionalerror: ConnectorError
  the error reason if is not a proper close
Returns void
Implementation of IConnector.close
- Defined in src/connectors/SIPConnector.ts:207

connectionInfos

connectionInfos(cacheDuration?: number): Promise<ConnectionInfos>
Returns connection info, such as round trip time, requests sent and received, bytes sent and received, and bitrates NOTE: This call is resource-intensive for the CPU.
Parameters
- cacheDuration: number = 1000
Returns Promise<ConnectionInfos>
A promise that resolves to an RTCStatsReport object
Implementation of IConnector.connectionInfos
- Defined in src/connectors/SIPConnector.ts:147

off

off(name: "close" | "Close" | "Open" | "open", event: Function): boolean
Event unsubscription
Parameters
- name: "close" | "Close" | "Open" | "open"
  Name of event without the 'on' prefix (ex: 'log' to 'onLog' event declared)
- event: Function
  Unsubscriber Function, must be the one passed to on or once subscription methods
Returns boolean
Implementation of IConnector.off
Inherited from EventEmitter.off
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:484

on

on(
    name: "close" | "Close" | "Open" | "open",
    event: Function,
    options?: { signal?: AbortSignal },
): void
Event subscription
Parameters
- name: "close" | "Close" | "Open" | "open"
  Name of event without the on prefix (ex: log to onLog event declared)
- event: Function
  Subscriber Function
- Optionaloptions: { signal?: AbortSignal }
  - Optionalsignal?: AbortSignal
    Optional AbortSignal to stop this or multiple subscriptions in same time
Returns void
Implementation of IConnector.on
Inherited from EventEmitter.on
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:467

once

once(
    name: "close" | "Close" | "Open" | "open",
    event: Function,
    options?: { signal?: AbortSignal },
): void
Event subscription only one time, once time fired it's automatically unsubscribe
Parameters
- name: "close" | "Close" | "Open" | "open"
  Name of event without the on prefix (ex: log to onLog event declared)
- event: Function
  Subscriber Function
- Optionaloptions: { signal?: AbortSignal }
  - Optionalsignal?: AbortSignal
    Optional AbortSignal to stop this or multiple subscriptions in same time
Returns void
Implementation of IConnector.once
Inherited from EventEmitter.once
- Defined in node_modules/@ceeblue/web-utils/dist/web-utils.d.ts:476

replaceTrack

replaceTrack(
kind: "audio" | "video",
track: MediaStreamTrack | null,
): Promise<void>
Hot-swap a track on the existing RTCPeerConnection without renegotiation.
Parameters
- kind: "audio" | "video"
  'audio' | 'video'
- track: MediaStreamTrack | null
  A MediaStreamTrack to send, or null to stop sending that kind.
Returns Promise<void>
Implementation of IConnector.replaceTrack
- Defined in src/connectors/SIPConnector.ts:351

Events

onClose

onClose(error?: ConnectorError): void
Call when connector is closed
Parameters
- Optionalerror: ConnectorError
  error description on an improper closure
Returns void
Implementation of IConnector.onClose
- Defined in src/connectors/SIPConnector.ts:73

onOpen

onOpen(stream: MediaStream): void
Call when connector is open
Parameters
- stream: MediaStream
  MediaStream description provided from the server if we are the player, or build from the local camera if we are the streamer.
Returns void
Implementation of IConnector.onOpen
- Defined in src/connectors/SIPConnector.ts:65

Class SIPConnectorAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns SIPConnector

Properties

log

Param: args

Returns

Accessors

closed

Returns boolean

codecs

Returns Set<string>

opened

Returns boolean

stream

Returns MediaStream | undefined

streamName

Returns string

Methods

Protected_open

Parameters

Returns void

Protected Abstract_sip

Parameters

Returns Promise<string>

close

Parameters

Returns void

connectionInfos

Parameters

Returns Promise<ConnectionInfos>

off

Parameters

Returns boolean

on

Parameters

Optionalsignal?: AbortSignal

Returns void

once

Parameters

Optionalsignal?: AbortSignal

Returns void

replaceTrack

Parameters

Returns Promise<void>

Events

onClose

Parameters

Returns void

onOpen

Parameters

Returns void

Settings

On This Page

Class SIPConnector`Abstract`

`Protected`_open

`Protected` `Abstract`_sip

`Optional`signal?: AbortSignal

`Optional`signal?: AbortSignal