Home Reference Source

Typedef

Static Public Summary
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public

The URL of the image that is set in the background or a Blob containing an image.

public

The color used for the shapes.

public
public

The tool to use on user interaction.

Static Public

public Candidate: * source

Properties:

NameTypeAttributeDescription
address string

Identifier of the user that received the invite

endReason 603 | 408 | 487 | 200

A code that indicates if the candidates accepted or rejected the invite and his reason

public ChatMessageDirection: Object source

Properties:

NameTypeAttributeDescription
INCOMING "incoming"
OUTGOING "outgoing"

public ChatMessageStatus: Object source

Properties:

NameTypeAttributeDescription
ERROR "error"
SENDING "sending"
SENT "sent"
RECEIVED "received"
DISPLAYED "displayed"
ACKNOWLEDGED "acknowledged"

public ChatMessageType: Object source

Properties:

NameTypeAttributeDescription
FILE "file"
TEXT "text"

public ChatParticipantRole: Object source

Properties:

NameTypeAttributeDescription
MEMBER "member"
ADMIN "admin"

public ChatParticipantState: Object source

Properties:

NameTypeAttributeDescription
ACTIVE "active"
INACTIVE "inactive"
GONE "gone"
COMPOSING "composing"
PAUSED "paused"

public ChatType: Object source

Properties:

NameTypeAttributeDescription
INDIVIDUAL "individual"
GROUP "group"

public EventInfo: Object source

Properties:

NameTypeAttributeDescription
participant string

gatewayUsername of a participant in the conference

reason string
  • optional
  • default: 'IN_CALL'|'HOLD'

reason to know if the participant is on hold or not

public Invite: Object source

Properties:

NameTypeAttributeDescription
from string

who sent the invite

to string

who received the invite

state string

specify what happened with the invite

candidates Array<Candidate>

List of candidates that received the invite

group boolean

Set to true when the invite is sent to a group

inviteRequest boolean

Set to true when the invite is related with an invitation request

mediaType MediaType

Indicates the media used in the conference

error 603 | 408 | 487 | ''

Code error when an invite is declined

public LocalStreamEvent: Object source

Properties:

NameTypeAttributeDescription
participant string

gatewayUsername of the local stream

{@link *

ManagedStream} stream

public MediaType: * source

Properties:

NameTypeAttributeDescription
audio boolean

Indicate if the creator of the invite wants to use audio in the conference

video boolean

Indicate if the creator of the invite wants to use video in the conference

public MediaTypes: Object source

Properties:

NameTypeAttributeDescription
audio boolean
video boolean
screen boolean

public MeetingParticipant: object source

Properties:

NameTypeAttributeDescription
email string
  • optional

x

phone string
  • optional

x

public Participant: * source

Properties:

NameTypeAttributeDescription
address string

Identifier of the user that entried in the room

createdAt number

Timestamp of when user inserted in the room

finishedAt number

Timestamp of when user left the room

public RemoteStreamAddedEvent: Object source

Properties:

NameTypeAttributeDescription
participant string

gatewayUsername of the local stream

reason string
  • optional
  • default: 'NEW'|'UNHOLD'

reason of stream addition

{@link *

ManagedStream} stream

public RemoteStreamRemovedEvent: Object source

Properties:

NameTypeAttributeDescription
participant string

gatewayUsername of the local stream

reason string
  • optional
  • default: 'GONE'|'HOLD'

reason of stream addition

{@link *

ManagedStream} stream

public StatusEvent: Object source

Properties:

NameTypeAttributeDescription
status SessionStatus

The new status of the session

target Session

The session object

public StopEvent: Object source

Properties:

NameTypeAttributeDescription
data Blob

A Blob with the recorded data. For more information about how to process a Blob you can check Sending and receiving Binary Data or FileSaver.js

startTime number

Timestamp when the recording was started

stopTime number

Timestamp when the recording was stoped

target StreamRecorder

The StreamRecorder object

public Transfer: * source

Properties:

NameTypeAttributeDescription
from string

Who creates the call-transfer

to string

Who has to receive the call transferred

state string

State of the call transfer

roomId string

Identifier of the room

idInvite string

Identifier of the invite related with the transfer

public WhiteboardHistoryItem: Object source

Properties:

NameTypeAttributeDescription
id string

the identifier of the stored shape.

previous string

previous shape state in stringified format.

current string

new shape state in stringified format.

public backgroundImage: string | Blob source

The URL of the image that is set in the background or a Blob containing an image.

public color: string source

The color used for the shapes. It is represented in a string (e.g.: 'green', 'red') or RGB (e.g.: '#00FF00', '#FF0000').

public gatewayUsername: string source

public tool: string source

The tool to use on user interaction. It is represented in a string. Valid values: null, 'select', 'add-line', 'freedraw', 'add-rect', 'add-circle', 'remove' (null means no tool is selected)