API Docs for version 1.2.5601

Call

Module: Circuit

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.

Properties

activeMediaType

Syntax

activeMediaType

MediaType

Summary

Media type of the active call

callId

Syntax

callId

String

Summary

Unique identifier for the call. Use this to compare calls, or as key for a calls hashtable.

convId

Syntax

convId

String

Summary

Conversation ID

convType

Syntax

convType

ConversationType

Summary

Conversation type

direction

Syntax

direction

String

Summary

Direction of the call. incoming or outgoing.

establishedTime

Syntax

establishedTime

Number

Summary

Timestamp of when the call was established

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.

isTestCall

Syntax

isTestCall

Boolean

Summary

True for a test call.

locallyMuted

Syntax

locallyMuted

Boolean

Summary

True if the call is muted locally the this client

localMediaType

Syntax

localMediaType

MediaType

Summary

The media types for the local user

localStreams

Syntax

localStreams

Object

Summary

Literal object containing video and desktop MediaStream objects. localStreams.video is identical to the localVideoStream property

localVideoStream

Syntax

localVideoStream

Object

Summary

Local video stream

mediaType

Syntax

mediaType

MediaType

Summary

The media types for the call

participants

Syntax

participants

CallParticipant[]

Summary

Array of call participant objects

peerUser

Syntax

peerUser

Object

Summary

Literal object containing caller ID information such as the display name and phone number

recording

Syntax

recording

Recording

Summary

Recording information of the call

remoteAudioStream

Syntax

remoteAudioStream

Object

Summary

Audio stream of remote side

remotelyMuted

Syntax

remotelyMuted

Boolean

Summary

True if the call is muted remotely

remoteVideoStreams

Syntax

remoteVideoStreams

Array

Summary

Participants video. Array of objects containing stream and streamId.

state

Syntax

Summary

Call State