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)
OpenVidu(String hostname, String secret, org.apache.hc.client5.http.impl.classic.HttpClientBuilder builder)
OpenVidu(String hostname, org.apache.hc.client5.http.impl.classic.HttpClientBuilder builder)

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.
Session	getActiveSession(String sessionId)	Returns an active session.
List<Session>	getActiveSessions()	Returns the list of active sessions.
Recording	getRecording(String recordingId)	Gets an existing recording
List<Recording>	listRecordings()	Lists all existing recordings
void	startBroadcast(String sessionId, String broadcastUrl)	Starts the broadcast of a Session
void	startBroadcast(String sessionId, String broadcastUrl, RecordingProperties properties)	Starts the broadcast of a Session
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
void	stopBroadcast(String sessionId)	Stops the broadcast 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 OpenVidu deployment is up an running. It must be the full URL (e.g. https://12.34.56.78:1234/)

secret - Secret configured in your OpenVidu deployment

OpenVidu

public OpenVidu(String hostname,
                String secret,
                org.apache.hc.client5.http.impl.classic.HttpClientBuilder builder)

Parameters:

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

secret - Secret configured in your OpenVidu deployment

builder - An instance of org.apache.hc.client5.http.impl.classic.HttpClientBuilder. This overrides the internal HTTP client in use. This method allows you to custom configure the HTTP client to your needs. This may be interesting for many reasons, including:

• Adding custom HTTP headers
• Adding proxy configuration
• Customizing the SSLContext
• Modifying the connection timeouts
• Setting up a cookie store

This method will override any CredentialsProvider of the builder with a BasicCredentialsProvider built with the param secret, which is the default configuration.

OpenVidu

public OpenVidu(String hostname,
                org.apache.hc.client5.http.impl.classic.HttpClientBuilder builder)

Parameters:

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

builder - An instance of org.apache.hc.client5.http.impl.classic.HttpClientBuilder. This overrides the internal HTTP client in use. This method allows you to custom configure the HTTP client to your needs. This may be interesting for many reasons, including:

• Adding custom HTTP headers
• Adding proxy configuration
• Customizing the SSLContext
• Modifying the connection timeouts
• Setting up a cookie store

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 - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API). This method will never return a OpenViduHttpException with status 409. If a session with the same customSessionId already exists in OpenVidu Server, a Session.fetch() operation is performed in the background and the updated Session object is returned.

startRecording

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

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 - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API)

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 - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API)

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 - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API)

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 - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API)

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 - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API)

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 - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API)

startBroadcast

public void startBroadcast(String sessionId,
                           String broadcastUrl)
                    throws OpenViduJavaClientException,
                           OpenViduHttpException

Starts the broadcast of a Session

Parameters:

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

broadcastUrl - The URL where to broadcast

Throws:

OpenViduJavaClientException

OpenViduHttpException - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API)

startBroadcast

public void startBroadcast(String sessionId,
                           String broadcastUrl,
                           RecordingProperties properties)
                    throws OpenViduJavaClientException,
                           OpenViduHttpException

Starts the broadcast of a Session

Parameters:

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

broadcastUrl - The URL where to broadcast

properties - The configuration for this broadcast. It uses a subset of the RecordingProperties:

• RecordingProperties.Builder.hasAudio(boolean)
• RecordingProperties.Builder.resolution(String)
• RecordingProperties.Builder.frameRate(int)
• RecordingProperties.Builder.recordingLayout(RecordingLayout)
• RecordingProperties.Builder.customLayout(String)
• RecordingProperties.Builder.shmSize(long)
• RecordingProperties.Builder.mediaNode(String)

Throws:

OpenViduJavaClientException

OpenViduHttpException - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API)

stopBroadcast

public void stopBroadcast(String sessionId)
                   throws OpenViduJavaClientException,
                          OpenViduHttpException

Stops the broadcast of a Session

Parameters:

sessionId - The sessionId of the session you want to stop broadcasting

Throws:

OpenViduJavaClientException

OpenViduHttpException - The status code carries a specific meaning OpenViduHttpException.getStatus() (see REST API)

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) automatically updates the inner affected connections for that specific Session
• Calling Session.updateConnection(String, ConnectionProperties) automatically updates the inner affected connection 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()

getActiveSession

public Session getActiveSession(String sessionId)

Returns an active session. This method has the same behavior and restrictions as getActiveSessions(), but it just returns a single Session instead of the complete list of Sessions

Parameters:

sessionId -

Returns:

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