SightCall Developer Center

Account Login Support
v. 7.2.20
Classes

Classes

Attendee
ClientCallRequest
JoinRequestNotification
MeetingPointAttendee
MeetingPointHost
Rtcc
RtccCall

Events

audio.ko
audio.ko

Triggered audio is not available.

audio.ok
audio.ok

Triggered audio is available.

browser.error
browser.error

Triggered when the chosen connection mode is not compatible with the current browser (e.g. webrtc_only with internet explorer)

call.create
call.create

Triggered when a call is created.
Callback is called with the parameter: (RtccCall) call

call.stats
call.stats

Asynchronous answer to function Rtcc#getStats
Callback is called with the parameter: CallStats

calldistributor.agent.available
calldistributor.agent.available

Triggered when agents are available in ACD use case. see for instance
Callback is called with the parameter: (Array of UidPresence) agentArray.

calldistributor.request
calldistributor.request

Triggered when an ACD request is received
Callback is called with the parameter: (ClientCallRequest) request

calldistributor.queue.update
calldistributor.queue.update

Triggered when the waiting queue is updated in ACD use case
Callback is called with the parameter: (CallDistributorQueue) queue

calldistributor.waitlist.retrieve
calldistributor.waitlist.retrieve

Triggered when the ACD wait list has been retrieved (see getWaitList)
Callback is called with the parameter: (Array of WaitListEntity) waitListArray

chrome.extension.missing
chrome.extension.missing

Triggered if the chrome RTCC Plugin extension is missing
Callback is called with parameter: Url - the url of the extension download page of the extension

chrome.screenshare.loaded
chrome.screenshare.loaded

Triggered if the chrome screenshare extension necesary for webrtc screenshare is available

chrome.screenshare.missing
chrome.screenshare.missing

Triggered if the chrome screenshare extension necesary for webrtc screenshare is missing
Callback is called with parameter: screenshareUrl - the url of the extension download page of the extension

client.connect
client.connect

Triggered when the API connects with the client (webRTC/plugin).
The first parameter is an element of Rtcc.connectionModes

client.disconnect
client.disconnect

Triggered the API loses the connection with the client (webRTC/plugin).

cloud.authenticate.error
cloud.authenticate.error

Triggered when the authentication to the SightCall cloud fails.
Callback is called with optional parameters: (Integer) error_code, (String) error

cloud.authenticate.success
cloud.authenticate.success

Triggered when the authentication to the SightCall cloud succeeds.

cloud.connect
cloud.connect

Triggered when the SightCall cloud has been reached. The authentication process starts immediatly.

cloud.disconnect
cloud.disconnect

Triggered when the connection with the SightCall cloud is lost.

cloud.drop
cloud.drop

Plugin Only
Triggered when the user has been disconnected by another tab forcing connection (e.g. force credentials change)

cloud.loggedasotheruser
cloud.loggedasotheruser

Triggered when the plugin is already connected with another user on another tab or browser.

cloud.haproxy.error
cloud.haproxy.error

WebRTC Only
Triggered if not able to retrieve HAProxy configuration
Callback is called with the parameter: (String) error

cloud.haproxy.ok
cloud.haproxy.ok

WebRTC Only
Triggered when HAProxy configuration has been retrieved

cloud.nosip.connect
cloud.nosip.connect

Triggered when the SightCall cloud has been reached in no-sip mode. The authentication process starts immediatly.

cloud.realtimeplatform.error
cloud.realtimeplatform.error

WebRTC Only
Triggered when the connection with the selected Real-Time Platform failed.
Callback is called with the parameter: (String) error

cloud.realtimeplatform.ok
cloud.realtimeplatform.ok

Triggered when the connection with the selected Real-Time Platform is ready. Callback is called with the parameter: (String) selected Real-Time Platform name

cloud.sip.ko
cloud.sip.ko

Triggered when the SIP communication is down. The Rtcc object is not able to place calls.

cloud.sip.ok
cloud.sip.ok

Triggered when the SIP communication has been establisehd. The Rtcc object is then ready to place calls.

cloud.turn.error
cloud.turn.error

WebRTC Only
Triggered when the TURN server is unreachable.
Callback is called with the parameter: (String) error

cloud.turn.ok
cloud.turn.ok

WebRTC Only
Triggered when the TURN server is reached.

error.createcall
error.createcall

Triggered if an outgoing call can't be created
Callback is called with the parameter: (String) error

error.plugin
error.plugin

Plugin only
Triggered by the plugin in case of plugin specific error
Callback is called with the parameter: (String) error

