Public accessible IP where your instance of OpenVidu Server is up an running
Secret used on OpenVidu Server initialization
Creates an OpenVidu session. You can call Session.getSessionId in the resolved promise to retrieve the sessionId
A Promise that is resolved to the Session if success and rejected with an Error object if not.
This Error object has as message property with the following values:
409: you are trying to assign an already-in-use custom sessionId to the session. See SessionProperties.customSessionIdDeletes a Recording. The recording must have status stopped or available
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 recordingId409: the recording has started status. Stop it before deletionGets 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 recordingIdLists 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 sessionId400: the session has no connected participants409: the session is not configured for using MediaMode.ROUTED or it is already being recordedStarts the recording of a Session
The sessionId of the Session you want to start recording
The name you want to give to the video file. You can access this same value in your clients on recording events (recordingStarted, recordingStopped)
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 sessionId400: the session has no connected participants409: the session is not configured for using MediaMode.ROUTED or it is already being recordedStarts 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 sessionId400: the session has no connected participants409: the session is not configured for using MediaMode.ROUTED or it is already being recordedStops 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 recordingId406: recording has starting status. Wait until started status before stopping the recordingGenerated using TypeDoc