Properties defining the session
Whether the session is being recorded or not
Unique identifier of the Session
Gracefully closes the Session: unpublishes all streams and evicts every participant
A Promise that is resolved if the session has been closed successfully and rejected with an Error object if not
Updates every property of the Session with the current status it has in OpenVidu Server. This is especially useful for accessing the list of active connections to the Session (Session.activeConnections) and use those values to call Session.forceDisconnect or Session.forceUnpublish
A promise resolved to true if the Session status has changed with respect to the server, or to false if not. This applies to any property or sub-property of the Session object
Forces the user with Connection connectionId to leave the session. OpenVidu Browser will trigger the proper events on the client-side
(streamDestroyed, connectionDestroyed, sessionDisconnected) with reason set to "forceDisconnectByServer"
You can get connection parameter from Session.activeConnections array (Connection.connectionId for getting each connectionId property).
Remember to call Session.fetch before to fetch the current actual properties of the Session from OpenVidu Server
A Promise that is resolved if the user was successfully disconnected and rejected with an Error object if not
Forces some user to unpublish a Stream (identified by its streamId or the corresponding Publisher object owning it).
OpenVidu Browser will trigger the proper events on the client-side (streamDestroyed) with reason set to "forceUnpublishByServer".
You can get publisher parameter from Connection.publishers array (Publisher.streamId for getting each streamId property).
Remember to call Session.fetch before to fetch the current actual properties of the Session from OpenVidu Server
A Promise that is resolved if the stream was successfully unpublished and rejected with an Error object if not
Gets a new token associated to Session object
A Promise that is resolved to the token if success and rejected with an Error object if not
Gets the unique identifier of the Session
Generated using TypeDoc
Array of active connections to the session. This property always initialize as an empty array and will remain unchanged since the last time method Session.fetch was called. Exceptions to this rule are:
To get the array of active connections with their current actual value, you must call Session.fetch before consulting property activeConnections