error.unavailable
error.unavailable

Triggered if the function is not implemented in the current mode
Callback is called with the parameter: (String) missing function

firefox.extension.missing
firefox.extension.missing

Triggered if the firefox RTCC Plugin extension is missing
Callback is called with parameter: Url - the url of the extension download page of the extension

get.displayname
get.displayname

Triggered when the answer to a getDisplayName request is received
Callback is called with the parameter: (string) value

get.getcallwindowdefaultposition
get.getcallwindowdefaultposition

Triggered when the answer to a getCallWindowDefaultPosition request is received
Callback is called with the parameter: (string) windowDefaultPosition

get.sid
get.sid

Triggered when the answer to a getSID request is received
Callback is called with the parameter: (string) sid

get.version
get.version

Triggered when the answer to a getRtccPluginVersion request is received
Callback is called with the parameter: (string) rtccPluginVersion

image.save.share
image.save.share

Triggered when the answer to shareSaveJs is received
Callback is called with the parameter: (String) blob string base64 encoded.

image.save.video
image.save.video

Triggered when the answer to videoSaveJs is received
Callback is called with the parameter: (String) blob string base64 encoded.

media.devices
media.devices

Triggered when Rtcc#getPeripherals and when a device a new peripheral is plugged in
Callback is called with the parameter: MediaDeviceList

meetingpoint.attendee.accept
meetingpoint.attendee.accept

Triggered when the user's request to join the conference has been accepted.
Callback is called with the parameter: (MeetingPointAttendee ) attendee

meetingpoint.attendee.deny
meetingpoint.attendee.deny

Triggered when the attendees's request to join the conference has been denied.
Callback is called with the parameter: (MeetingPointAttendee ) attendee

meetingpoint.attendee.error
meetingpoint.attendee.error

Triggered when an error happened on an attendee.
Callback is called with the parameters: (String) meetingPointId, (String) [optional] errorMessage.

meetingpoint.attendee.invite
meetingpoint.attendee.invite

Triggered when the user is invited by the host to a conference.
Callback is called with the parameter: (MeetingPointAttendee) attendee

meetingpoint.attendee.pending
meetingpoint.attendee.pending

Triggered when the user is waiting for the host to accept him/her in the conference.
Callback is called with the parameter: (MeetingPointAttendee ) attendee

meetingpoint.create.error
meetingpoint.create.error

Triggered when a meeting point could not be created.
Callback is called with the parameters: errorObject.

meetingpoint.create.success
meetingpoint.create.success

Triggered when a meeting point is created with success.
Callback is called with the parameter: (MeetingPointHost) meetingPointObject

meetingpoint.delete.error
meetingpoint.delete.error

Triggered when a meeting point could not be deleted.
Callback is called with the parameters: (String) meetingPointId, (String) errorMessage.

meetingpoint.delete.success
meetingpoint.delete.success

Triggered when a meeting point is deleted successfully.
Callback is called with the parameter: (String) meetingPointId.

meetingpoint.cancel
meetingpoint.cancel

Triggered when the host cancelled the meeting point.

meetingpoint.notification
meetingpoint.notification

Triggered on host side when the host is not in the conference and receives a join request.
Callback is called with the parameter: (Object) joinRequestNotification.

meetingpoint.get.error
meetingpoint.get.error

Triggered when a meeting point is not retreived successfully

meetingpoint.get.success
meetingpoint.get.success

Triggered when a meeting point is retreived successfully.
Callback is called with the parameter: (MeetingPointHost) meetingPointObject

meetingpoint.host.error
meetingpoint.host.error

Triggered when a meeting point could not be hosted.
Callback is called with the parameters: meetingPointId, errorMessage.

meetingpoint.host.success
meetingpoint.host.success

Triggered when a meeting point is hosted with success.
Callback is called with the parameter: (MeetingPointHost) meetingPointObject.

meetingpoint.joinmode.update.error
meetingpoint.joinmode.update.error

Triggered on host side when an error occurs when trying to change the join mode
see MeetingPointHost#lock_mode, MeetingPointHost#default_mode, MeetingPointHost#autoaccept_mode
Callback is called with the parameters: String mode ('default', 'auto-accept', 'locked'}), MeetingPointHost meetingPoint

meetingpoint.joinmode.update.success
meetingpoint.joinmode.update.success

Triggered on host side when the host successfully changes the join mode
see MeetingPointHost#lock_mode, MeetingPointHost#default_mode, MeetingPointHost#autoaccept_mode
Callback is called with the parameters: String mode ('default', 'auto-accept', 'locked'}), MeetingPointHost meetingPoint

