Package io.openvidu.java.client

Class OpenVidu

java.lang.Object

io.openvidu.java.client.OpenVidu

public class OpenVidu
extends Object

Constructor Summary

Constructors

Constructor	Description
OpenVidu(String hostname, String secret)

Method Summary

Modifier and Type	Method	Description
Session	createSession()	Creates an OpenVidu session with the default settings
Session	createSession(SessionProperties properties)	Creates an OpenVidu session
void	deleteRecording(String recordingId)	Deletes a recording.
boolean	fetch()	Updates every property of every active Session with the current status they have in OpenVidu Server.
List<Session>	getActiveSessions()	Returns the list of active sessions.
Recording	getRecording(String recordingId)	Gets an existing recording
List<Recording>	listRecordings()	Lists all existing recordings
Recording	startRecording(String sessionId)	Starts the recording of a Session
Recording	startRecording(String sessionId, RecordingProperties properties)	Starts the recording of a Session
Recording	startRecording(String sessionId, String name)	Starts the recording of a Session
Recording	stopRecording(String recordingId)	Stops the recording of a Session

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenVidu

public OpenVidu(String hostname,
                String secret)

Parameters:

hostname - URL where your instance of OpenVidu Server is up an running. It must be the full URL (e.g. https://12.34.56.78:1234/)

secret - Secret used on OpenVidu Server initialization

Method Detail

createSession

public Session createSession()
                      throws OpenViduJavaClientException,
                             OpenViduHttpException

Creates an OpenVidu session with the default settings

Returns:

The created session

Throws:

OpenViduJavaClientException

OpenViduHttpException

createSession

public Session createSession(SessionProperties properties)
                      throws OpenViduJavaClientException,
                             OpenViduHttpException

Creates an OpenVidu session

Parameters:

properties - The specific configuration for this session

Returns:

The created session

Throws:

OpenViduJavaClientException

OpenViduHttpException - Value returned from OpenViduHttpException.getStatus()

• 409: you are trying to assign an already-in-use custom sessionId to the session. See SessionProperties.customSessionId()

startRecording

public Recording startRecording(String sessionId,
                                RecordingProperties properties)
                         throws OpenViduJavaClientException,
                                OpenViduHttpException

Starts the recording of a Session

Parameters:

sessionId - The sessionId of the session you want to start recording

properties - The configuration for this recording

Returns:

The new created session

Throws:

OpenViduJavaClientException

OpenViduHttpException - Value returned from OpenViduHttpException.getStatus()

• 404: no session exists for the passed sessionId
• 406: the session has no connected participants
• 422: "resolution" parameter exceeds acceptable values (for both width and height, min 100px and max 1999px) or trying to start a recording with both "hasAudio" and "hasVideo" to false
• 409: the session is not configured for using MediaMode.ROUTED or it is already being recorded
• 501: OpenVidu Server recording module is disabled (OPENVIDU_RECORDING property set to false)

startRecording

public Recording startRecording(String sessionId,
                                String name)
                         throws OpenViduJavaClientException,
                                OpenViduHttpException

Starts the recording of a Session

Parameters:

sessionId - The sessionId of the session you want to start recording

name - The name you want to give to the video file. WARNING: this parameter follows an overwriting policy. If you name two recordings the same, the newest MP4 file will overwrite the oldest one

Returns:

The started recording. If this method successfully returns the Recording object it means that the recording can be stopped with guarantees

Throws:

OpenViduJavaClientException

OpenViduHttpException - Value returned from OpenViduHttpException.getStatus()

• 404: no session exists for the passed sessionId
• 406: the session has no connected participants
• 422: "resolution" parameter exceeds acceptable values (for both width and height, min 100px and max 1999px) or trying to start a recording with both "hasAudio" and "hasVideo" to false
• 409: the session is not configured for using MediaMode.ROUTED or it is already being recorded
• 501: OpenVidu Server recording module is disabled (OPENVIDU_RECORDING property set to false)

startRecording

public Recording startRecording(String sessionId)
                         throws OpenViduJavaClientException,
                                OpenViduHttpException

Starts the recording of a Session

Parameters:

sessionId - The sessionId of the session you want to start recording

Returns:

The started recording. If this method successfully returns the Recording object it means that the recording can be stopped with guarantees

Throws:

OpenViduJavaClientException

OpenViduHttpException - Value returned from OpenViduHttpException.getStatus()

• 404: no session exists for the passed sessionId
• 406: the session has no connected participants
• 422: "resolution" parameter exceeds acceptable values (for both width and height, min 100px and max 1999px) or trying to start a recording with both "hasAudio" and "hasVideo" to false
• 409: the session is not configured for using MediaMode.ROUTED or it is already being recorded
• 501: OpenVidu Server recording module is disabled (OPENVIDU_RECORDING property set to false)

stopRecording

public Recording stopRecording(String recordingId)
                        throws OpenViduJavaClientException,
                               OpenViduHttpException

Stops the recording of a Session

Parameters:

recordingId - The id property of the recording you want to stop

Returns:

The stopped recording

Throws:

OpenViduJavaClientException

OpenViduHttpException - Value returned from OpenViduHttpException.getStatus()

• 404: no recording exists for the passed recordingId
• 406: recording has starting status. Wait until started status before stopping the recording

getRecording

public Recording getRecording(String recordingId)
                       throws OpenViduJavaClientException,
                              OpenViduHttpException

Gets an existing recording

Parameters:

recordingId - The id property of the recording you want to retrieve

Throws:

OpenViduJavaClientException

OpenViduHttpException - Value returned from OpenViduHttpException.getStatus()

• 404: no recording exists for the passed recordingId

listRecordings

public List<Recording> listRecordings()
                               throws OpenViduJavaClientException,
                                      OpenViduHttpException

Lists all existing recordings

Returns:

A List with all existing recordings

Throws:

OpenViduJavaClientException

OpenViduHttpException

deleteRecording

public void deleteRecording(String recordingId)
                     throws OpenViduJavaClientException,
                            OpenViduHttpException

Deletes a recording. The recording must have status Recording.Status.stopped, Recording.Status.ready or Recording.Status.failed

Parameters:

recordingId - The id property of the recording you want to delete

Throws:

OpenViduJavaClientException

OpenViduHttpException - Value returned from OpenViduHttpException.getStatus()

• 404: no recording exists for the passed recordingId
• 409: the recording has started status. Stop it before deletion

getActiveSessions

public List<Session> getActiveSessions()

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

• Calling OpenVidu.createSession automatically adds the new Session object to the local collection.
• Calling Session.fetch() updates that specific Session status
• Calling Session.close() automatically removes the Session from the list of active Sessions
• Calling Session.forceDisconnect(Connection) automatically updates the inner affected connections for that specific Session
• Calling Session.forceUnpublish(Publisher) also automatically updates the inner affected connections for that specific Session
• Calling startRecording(String) and stopRecording(String) automatically updates the recording status of the Session (Session.isBeingRecorded())

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

fetch

public boolean fetch()
              throws OpenViduJavaClientException,
                     OpenViduHttpException

Updates every property of every active Session with the current status they have in OpenVidu Server. After calling this method you can access the updated list of active sessions by calling getActiveSessions()

Returns:

true if any Session status has changed with respect to the server, false if not. This applies to any property or sub-property of any of the sessions locally stored in OpenVidu Java Client

Throws:

OpenViduHttpException

OpenViduJavaClientException