WebRTC Core

Cookie Config

Persists the properties inside cookies with the prefix bdsft_cookieconfig_<property>.

Namespace : bdsft_webrtc.default.core.cookieconfig

Properties

Property	Type	Description
authenticationUserid	string	The Authentication User ID used for registration.
displayName	string	The SIP display name.
displayResolution	string	The display resolution for the calls.
enableAutoAnswer	boolean	True if an incoming call should be automatically answered.
enableSelfView	boolean	True if the self view should be enabled.
encodingResolution	string	The encoding resolution for the calls.
hd	boolean	True if an encoding resolution of 1280 x 720 should be used.
password	string	The password used for registration.
userid	string	The SIP User ID used for registration.

Event Bus

Managing events through a publish/subscribe pattern.

Namespace : bdsft_webrtc.default.core.eventbus

Events

Event	Parameters	Description
calling	{ destination : string, session : ExSIP.RTCSession }	An outgoing call has been placed
dataReceived	{ data : string { }	Data has been received through the ExSIP.DataChannel.
dataSent	{ data : string { }	Data has been sent through the ExSIP.DataChannel.
digit	{ digit : 0 – 9 or \* or \#, isFromDestination : true if event source is destination input }	DMTF digit has been pressed.
endCall		Ends the call.
ended	{ originator : 'local' or 'remote', message : ExSIP.SIPMessage, cause: string }	The call has been ended.
failed	{ originator : 'local' or 'remote', message : ExSIP.SIPMessage, cause: string }	The call has failed.
held	ExSIP.RTCSession	The call has been put on hold.
iceclosed	{ originator : 'local' or 'remote', response: ExSIP.SIPMessage }	Fired when the iceConnectionState of the peerConnection is closed.
icecompleted	{ originator : 'local' or 'remote', response: ExSIP.SIPMessage }	Fired when the iceConnectionState of the peerConnection is completed.
iceconnected	{ originator : 'local' or 'remote', response: ExSIP.SIPMessage }	Fired when the iceConnectionState of the peerConnection is connected.
incomingCall	{ originator : 'local' or 'remote', session: ExSIP.RTCSession, request: ExSIP.SIPMessage }	An incoming call has been received.
modifier	{ which : integer of the keyboard key }	The alt and another key have been pressed.
newDTMF	{ originator : 'local' or 'remote', dtmf : ExSIP.DTMF, tone : char }	A DTMF tone has been sent.
progress	{ originator : 'local' or 'remote', response: ExSIP.SIPMessage }	The incoming call has been progressed.
reInvite	{ session : ExSIP.RTCSession, request: ExSIP.SIPMessage }	A reInvite has occured for the session.
resumed	ExSIP.RTCSession	The call has been resumed.
started	{ originator : 'local' or 'remote', response: ExSIP.SIPMessage }	The call has been started.
userMediaUpdated	localStream: the local media stream	The user's local media stream has been updated.

Url Config

Handles configuration through URL parameters.

Namespace : bdsft_webrtc.default.core.urlconfig

Properties

Property/URL Parameter	Type	Description
audioOnly	boolean	True for audio only calling.
destination	string	The destination to call.
displayName	string	The SIP display name.
displayResolution	string	The display resolution for the calls.
enableMessages	boolean	True to disable the message display.
encodingResolution	string	The encoding resolution for the calls.
endCallURL	string	URL of the location to navigate to if a call ends or fails.
features	integer	Enables the features through a bit set. (see setFeatures() below for details)
hd	boolean	True if an encoding resolution of 1280 x 720 should be used.
maxCallLength	integer	The maximum time limit of a call in seconds.
networkUserId	string	The SIP User ID used for non registered calling.

Methods

Method	Parameters	Description
getFeatures()		Returns all enabled features as bit set.
setFeatures(flags)	flags : integer as bit set enableCallControl: 1 enableCallTimer: 2 enableCallHistory: 4 enableFullscreen: 8 enableSelfView: 16 enableCallStats: 32 enableScreenshare: 64 enableMute: 128 enableMessages: 256 enableRegistrationIcon: 512 enableConnectionIcon: 1024 enableSettings: 2048 enableAutoAnswer: 4096 enableConnectLocalMedia: 8192 enableTransfer: 16384 enableHold: 32768 enableIms: 65536	Enables the features through a bit set. In order to enable features add the values of the features that you want to set, eg. in order to set enableCallHistory and enableMute the value of the features URI parameter would be 4 (enableCallHistory) + 128 (enableMute) = 132
setViewAudio()		Sets the view to audioOnly.
setViewVideo()		Sets the view to audio and video.