sip.js.md
October 21, 2022 ยท View on GitHub
sip.js package
A SessionDescriptionHandler for web browsers.
Classes
| Class | Description |
|---|---|
| SessionDescriptionHandler | A base class implementing a WebRTC session description handler for sip.js. |
| WebAudioSessionDescriptionHandler | (BETA) A WebAudioSessionDescriptionHandler uses the Web Audio API to enable local conferencing of audio streams. |
Functions
| Function | Description |
|---|---|
| defaultMediaStreamFactory() | Function which returns a MediaStreamFactory. |
| defaultPeerConnectionConfiguration() | Function which returns an RTCConfiguration. |
| defaultSessionDescriptionHandlerFactory(mediaStreamFactory) | Function which returns a SessionDescriptionHandlerFactory. |
| startLocalConference(conferenceSessions) | (BETA) Start a conference. |
Interfaces
| Interface | Description |
|---|---|
| PeerConnectionDelegate | Delegate to handle PeerConnection state changes. |
| SessionDescriptionHandlerConfiguration | Configuration for SessionDescriptionHandler. |
| SessionDescriptionHandlerFactory | Factory for SessionDescriptionHandler. |
| SessionDescriptionHandlerOptions | Options for SessionDescriptionHandler. |
Type Aliases
| Type Alias | Description |
|---|---|
| MediaStreamFactory | Interface of factory function which produces a MediaStream. |
| SessionDescriptionHandlerFactoryOptions | Options for SessionDescriptionHandlerFactory. |