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

EventEmitter
- SIPConnector
  - HTTPConnector
  - WSController

Implements

IConnector

Index

Constructors

constructor

new SIPConnector(connectParams, stream?): 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
- Optional stream: MediaStream
Returns SIPConnector
Overrides EventEmitter.constructor
- Defined in src/connectors/SIPConnector.ts:131

Properties

`Private` _closed

_closed: boolean

`Private` _codecs

_codecs: Set<string>

`Private` `Optional` _connectionInfos

_connectionInfos?: ConnectionInfos

`Private` _connectionInfosTime

_connectionInfosTime: number

`Private` _endPoint

_endPoint: string

`Private` `Optional` _peerConnection

_peerConnection?: RTCPeerConnection

`Private` `Optional` _peerConnectionIdleTimeout

_peerConnectionIdleTimeout?: Timeout

`Private` `Optional` _stream

_stream?: MediaStream

`Private` _streamName

_streamName: string

log

log: ILog

Start a log

Param

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(): undefined | MediaStream
Media Stream description delivred from the server if we are player, or build from the local camera if we are the streamer.

Returns undefined | MediaStream
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

`Private` _clearPeerConnectionIdleTimeout

_clearPeerConnectionIdleTimeout(): void
Returns void
- Defined in src/connectors/SIPConnector.ts:380

`Protected` _open

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

`Protected` `Abstract` _sip

_sip(offer): 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

`Private` _startPeerConnectionIdleTimeout

_startPeerConnectionIdleTimeout(): void
Returns void
- Defined in src/connectors/SIPConnector.ts:371

`Private` _tryToOpen

_tryToOpen(): void
To call onOpen just once

Returns void
- Defined in src/connectors/SIPConnector.ts:363

close

close(error?): void
Close the connector
Parameters
- Optional error: 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?): 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, event): boolean
Event unsubscription
Parameters
- name: "open" | "close" | "Close" | "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:439

on

on(name, event, options?): void
Event subscription
Parameters
- name: "open" | "close" | "Close" | "Open"
  Name of event without the on prefix (ex: log to onLog event declared)
- event: Function
  Subscriber Function
- Optional options: {
  signal?: AbortSignal;
  }
  - Optional signal?: 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:422

once

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

`Private` updateCodecs

updateCodecs(sdp): void
Fill the codecs set with the codecs found in the sdp
Parameters
- sdp: string
  the sdp to parse
Returns void
- Defined in src/connectors/SIPConnector.ts:351

Events

onClose

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

onOpen

onOpen(stream): 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

Implements

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

connectParams: Params

Optional stream: MediaStream

Returns SIPConnector

Properties

Private _closed

Private _codecs

Private Optional _connectionInfos

Private _connectionInfosTime

Private _endPoint

Private Optional _peerConnection

Private Optional _peerConnectionIdleTimeout

Private Optional _stream

Private _streamName

log

Param

Returns

Accessors

closed

Returns boolean

codecs

Returns Set<string>

opened

Returns boolean

stream

Returns undefined | MediaStream

streamName

Returns string

Methods

Private _clearPeerConnectionIdleTimeout

Returns void

Protected _open

Parameters

Optional iceServer: RTCIceServer

Returns void

Protected Abstract _sip

Parameters

offer: string

Returns Promise<string>

Private _startPeerConnectionIdleTimeout

Returns void

Private _tryToOpen

Returns void

close

Parameters

Optional error: ConnectorError

Returns void

connectionInfos

Parameters

cacheDuration: number = 1000

Returns Promise<ConnectionInfos>

off

Parameters

name: "open" | "close" | "Close" | "Open"

event: Function

Returns boolean

on

Parameters

name: "open" | "close" | "Close" | "Open"

event: Function

Optional options: { signal?: AbortSignal; }

Optional signal?: AbortSignal

Returns void

once

Parameters

name: "open" | "close" | "Close" | "Open"

event: Function

Optional options: { signal?: AbortSignal; }

Optional signal?: AbortSignal

Class SIPConnector`Abstract`

`Optional` stream: MediaStream

`Private` _closed

`Private` _codecs

`Private` `Optional` _connectionInfos

`Private` _connectionInfosTime

`Private` _endPoint

`Private` `Optional` _peerConnection

`Private` `Optional` _peerConnectionIdleTimeout

`Private` `Optional` _stream

`Private` _streamName

`Private` _clearPeerConnectionIdleTimeout

`Protected` _open

`Optional` iceServer: RTCIceServer

`Protected` `Abstract` _sip

`Private` _startPeerConnectionIdleTimeout

`Private` _tryToOpen

`Optional` error: ConnectorError

`Optional` options: {
signal?: AbortSignal;
}

`Optional` signal?: AbortSignal

`Optional` options: {
signal?: AbortSignal;
}

`Optional` signal?: AbortSignal

`Private` updateCodecs

`Optional` error: ConnectorError