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 used on OpenVidu Server initialization
Array of active sessions. This value will remain unchanged since the last time method OpenVidu.fetch was called. Exceptions to this rule are:
To get the array of active sessions with their current actual value, you must call OpenVidu.fetch before consulting property activeSessions
Creates an OpenVidu session. The session identifier will be available at property Session.sessionId
A Promise that is resolved to the Session if success and rejected with an Error object if not.
Deletes a Recording. The recording must have status stopped
, ready
or failed
A Promise that is resolved if the Recording was successfully deleted and rejected with an Error object if not. This Error object has as message
property with the following values:
404
: no recording exists for the passed recordingId
409
: the recording has started
status. Stop it before deletionUpdates every property of every active Session with the current status they have in OpenVidu Server. After calling this method you can access the updated array of active sessions in activeSessions
A promise resolved to true if any Session status has changed with respect to the server, or to false if not. This applies to any property or sub-property of any of the sessions locally stored in OpenVidu Node Client
Gets an existing Recording
The id
property of the Recording you want to retrieve
A Promise that is resolved to the Recording if it successfully stopped and rejected with an Error object if not. This Error object has as message
property with the following values:
404
: no recording exists for the passed recordingId
Lists all existing recordings
A Promise that is resolved to an array with all existing recordings
Starts the recording of a Session
The sessionId
of the Session you want to start recording
A Promise that is resolved to the Recording if it successfully started (the recording can be stopped with guarantees) and rejected with an Error
object if not. This Error object has as message
property with the following values:
404
: no session exists for the passed sessionId
406
: the session has no connected participants422
: when passing RecordingProperties, 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 false409
: the session is not configured for using MediaMode.ROUTED or it is already being recorded501
: OpenVidu Server recording module is disabled (OPENVIDU_RECORDING
property set to false
)Starts the recording of a Session
A Promise that is resolved to the Recording if it successfully started (the recording can be stopped with guarantees) and rejected with an Error
object if not. This Error object has as message
property with the following values:
404
: no session exists for the passed sessionId
406
: the session has no connected participants422
: when passing RecordingProperties, 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 false409
: the session is not configured for using MediaMode.ROUTED or it is already being recorded501
: OpenVidu Server recording module is disabled (OPENVIDU_RECORDING
property set to false
)Starts the recording of a Session
A Promise that is resolved to the Recording if it successfully started (the recording can be stopped with guarantees) and rejected with an Error
object if not. This Error object has as message
property with the following values:
404
: no session exists for the passed sessionId
406
: the session has no connected participants422
: when passing RecordingProperties, 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 false409
: the session is not configured for using MediaMode.ROUTED or it is already being recorded501
: OpenVidu Server recording module is disabled (OPENVIDU_RECORDING
property set to false
)Stops the recording of a Session
The id
property of the Recording you want to stop
A Promise that is resolved to the Recording if it successfully stopped and rejected with an Error object if not. This Error object has as message
property with the following values:
404
: no recording exists for the passed recordingId
406
: recording has starting
status. Wait until started
status before stopping the recordingGenerated using TypeDoc