io.openvidu.java.client

Class Session

java.lang.Object

io.openvidu.java.client.Session

public class Session
extends Object

Method Summary

Modifier and Type	Method and Description
void	close() Gracefully closes the Session: unpublishes all streams and evicts every participant
long	createdAt() Timestamp when this session was created, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)
boolean	fetch() Updates every property of the Session with the current status it has in OpenVidu Server.
void	forceDisconnect(Connection connection) Forces the user represented by connection to leave the session.
void	forceDisconnect(String connectionId) Forces the user with Connection connectionId to leave the session.
void	forceUnpublish(Publisher publisher) Forces some user to unpublish a Stream.
void	forceUnpublish(String streamId) Forces some user to unpublish a Stream.
String	generateToken() Gets a new token associated to Session object with default values for TokenOptions.
String	generateToken(TokenOptions tokenOptions) Gets a new token associated to Session object configured with tokenOptions.
List<Connection>	getActiveConnections() Returns the list of active connections to the session.
SessionProperties	getProperties() Returns the properties defining the session
String	getSessionId() Gets the unique identifier of the Session
boolean	isBeingRecorded() Returns whether the session is being recorded or not
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getSessionId

public String getSessionId()

Gets the unique identifier of the Session

Returns:

The sessionId

createdAt

public long createdAt()

Timestamp when this session was created, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)

generateToken

public String generateToken()
                     throws OpenViduJavaClientException,
                            OpenViduHttpException

Gets a new token associated to Session object with default values for TokenOptions. This always translates into a new request to OpenVidu Server

Returns:

The generated token

Throws:

OpenViduJavaClientException

OpenViduHttpException

generateToken

public String generateToken(TokenOptions tokenOptions)
                     throws OpenViduJavaClientException,
                            OpenViduHttpException

Gets a new token associated to Session object configured with tokenOptions. This always translates into a new request to OpenVidu Server

Returns:

The generated token

Throws:

OpenViduJavaClientException

OpenViduHttpException

close

public void close()
           throws OpenViduJavaClientException,
                  OpenViduHttpException

Gracefully closes the Session: unpublishes all streams and evicts every participant

Throws:

OpenViduJavaClientException

OpenViduHttpException

fetch

public boolean fetch()
              throws OpenViduJavaClientException,
                     OpenViduHttpException

Updates every property of the Session with the current status it has in OpenVidu Server. This is especially useful for getting the list of active connections to the Session (getActiveConnections()) and use those values to call forceDisconnect(Connection) or forceUnpublish(Publisher).
To update every Session object owned by OpenVidu object, call OpenVidu.fetch()

Returns:

true if the Session status has changed with respect to the server, false if not. This applies to any property or sub-property of the object

Throws:

OpenViduHttpException

OpenViduJavaClientException

forceDisconnect

public void forceDisconnect(Connection connection)
                     throws OpenViduJavaClientException,
                            OpenViduHttpException

Forces the user represented by connection 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 with fetch() and then getActiveConnections()

Throws:

OpenViduJavaClientException

OpenViduHttpException

forceDisconnect

public void forceDisconnect(String connectionId)
                     throws OpenViduJavaClientException,
                            OpenViduHttpException

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 connectionId parameter with fetch() (use Connection.getConnectionId() to get the `connectionId` you want)

Throws:

OpenViduJavaClientException

OpenViduHttpException

forceUnpublish

public void forceUnpublish(Publisher publisher)
                    throws OpenViduJavaClientException,
                           OpenViduHttpException

Forces some user to unpublish a Stream. OpenVidu Browser will trigger the proper events on the client-side (streamDestroyed) with reason set to "forceUnpublishByServer".
You can get publisher parameter with getActiveConnections() and then for each Connection you can call Connection.getPublishers(). Remember to call fetch() before to fetch the current actual properties of the Session from OpenVidu Server

Throws:

OpenViduJavaClientException

OpenViduHttpException

forceUnpublish

public void forceUnpublish(String streamId)
                    throws OpenViduJavaClientException,
                           OpenViduHttpException

Forces some user to unpublish a Stream. OpenVidu Browser will trigger the proper events on the client-side (streamDestroyed) with reason set to "forceUnpublishByServer".
You can get streamId parameter with getActiveConnections() and then for each Connection you can call Connection.getPublishers(). Finally Publisher.getStreamId()) will give you the streamId. Remember to call fetch() before to fetch the current actual properties of the Session from OpenVidu Server

Throws:

OpenViduJavaClientException

OpenViduHttpException

getActiveConnections

public List<Connection> getActiveConnections()

Returns the list of active connections to the session. This value will remain unchanged since the last time method fetch() was called. Exceptions to this rule are:

• Calling forceUnpublish(String) updates each affected Connection status
• Calling forceDisconnect(String) updates each affected Connection status

To get the list of active connections with their current actual value, you must call first fetch() and then getActiveConnections()

isBeingRecorded

public boolean isBeingRecorded()

Returns whether the session is being recorded or not

getProperties

public SessionProperties getProperties()

Returns the properties defining the session

toString

public String toString()

Overrides:

toString in class Object