This feature is part of OpenVidu PRO and ENTERPRISE editions
Event dispatched when the session has started being broadcasted. See Broadcast to YouTube/Twitch
This feature is part of OpenVidu PRO and ENTERPRISE editions
Event dispatched when the session has stopped being broadcasted. See Broadcast to YouTube/Twitch
Event dispatched when a new user has connected to the session.
It is fired for both the local user and remote users.
Event dispatched when a remote user has left the session.
For the local user see sessionDisconnected.
This feature is part of OpenVidu PRO and ENTERPRISE editions
Event dispatched when a property of the local Connection object changes.
It is fired only for the local user.
The properties that may change are role and record. The only way the Connection properties may change is by updating them through:
This event acts as a global handler for asynchronous errors that may be triggered for multiple reasons and from multiple origins. To see the different types of exceptions go to ExceptionEventName.
This feature is part of OpenVidu PRO and ENTERPRISE editions
Event dispatched when the network quality level of a Connection changes. See network quality.
Event dispatched when a user has started speaking.
It is fired for both the local user and remote users.
Extra information:
publisherSpeakingEventsOptions
in the call of setAdvancedConfiguration.Event dispatched when a user has stopped speaking.
It is fired for both the local user and remote users.
Extra information:
publisherSpeakingEventsOptions
in the call of setAdvancedConfiguration.Event dispatched when the local user has successfully recovered its connection to the session after losing it.
If the connection was recovered but OpenVidu Server already evicted the user due to timeout, then this event will
not be dispatched. A sessionDisconnected event with reason networkDisconnect
will be triggered instead.
See Reconnection events.
Event dispatched when the local user has lost its connection to the session, and starts the automatic reconnection process.
See Reconnection events.
Event dispatched when the session has started being recorded.
Property OPENVIDU_RECORDING_NOTIFICATION
of the OpenVidu deployment configuration
defines which users should receive this events (by default, only users with role PUBLISHER
or MODERATOR
)
Event dispatched when the session has stopped being recorded.
Property OPENVIDU_RECORDING_NOTIFICATION
of the OpenVidu deployment configuration
defines which users should receive this events (by default, only users with role PUBLISHER
or MODERATOR
)
Event dispatched when the local user has left the session.
For remote users see connectionDestroyed.
Event dispatched when a signal is received (see Send text messages between users).
If the listener is added as signal:TYPE
, only signals of type TYPE
will trigger the event.
This feature is part of OpenVidu PRO and ENTERPRISE editions
Event dispatched when a speech-to-text message has been received for certain Stream. See Speech To Text.
Event dispatched when a user has started publishing media to the session (see publish).
It is fired for both the local user and remote users.
Event dispatched when a user stops publishing media to the session.
It is fired for both the local user and remote users.
Event dispatched when a Stream undergoes any change in any of its mutable properties (see changedProperty).
It is fired for both remote streams (owned by a Subscriber) or local streams (owned by a Publisher).
Generated using TypeDoc
Events dispatched by Session object. Manage event listeners with on, once and off methods.
Example: