A Promise that is resolved to the Recording if it successfully started and rejected with an Error object if not. This Error object has as message property with the following values:
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 participantsA Promise that is resolved to the Recording if it successfully started and rejected with an Error object if not. This Error object has as message property with the following values:
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 participantsA Promise that is resolved to the Recording if it successfully started and rejected with an Error object if not. This Error object has as message property with the following values:
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 participantsGets a new token associated to Session object. This translates into a new request to OpenVidu Server
+Gets a new token associated to Session object. This always translates into a new request to OpenVidu Server
The recording is available for downloading. This status is reached for all
+ stopped recordings if OpenVidu Server configuration
+ property openvidu.recording.free-access is true
The recording has failed
+The recording has started and is going on
+The recording is starting (cannot be stopped)
+The recording has finished OK
+How the media streams will be sent and received by your clients: routed through OpenVidu Media Server
+ (MediaMode.ROUTED) or attempting direct p2p connections (MediaMode.RELAYED, not available yet)
Whether the Session will be automatically recorded (RecordingMode.ALWAYS) or not (RecordingMode.MANUAL)
The role assigned to this token
+openvidu.recording.free-access is true
+ */
+ available,
+
+ /**
+ * The recording has failed
+ */
+ failed
}
}
\ No newline at end of file
diff --git a/openvidu-node-client/src/Session.ts b/openvidu-node-client/src/Session.ts
index 181f75f4..53769faa 100644
--- a/openvidu-node-client/src/Session.ts
+++ b/openvidu-node-client/src/Session.ts
@@ -103,7 +103,7 @@ export class Session {
}
/**
- * Gets a new token associated to Session object. This translates into a new request to OpenVidu Server
+ * Gets a new token associated to Session object. This always translates into a new request to OpenVidu Server
*
* @returns A Promise that is resolved to the _token_ if success and rejected with an Error object if not (due to a `400 (Bad Request)` error in OpenVidu Server)
*/
diff --git a/openvidu-node-client/src/SessionProperties.ts b/openvidu-node-client/src/SessionProperties.ts
index 12899a41..883b42af 100644
--- a/openvidu-node-client/src/SessionProperties.ts
+++ b/openvidu-node-client/src/SessionProperties.ts
@@ -21,18 +21,26 @@ import { RecordingMode } from './RecordingMode';
export interface SessionProperties {
- mediaMode?: MediaMode;
- recordingMode?: RecordingMode;
+ /**
+ * How the media streams will be sent and received by your clients: routed through OpenVidu Media Server
+ * (`MediaMode.ROUTED`) or attempting direct p2p connections (`MediaMode.RELAYED`, _not available yet_)
+ */
+ mediaMode?: MediaMode;
- /**
- * Default value used to initialize property [[RecordingProperties.recordingLayout]] of every recording of this session.
- * You can easily override this value later by setting [[RecordingProperties.recordingLayout]] to any other value
- */
- defaultRecordingLayout?: RecordingLayout;
+ /**
+ * Whether the Session will be automatically recorded (`RecordingMode.ALWAYS`) or not (`RecordingMode.MANUAL`)
+ */
+ recordingMode?: RecordingMode;
- /**
- * Default value used to initialize property [[RecordingProperties.customLayout]] of every recording of this session.
- * You can easily override this value later by setting [[RecordingProperties.customLayout]] to any other value
- */
- defaultCustomLayout?: string;
+ /**
+ * Default value used to initialize property [[RecordingProperties.recordingLayout]] of every recording of this session.
+ * You can easily override this value later by setting [[RecordingProperties.recordingLayout]] to any other value
+ */
+ defaultRecordingLayout?: RecordingLayout;
+
+ /**
+ * Default value used to initialize property [[RecordingProperties.customLayout]] of every recording of this session.
+ * You can easily override this value later by setting [[RecordingProperties.customLayout]] to any other value
+ */
+ defaultCustomLayout?: string;
}
diff --git a/openvidu-node-client/src/TokenOptions.ts b/openvidu-node-client/src/TokenOptions.ts
index 7578ca98..0ac35282 100644
--- a/openvidu-node-client/src/TokenOptions.ts
+++ b/openvidu-node-client/src/TokenOptions.ts
@@ -27,5 +27,8 @@ export interface TokenOptions {
*/
data: string;
+ /**
+ * The role assigned to this token
+ */
role: OpenViduRole;
}
\ No newline at end of file
Name of the Recording. The video file will be named after this property
+Name of the Recording. The video file will be named after this property. + You can access this same value in your clients on recording events + (
recordingStarted,recordingStopped)