CallManager
Call manager for creating and managing calls and conferences.
Methods
Registers a handler for the specified event.
One event can have more than one handler; handlers are executed in order of their registration.
Parameters
eventName:
Event name
listener:
(event: CallManagerIncomingCall) => void | Promise<void>
Handler function that is triggered when an event of the specified type occurs
options:
Object that specifies characteristics about the event listener
Returns
type:
void
Creates a new call instance.
The call should be started via the Call.start method.
Returns the created call instance or null if the call creation failed.
Parameters
destination:
string
SIP URI, username or phone number to make call to. Actual routing is then performed by a VoxEngine scenario.
settings:
OptionalCall settings with additional call parameters, such as the preferred video codec, custom data, extra headers, etc.
Returns
type:
Call | null
Creates a new conference instance.
Returns the created conference instance or null if the conference creation failed.
Parameters
conferenceName:
string
Name of the conference
settings:
OptionalConference settings with additional conference parameters, such as the preferred video codec, custom data, extra headers, etc.
Returns
type:
Conference | null
Removes a previously registered handler for the specified event.
Parameters
eventName:
Event name
listener:
(event: CallManagerIncomingCall) => void | Promise<void>
Handler function to remove from the event target
Returns
type:
void
Props
Returns a map of actual calls with their ids.
Returns a map of actual conferences with their ids.