sip.js.md

October 21, 2022 ยท View on GitHub

Home > sip.js

sip.js package

A SessionDescriptionHandler for web browsers.

Classes

ClassDescription
SessionDescriptionHandlerA 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

FunctionDescription
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

InterfaceDescription
PeerConnectionDelegateDelegate to handle PeerConnection state changes.
SessionDescriptionHandlerConfigurationConfiguration for SessionDescriptionHandler.
SessionDescriptionHandlerFactoryFactory for SessionDescriptionHandler.
SessionDescriptionHandlerOptionsOptions for SessionDescriptionHandler.

Type Aliases

Type AliasDescription
MediaStreamFactoryInterface of factory function which produces a MediaStream.
SessionDescriptionHandlerFactoryOptionsOptions for SessionDescriptionHandlerFactory.