sip.js.sessionmanager.md

October 20, 2022 ยท View on GitHub

Home > sip.js > SessionManager

SessionManager class

A session manager for SIP.js sessions.

Signature:

export declare class SessionManager 

Constructors

ConstructorModifiersDescription
(constructor)(server, options)Constructs a new instance of the SessionManager class.

Properties

PropertyModifiersTypeDescription
delegateSessionManagerDelegate | undefinedDelegate.
managedSessionsArray<ManagedSession>Sessions being managed.
userAgentUserAgentUser agent which created sessions being managed.

Methods

MethodModifiersDescription
answer(session, invitationAcceptOptions)Answer an incoming call.
call(destination, inviterOptions, inviterInviteOptions)Make an outgoing call.
connect()Connect.
decline(session)Decline an incoming call.
disconnect()Disconnect.
getLocalAudioTrack(session)The local audio track, if available.
getLocalMediaStream(session)The local media stream. Undefined if call not answered.
getLocalVideoTrack(session)The local video track, if available.
getRemoteAudioTrack(session)The remote audio track, if available.
getRemoteMediaStream(session)The remote media stream. Undefined if call not answered.
getRemoteVideoTrack(session)The remote video track, if available.
hangup(session)Hangup a call.
hold(session)Hold call
isConnected()Return true if transport is connected.
isHeld(session)Hold state.
isMuted(session)Mute state.
message(destination, message)Send a message.
mute(session)Mute call.
register(registererRegisterOptions)Start receiving incoming calls.
sendDTMF(session, tone)Send DTMF.
transfer(session, target, options)Transfer.
unhold(session)Unhold call.
unmute(session)Unmute call.
unregister(registererUnregisterOptions)Stop receiving incoming calls.