Typedefs

• MediaSessionStartedEvent : Object
• MediaSessionStartedEvent : Object
• AudioInputStateChangeEvent : Object
• AudioUnmutePermissionsChangedEvent : Object
• NoAudioInputEvent : Object
• VisitorsMessageEvent : Object
• VisitorsRejectionEvent : Object
• RoomErrorEvent : Object
• RoomJoinInProgressEvent : Object
• RoomLeftEvent : Object
• RoomUniqueIdSetEvent : Object
• RoomCreatedTimestampEvent : Object
• ConnectionInterruptedEvent : Object
• ConnectionRestoredEvent : Object
• LobbyUserJoinedEvent : Object
• LobbyUserLeftEvent : Object
• LobbyUserUpdatedEvent : Object
• MembersOnlyChangedEvent : Object
• UserStatusChangedEvent : Object
• BreakoutRoomsMoveToRoomEvent : Object
• DataChannelOpenedEvent : Object
• DataChannelClosedEvent : Object
• ParticipantKickedEvent : Object
• ParticipantConnectedEvent : Object
• ParticipantDisconnectedEvent : Object
• TrackSubscribedEvent : Object
• TrackAddedEvent : Object
• TrackRemovedEvent : Object
• TrackAudioLevelChangedEvent : Object
• TrackUnmuteRejectedEvent : Object
• TrackUnsubscribedEvent : Object
• DisconnectedEvent : Object
• RoomJoinedEvent : Object
• TrackPublishedEvent : Track
• TrackUnpublishedEvent : Track
• TrackEnabledEvent : Track
• TrackDisabledEvent : Track
• TrackStartedEvent : Track
• TrackStoppedEvent : LocalTrack
• DataMessageEvent : String | Object
• SwitchedOffEvent : Track | DataTrack
• SwitchedOnEvent : Track | DataTrack
• SubscribedEvent : RemoteTrack
• UnsubscribedEvent : RemoteTrack
• ConnectionEstablishedEvent : Object
• ConnectionFailedEvent : Object
• ConnectionDisconnectedEvent : Object
• ConnectionRedirectedEvent : Object
• MessageReceivedEvent : Object
• PrivateMessageReceivedEvent : Object
• NonParticipantMessageReceivedEvent : Object
• DominantSpeakerChangedEvent : Object

MediaSessionStartedEvent : Object

An event fired when the room switches the currently active media session.

Kind: global typedef

MediaSessionStartedEvent : Object

An event fired when a new media session is added to the conference

Kind: global typedef

AudioInputStateChangeEvent : Object

Event indicates that the current conference audio input switched between audio input states,i.e. with or without audio input.

Kind: global typedef

AudioUnmutePermissionsChangedEvent : Object

Event indicates that the permission for unmuting audio has changed based on the number of audio senders in the call and the audio sender limit configured

Kind: global typedef

NoAudioInputEvent : Object

Event indicates that the current selected input device has no signal

Kind: global typedef

VisitorsMessageEvent : Object

Indicates that the conference has support for visitors.

Kind: global typedef

VisitorsRejectionEvent : Object

Event indicating that our request for promotion was rejected.

Kind: global typedef

RoomErrorEvent : Object

Event indicating that an error occurred in room.

Kind: global typedef

RoomJoinInProgressEvent : Object

Event indicating that an error occurred while joining room.

Kind: global typedef

RoomLeftEvent : Object

Event indicating that an room has been left.

Kind: global typedef

RoomUniqueIdSetEvent : Object

Event indicates that the room unique identifier has been set.

Kind: global typedef

RoomCreatedTimestampEvent : Object

Event indicates UTC room timestamp when first participant joined.

Kind: global typedef

ConnectionInterruptedEvent : Object

Event Indicates that the connection to the room has been interrupted for some reason.

Kind: global typedef

ConnectionRestoredEvent : Object

Event indicates that the connection to the room has been restored.

Kind: global typedef

LobbyUserJoinedEvent : Object

Event indicates that a new user has joined the lobby room.

Kind: global typedef

LobbyUserLeftEvent : Object

Event indicates that a user has left the lobby room.

Kind: global typedef

LobbyUserUpdatedEvent : Object

Event indicates that a user from the lobby room has been update.

Kind: global typedef

MembersOnlyChangedEvent : Object

Event indicates that a room had changed to members only enabled/disabled.

Kind: global typedef

UserStatusChangedEvent : Object

Event indicates that a user's status has changed.

Kind: global typedef

BreakoutRoomsMoveToRoomEvent : Object

Event indicates that a participant is requested to join a given (breakout) room.

Kind: global typedef

DataChannelOpenedEvent : Object

Event indicates that a connection to the backend data channel has been opened.

Kind: global typedef

DataChannelClosedEvent : Object

Event indicates that a connection to the backend data channel has been closed.

Kind: global typedef

ParticipantKickedEvent : Object

Event indicates that a participant was kicked out from room.

Kind: global typedef