meetingpoint.joinrequest.accept
meetingpoint.joinrequest.accept

Triggered on host side when a join conference request has been accepted.
Callback is called with the parameter: (Attendee) attendee

meetingpoint.joinrequest.cancel
meetingpoint.joinrequest.cancel

Triggered on host side when a join conference request has been cancelled.
Callback is called with the parameter: joinRequest.

meetingpoint.joinrequest.deny
meetingpoint.joinrequest.deny

Triggered on host side when an attendee denies the host's invite.
Callback is called with the parameter: (Attendee) attendee.

meetingpoint.joinrequest.error
meetingpoint.joinrequest.error

Triggered on host side when a join conference request has been emitted but failed.
Callback is called with the parameter: (String) meetingPointId, (Attendee) attendee, errorMessage

meetingpoint.joinrequest.new
meetingpoint.joinrequest.new

Triggered on host side when a join conference request is received.
Callback is called with the parameters: (Attendee) attendee

meetingpoint.joinrequest.send
meetingpoint.joinrequest.send

Triggered on attendee side when a join conference request has been sent to the host.
Callback is called with the parameters: (String) meetingPointId, (Attendee) attendee

meetingpoint.modify.error
meetingpoint.modify.error

Triggered when a meeting point could not be modified.
Callback is called with the parameters: meetingPointId, errorMessage.

meetingpoint.modify.success
meetingpoint.modify.success

Triggered when a meeting point is modified with success.
Callback is called with the parameter: meetingPointObject.

meetingpoint.permanent.get.success
meetingpoint.permanent.get.success

Triggered as successful answer to getPermanentMeetingPointByUid
Callback is called with the parameter: (String) url.

message.acknowledge
message.acknowledge

Triggered when a message acknowledge has been received.
Callback is called with the parameters: (String) messageId, (String) emitterUid, (String) status.

message.receive
message.receive

Triggered when a message has been received.
Callback is called with the parameters: (String) messageId, (String) emitterUid, (Integer) message.

plugin.load
plugin.load

Triggered when the plugin is loaded.

plugin.missing
plugin.missing

Triggered when the plugin is not detected.
Callback is called with the parameter: (String) url - download url of plugin

plugin.requirepermission
plugin.requirepermission

Triggered when the plugin is installed but the user needs to allow it.

plugin.startupdate
plugin.startupdate

Triggered when the plugin update process starts

plugin.update
plugin.update

Triggered when the plugin has finished downloading the latest version

plugin.mode.embedded
plugin.mode.embedded

Triggered as answer to getPluginMode

plugin.mode.standalone
plugin.mode.standalone

Triggered as answer to getPluginMode

presence.alreadyregistered
presence.alreadyregistered

Triggered at the connection when this user was already connected.

presence.burstupdate
presence.burstupdate

Triggered when user presence status requested before have been received.
Callback is called with the parameter: (Array of UidPresence) userPresenceArray

presence.ko
presence.ko

Triggered when the connection to the SightCall presence server is lost.

presence.newuser
presence.newuser

Triggered at the connection when this user was not already connected.

presence.ok
presence.ok

Triggered when the connection to the SightCall presence server is ready. Callback is called with the parameter: rosterLength.

presence.update
presence.update

Triggered when the current user or a user from the roster changes his presence.
Callback is called with the parameter: (Array of UidPresence) userPresenceArray

presence.roster.retrieve
presence.roster.retrieve

Triggered when the roster content has been received.
Callback has the parameters (Array of UidPresence) currentRoster

presence.roster.update
presence.roster.update

Triggered when the roster has been updated.
Callback has the parameters: (String) numberUserAdded, (String) rosterLength.

sixdigits.create.error
sixdigits.create.error

Triggered when a six digits code failed to be created.
Callback has the parameter: (String) errorMessage

sixdigits.create.success
sixdigits.create.success

Triggered when a six digits code has been created.
Callback has the parameter: (String) sixdigits

sixdigits.delete.error
sixdigits.delete.error

Triggered when a six digits code failed to be deleted. Callback has the parameter: (String) errorMessage

sixdigits.delete.success
sixdigits.delete.success

Triggered when a six digits code has been deleted.

ui.ready
ui.ready

Triggered when the user interface library is loaded.

ui.vcam.notfound
ui.vcam.notfound

Triggered when the virtual camera driver is not found in webextension embedded mode
This can happen on mac after an update from 6.x series. The plugin must be reinstalled, using getDownloadUrl function.

webrtc.capability
webrtc.capability

