Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

VideoExpress.Participant

Properties Events 

A Participant represents a remote user that is connected to the room. This object consists of a camera subscriber and a screen subscriber object. When a new participant joins a room, the Room object dispatches the participantJoined event, which emits the Participant object corresponding to the participant who joined. The client can subscribe to this event to gain access to the participant's object.

Properties

Name Description
(CameraSubscriber) camera Includes methods and events related to the participant’s camera.
(string) connectionData

The string passed from the OpenTok Connection object after successfully connecting to a session. For full token creation documentation, see Token Creation Overview.

(string) id The participant’s unique ID. This is the connectionId string from the OpenTok Connection object after successfully connecting to a session.
(string) initials The participant’s initials.
(boolean) isMe Set to false, as this is a remote participant and not the local client's participant.
(string) name The participant’s name.
(ScreenSubscriber) screen Includes methods and events related to the participant’s screen share.

Events

Name Description
cameraCreated Dispatched when the participant’s camera subscriber is created. This event emits the CameraSubscriber object.
cameraDestroyed Dispatched when the camera subscriber is destroyed. This event doesn't emit anything.
encryptionSecretMatch Dispatched when a participant's media can be decrypted because the encryption secrets match. This is only dispatched when there was previously a secret mismatch.
encryptionSecretMismatch Dispatched when a participant's media cannot be decrypted because the encryption secrets do not match. In this scenario the user will still be subscribed to the stream, but the video will be black and the audio will be silent. It is considered good practice to communicate to the user why media is not viewable.
screenCreated Dispatched when the participant’s screen subscriber is created. This event emits the ScreenSubscriber object.
screenDestroyed Dispatched when the screen subscriber is destroyed. This event doesn't emit anything.