ParticipantConnectedEvent : Object

Represents an event indicating that a new participant has connected to the room.

Kind: global typedef
Properties

Name	Type	Description
participant	LocalParticipant | RemoteParticipant	the new participant.

ParticipantDisconnectedEvent : Object

Represents an event indicating that a participant has disconnected from the room.

Kind: global typedef
Properties

Name	Type	Description
participant	LocalParticipant | RemoteParticipant	the participant that has left the room.

TrackSubscribedEvent : Object

Represents an event indicating that a new track has been subscribed to.

Kind: global typedef
Properties

Name	Type	Description
track	RemoteTrack	The new track that has been subscribed to.

TrackAddedEvent : Object

Represents an event indicating that a new track has been added to room.

Kind: global typedef
Properties

Name	Type	Description
track	Track	The new track that has been added.

TrackRemovedEvent : Object

Represents an event indicating that a new track has been removed from room.

Kind: global typedef
Properties

Name	Type	Description
track	Track	The new track that has been removed.

TrackAudioLevelChangedEvent : Object

Represents an event indicating that audio levels of a media track ( attached to the room) was changed.

Kind: global typedef

TrackUnmuteRejectedEvent : Object

Represents an event indicating that the source-add for unmuting of a media track was rejected by backend.

Kind: global typedef

TrackUnsubscribedEvent : Object

Represents an event indicating that a track has been unsubscribed from.

Kind: global typedef
Properties

Name	Type	Description
track	RemoteTrack	The track that has been unsubscribed from.

DisconnectedEvent : Object

Represents an event indicating that the room has been disconnected.

Kind: global typedef

RoomJoinedEvent : Object

Represents an event indicating that the room has been connected.

Kind: global typedef

TrackPublishedEvent : Track

Type alias for Track. Represents an event where a track is published.

Kind: global typedef

TrackUnpublishedEvent : Track

Type alias for Track. Represents an event where a track is unpublished.

Kind: global typedef

TrackEnabledEvent : Track

Type alias for Track. Represents an event where a track is enabled.

Kind: global typedef

TrackDisabledEvent : Track

Type alias for Track. Represents an event where a track is disabled.

Kind: global typedef

TrackStartedEvent : Track

Type alias for Track. Represents an event where a track is started.

Kind: global typedef

TrackStoppedEvent : LocalTrack

Type alias for LocalTrack. Represents an event where a local track is stopped.

Kind: global typedef

DataMessageEvent : String | Object

Event indicates that a message has been received.

Kind: global typedef

SwitchedOffEvent : Track | DataTrack

Event indicates that a track is switched off.

Kind: global typedef

SwitchedOnEvent : Track | DataTrack

Event indicates that a track is switched on.

Kind: global typedef

SubscribedEvent : RemoteTrack

Type alias for RemoteTrack. Represents an event where a remote track is subscribed.

Kind: global typedef

UnsubscribedEvent : RemoteTrack

Type alias for RemoteTrack. Represents an event where a remote track is unsubscribed.

Kind: global typedef

ConnectionEstablishedEvent : Object

Represents an event indicating that a connection has been established.

Kind: global typedef
Category: Events
Properties

Name	Type	Description
id	string	the ID of the local endpoint/participant/peer (within the context of the established connection)

ConnectionFailedEvent : Object

Represents an event indicating that a connection has failed.

Kind: global typedef
Category: Events
Properties

Name	Type	Description
errType	any	the type of error associated with the failure
errReason	string	the error (message) associated with the failure
credentials	object	the credentials used to connect (if any)
errReasonDetails	object	an optional object with details about

ConnectionDisconnectedEvent : Object

Represents an event indicating that a connection has been disconnected.

Kind: global typedef
Category: Events
Properties

Name	Type	Description
msg	string	A message associated with the disconnect, such as the last (known) error message.

ConnectionRedirectedEvent : Object

Represents an event indicating that a connection has been redirected.

Kind: global typedef
Category: Events
Properties

Name	Type	Description
event	object	An object associated with the redirect

MessageReceivedEvent : Object

Event indicates that a new message has been received.

Kind: global typedef
Category: Events
Properties

Name	Type	Description
from	Participant.ID	The sender of the message.
payload	String	The message payload.

PrivateMessageReceivedEvent : Object

Event indicates that a new private message has been received.

Kind: global typedef
Category: Events
Properties

Name	Type	Description
from	Participant.ID	The sender of the message.
payload	any	The message payload.

NonParticipantMessageReceivedEvent : Object

Event indicates that a message from the local user or from the ProCONF backend was received on the data channel.

Kind: global typedef
Category: Events
Properties

Name	Type	Description
from	Participant.ID	The sender of the message.
payload	any	The message payload.

DominantSpeakerChangedEvent : Object

Represents an event indicating that a dominant speaker has changed within a room.

Kind: global typedef
Category: Events
Properties

Name	Type	Description
dominantSpeaker	LocalParticipant | RemoteParticipant	The dominant speaker in the room.