Call
Summary
Data object defining a call. Used for any RTC call such as direct calls, group calls as well as screenshare.
Only local calls contain the participants array and the array does not inlcude the logged on user.
Item Index
Properties
callId
Syntax
callId
String
Summary
Unique identifier for the call. Use this to compare calls, or as key for a calls hashtable.
isEstablished
Syntax
isEstablished
Boolean
Summary
Indicates if call is established. E.g. call state active, hold, etc.
isRemote
Syntax
isRemote
Boolean
Summary
A remote call is an active call that is not local. E.g. an ongoing conference you have not joined, or an active call on another device of yours.
isTelephonyCall
Syntax
isTelephonyCall
Boolean
Summary
True for telephony calls, i.e. a WebRTC call going to a Gateway.
localStreams
Syntax
localStreams
Object
Summary
Literal object containing video and desktop MediaStream objects.
localStreams.video is identical to the localVideoStream property
peerUser
Syntax
peerUser
Object
Summary
Literal object containing caller ID information such as the display name and phone number
remoteVideoStreams
Syntax
remoteVideoStreams
Array
Summary
Participants video. Array of objects containing stream and streamId.