Triggered when the API starts.
Callback is called with the parameter: (Boolean) isWebrtcCompliant - if true, the browser can handle webRTC.

webrtc.missing
webrtc.missing

Triggered when webRTC is not available on this network. This happens when the network does not allow to reach
the Real-Time Platform or the TURN server.

webrtc.mediarequest.error
webrtc.mediarequest.error

Triggered when unable to access the camera/micro. (WebRTC only) An error message is given as the first parameter of the callback.

websocket.error
websocket.error

Triggered when the RealTime Platform connection is lost in WebRTC mode

chrome.screenshare.missing
chrome.screenshare.missing

WebRtc Only
Triggered when chrome screenshare extension not present and sharestart command is issued
Callback is called with parameter: screenshareUrl - the url of the extension download page of the extension

conference.fullstatus
conference.fullstatus

Triggered when the list of participants changes in a conference. Callback argument is a fullstatus object

conference.passiveboxes
conference.passiveboxes

Triggered to inform the UI of passive streams (webRTC only) Callback argument is an array of objects {src, pid}

conference.participants.order
conference.participants.order

Triggered when the floor list order changes in a conference. Callback argument is an array of participant id

error.unavailable
error.unavailable

Triggered when a function is not available with this client type. Callback argument is the name of the function

active
active

Triggered when the call has started

nqi
nqi

Triggered as a request to getQualityIndicators method
Callback is called with an object { "LNQIA":integer, "LNQIV":integer, "RNQIA":integer, "RNQIV":integer}

proceeding
proceeding

Triggered when the outgoing call is proceeding

setlocalstream
setlocalstream

Triggered to inform the UI of local stream change (webRTC only) Callback argument is the local stream id

setremotestream
setremotestream

Triggered to inform the UI of main remote stream change (webRTC only) Callback argument is the remote stream id

terminate
terminate

Triggered when the call is finished
Callback is called with the parameter: (String) reason

inband.message.ready
inband.message.ready

Triggered when it's possible to send and receive inband messages

inband.message.receive
inband.message.receive

Triggered when an inband message has been received.
Callback is called with the parameter: (String) message

peer.disconnect
peer.disconnect

Triggered when a peer has disconnected.
Callback is called with the optional parameter: (String) uid of peer

peer.reconnect
peer.reconnect

Triggered when a peer has reconnected.
Callback is called with the optional parameter: (String) uid of peer

record.bookmark
record.bookmark

Triggered when a bookmark has been inserted
Callback is called with the parameter: timestamp - the timestamp of the inserted bookmark

record.start
record.start

Triggered when the recording starts
Callback is called with the parameter: filename - the filename of the started recording.

record.stop
record.stop

Triggered when the recording stops
Callback is called with the parameter: reason - the reason for which the recording has stopped.

share.local.list
share.local.list

Triggered as an answer to shareList Callback argument is an object {item_number, item_id, item_name}

share.local.start
share.local.start

Triggered when the local share starts

share.local.stop
share.local.stop

Triggered when the local share stops

share.remote.framesize
share.remote.framesize

Triggered when the remote share resolution changes (WebRTC only) Callback argument is an object {width, height}

share.remote.start
share.remote.start

Triggered when the remote share starts Callback argument is the share stream id (webRTC only)

share.remote.stop
share.remote.stop

Triggered when the remote share stops

share.remote.remotecontrol.start
share.remote.remotecontrol.start

Plugin only Triggered when the remote share starts remote control

share.remote.remotecontrol.stop
share.remote.remotecontrol.stop

Plugin only Triggered when the remote share stops remote control

sound.mute
sound.mute

Triggered when the sound is disabled

sound.unmute
sound.unmute

Triggered when the sound is enabled

torch_light.ko
torch_light.ko

Triggered if torchlight is not available (plugin only)

torch_light.ok
torch_light.ok

Triggered if torchlight is available (plugin only)

video.framesize
video.framesize

Triggered when the decoded framesize changes.
Callback is called with the parameter VideoFrameSize and contains the video dimensions.

video.local.start
video.local.start

Triggered when the local video starts

video.local.stop
video.local.stop

Triggered when the local video stops

video.remote.start
video.remote.start

Triggered when the remote video starts

video.remote.stop
video.remote.stop

Triggered when the remote video stops

portrait
portrait

Triggered when local video profile changes
Callback is called with boolean parameter to indicate if new local profile is portrait (true) or landscape (false)

request
request

Triggered when a remote user would like to receive different quality video
Callback is called with one parameter - element of RtccCall#videoProfile