Class CallManager
This class allows you to place and receive voice and video calls as well as mute and speaker controls.
Defined in: CallManager.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Field Attributes | Field Name and Description |
---|---|
Event fired on call connected
|
|
Event fired on call connecting
|
|
Event fired on call ended
|
|
Event fired on call failed
|
|
Event fired on incoming call
|
|
Event fired on call manager initialized
|
|
Event fired on call switching between p2p and server
|
|
Event fired on call switching between p2p and server
|
|
Event fired on remote ringing
|
|
Event fired as call time changes
|
Method Attributes | Method Name and Description |
---|---|
endCall()
End the current call
|
|
placeCall(type, destination, displayName, keepConnected)
Place a call
|
|
setZUI(zui, confirmAV, viewOnly)
Initialize the CallManager for being able to place and receive calls using a ZUI object.
|
|
zinit(localVideo, remoteVideoArray, remoteAudio, confirmAV, viewOnly)
Initialize the CallManager for being able to place and receive calls
|
Field Detail
{object}
Event_CONNECTED
Event fired on call connected
{object}
Event_CONNECTING
Event fired on call connecting
{object}
Event_ENDED
Event fired on call ended
{object}
Event_FAILED
Event fired on call failed
{object}
Event_INCOMING_CALL
Event fired on incoming call
{object}
Event_INIT
Event fired on call manager initialized
{object}
Event_RECONNECTED
Event fired on call switching between p2p and server
{object}
Event_RECONNECTING
Event fired on call switching between p2p and server
{object}
Event_RINGING
Event fired on remote ringing
{object}
Event_TIME_ELAPSED
Event fired as call time changes
Method Detail
endCall()
End the current call
placeCall(type, destination, displayName, keepConnected)
Place a call
- Parameters:
- {string} type
- CallManager.VIDEO | CallManager.VOICE
- {string} destination
- Addrress to dial. Can be a user or room.
- {string} displayName
- String to display e.g. Meeting title
- {boolean} keepConnected
- Redial if connection dropped due to poor internet. Default false.
setZUI(zui, confirmAV, viewOnly)
Initialize the CallManager for being able to place and receive calls using a ZUI object.
- Parameters:
- {string} zui
- The ZUI Object which renders the UI components
- {string} confirmAV
- prompt user for cam and mic (CallManager.CAM_MIC) or just mic (CallManager.MIC)
- {string} viewOnly
- call using viewOnly mode, i.e. no media access or transmission
zinit(localVideo, remoteVideoArray, remoteAudio, confirmAV, viewOnly)
Initialize the CallManager for being able to place and receive calls
- Parameters:
- {string} localVideo
- DOM element to display the local video
- {string} remoteVideoArray
- Array of DOM elements for displaying the remote video streams
- {string} remoteAudio
- element to play remote audio
- {string} confirmAV
- prompt user for cam and mic (CallManager.CAM_MIC) or just mic (CallManager.MIC)
- {string} viewOnly
- call using viewOnly mode, i.e. no media access or transmission