From 3fc14fb58f72a2376d0c85c9ad06b3a2746de4dc Mon Sep 17 00:00:00 2001
From: pabloFuente <pablofuenteperez@gmail.com>
Date: Fri, 1 Feb 2019 18:19:06 +0100
Subject: [PATCH] openvidu server SDKs: docs fix

---
 .../io/openvidu/java/client/OpenVidu.java     |  8 ++++++-
 .../java/client/RecordingProperties.java      | 22 ++++++++++++-------
 openvidu-node-client/src/OpenVidu.ts          |  7 ++++--
 .../src/RecordingProperties.ts                |  3 ++-
 4 files changed, 28 insertions(+), 12 deletions(-)

diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/OpenVidu.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/OpenVidu.java
index de65ec65..1bb6249d 100644
--- a/openvidu-java-client/src/main/java/io/openvidu/java/client/OpenVidu.java
+++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/OpenVidu.java
@@ -169,8 +169,14 @@ public class OpenVidu {
 	 *                                     <ul>
 	 *                                     <li><code>404</code>: no session exists
 	 *                                     for the passed <i>sessionId</i></li>
-	 *                                     <li><code>400</code>: the session has no
+	 *                                     <li><code>406</code>: the session has no
 	 *                                     connected participants</li>
+	 *                                     <li><code>422</code>: "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</li>
 	 *                                     <li><code>409</code>: the session is not
 	 *                                     configured for using
 	 *                                     {@link io.openvidu.java.client.MediaMode#ROUTED}
diff --git a/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java b/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java
index 4096b085..f8e3d062 100644
--- a/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java
+++ b/openvidu-java-client/src/main/java/io/openvidu/java/client/RecordingProperties.java
@@ -108,8 +108,10 @@ public class RecordingProperties {
 		}
 
 		/**
-		 * Call this method to specify the recording resolution. Will only have effect
-		 * if
+		 * Call this method to specify the recording resolution. Must be a string with
+		 * format "WIDTHxHEIGHT", being both WIDTH and HEIGHT the number of pixels
+		 * between 100 and 1999.<br>
+		 * Will only have effect if
 		 * {@link io.openvidu.java.client.RecordingProperties.Builder#outputMode(Recording.OutputMode)}
 		 * has been called with value
 		 * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED}. For
@@ -165,7 +167,8 @@ public class RecordingProperties {
 	/**
 	 * Defines the mode of recording: {@link Recording.OutputMode#COMPOSED} for a
 	 * single archive in a grid layout or {@link Recording.OutputMode#INDIVIDUAL}
-	 * for one archive for each stream.<br><br>
+	 * for one archive for each stream.<br>
+	 * <br>
 	 * 
 	 * Default to {@link Recording.OutputMode#COMPOSED}
 	 */
@@ -177,8 +180,8 @@ public class RecordingProperties {
 	 * Defines the layout to be used in the recording.<br>
 	 * Will only have effect if
 	 * {@link io.openvidu.java.client.RecordingProperties.Builder#outputMode(Recording.OutputMode)}
-	 * has been called with value
-	 * {@link Recording.OutputMode#COMPOSED}.<br><br>
+	 * has been called with value {@link Recording.OutputMode#COMPOSED}.<br>
+	 * <br>
 	 * 
 	 * Default to {@link RecordingLayout#BEST_FIT}
 	 */
@@ -206,7 +209,8 @@ public class RecordingProperties {
 	 * {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED}. For
 	 * {@link io.openvidu.java.client.Recording.OutputMode#INDIVIDUAL} all
 	 * individual video files will have the native resolution of the published
-	 * stream.<br><br>
+	 * stream.<br>
+	 * <br>
 	 * 
 	 * Default to "1920x1080"
 	 */
@@ -216,7 +220,8 @@ public class RecordingProperties {
 
 	/**
 	 * Defines whether to record audio or not. Cannot be set to false at the same
-	 * time as {@link hasVideo()}.<br><br>
+	 * time as {@link hasVideo()}.<br>
+	 * <br>
 	 * 
 	 * Default to true
 	 */
@@ -226,7 +231,8 @@ public class RecordingProperties {
 
 	/**
 	 * Defines whether to record video or not. Cannot be set to false at the same
-	 * time as {@link hasAudio()}.<br><br>
+	 * time as {@link hasAudio()}.<br>
+	 * <br>
 	 * 
 	 * Default to true
 	 */
diff --git a/openvidu-node-client/src/OpenVidu.ts b/openvidu-node-client/src/OpenVidu.ts
index c5b7028f..805062b4 100644
--- a/openvidu-node-client/src/OpenVidu.ts
+++ b/openvidu-node-client/src/OpenVidu.ts
@@ -126,9 +126,12 @@ export class OpenVidu {
    * @param sessionId The `sessionId` of the [[Session]] you want to start recording
    * @param name The name you want to give to the video file. You can access this same value in your clients on recording events (`recordingStarted`, `recordingStopped`)
    *
-   * @returns 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:
+   * @returns 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`
-   * - `400`: the session has no connected participants
+   * - `406`: the session has no connected participants
+   * - `422`: 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 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`)
    */
diff --git a/openvidu-node-client/src/RecordingProperties.ts b/openvidu-node-client/src/RecordingProperties.ts
index 0c64d1ef..a4e1bfdc 100644
--- a/openvidu-node-client/src/RecordingProperties.ts
+++ b/openvidu-node-client/src/RecordingProperties.ts
@@ -49,7 +49,8 @@ export interface RecordingProperties {
     customLayout?: string;
 
     /**
-     * Recording video file resolution.<br>
+     * Recording video file resolution. Must be a string with format "WIDTHxHEIGHT",
+     * being both WIDTH and HEIGHT the number of pixels between 100 and 1999.<br>
      * Will only have effect if [[RecordingProperties.outputMode]]
      * is set to [[Recording.OutputMode.COMPOSED]]. For [[Recording.OutputMode.INDIVIDUAL]] all
      * individual video files will have the native resolution of the published stream