Fix 4.1.1 document errors

Change-Id: Id14886103ad0aa3024b5b584138ff6e63179cedc Reviewed-on: https://git-amr-1.devtools.intel.com/gerrit/227482 Reviewed-by: Duan, Xiande <[email protected]> Tested-by: Duan, Xiande <[email protected]>
492160833 · Jan 16, 2019 · 5a1d3aa · 5a1d3aa
1 parent 0844240
commit 5a1d3aa
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 13 deletions.
diff --git a/doc/doxygen_cfrc.conf b/doc/doxygen_cfrc.conf
@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = "Intel&reg; Collaboration Suite for WebRTC"
-PROJECT_NUMBER         = version&nbsp;4.1
+PROJECT_NUMBER         = version&nbsp;4.1.1
 PROJECT_BRIEF          = "Intel&reg; Collaboration Suite for WebRTC (Intel&reg; CS for WebRTC) Conference Server Guide"
 PROJECT_LOGO           = doxygen/intel_logo.png
 OUTPUT_DIRECTORY       = .

diff --git a/doc/doxygen_cp.conf b/doc/doxygen_cp.conf
@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = "Intel&reg; Collaboration Suite for WebRTC"
-PROJECT_NUMBER         = version&nbsp;4.1
+PROJECT_NUMBER         = version&nbsp;4.1.1
 PROJECT_BRIEF          = "Intel&reg; Collaboration Suite for WebRTC (Intel&reg; CS for WebRTC) Client-Portal Protocol"
 PROJECT_LOGO           = doxygen/intel_logo.png
 OUTPUT_DIRECTORY       = .

diff --git a/doc/doxygen_rest.conf b/doc/doxygen_rest.conf
@@ -5,7 +5,7 @@
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = "Intel&reg; Collaboration Suite for WebRTC"
-PROJECT_NUMBER         = version&nbsp;4.1
+PROJECT_NUMBER         = version&nbsp;4.1.1
 PROJECT_BRIEF          = "Intel&reg; Collaboration Suite for WebRTC (Intel&reg; CS for WebRTC) MCU Management REST API"
 PROJECT_LOGO           = doxygen/intel_logo.png
 OUTPUT_DIRECTORY       = .

diff --git a/doc/servermd/RESTAPI.md b/doc/servermd/RESTAPI.md
@@ -136,7 +136,7 @@ Data Model:<br>
         video: boolean,
         audio: boolean
       },
-      subscirbe: {
+      subscribe: {
         video: boolean,
         audio: boolean
       }
@@ -607,7 +607,11 @@ parameters:
         value: [
             object(StreamRegion):
             {
-                stream: string | undefined,    // stream can ONLY be absent at the very last consecutive positions.
+                stream: string,
+                region: object(Region)
+            } ||
+            object(EmptyRegion):               // Empty regions can ONLY appear at the very last consecutive positions.
+            {
                 region: object(Region)
             }
         ]
@@ -655,14 +659,14 @@ parameters:
 **Note**:
 
     Object(StreamingInRequest) {
-        url: string,
+        connection: {
+          url: url,                            // string, e.g. "rtsp://...."
+          transportProtocol: "udp" | "tcp",    // "tcp" by default.
+          bufferSize: number                   // The buffer size in bytes in case "udp" is specified, 8192 by default.
+        },
         media: {
           audio: "auto" | true | false,
           video: "auto" | true | false
-        },
-        transport: {
-          protocol: "udp" | "tcp",    // "tcp" by default.
-          bufferSize: number          // The buffer size in bytes in case "udp" is specified, 8192 by default.
         }
     }
 
@@ -777,7 +781,7 @@ parameters:
             parameters: {          // following values should be in stream's default/optional list
               resolution: { width: number, height: number },       // optional
               framerate: number,                                   // optional
-              bitrate: string || number,                           // optional
+              bitrate: string,                                     // optional, e.g. "x0.2", "x0.4"
               keyFrameInterval: number                             // optional
             }
         } || false
@@ -903,7 +907,16 @@ parameters:
         container: string,
         media: object(MediaSubOptions)       // Refers to object(MediaSubOptions) in 5.5.
     }
-    container={"mp4" | "mkv" | "auto" | "ts"}  // The container type of the recording file, "auto" by default.
+    /*
+     * Use "auto" to generate "container" format automatically.
+     * The "container" with "mkv"/"mp4" should use following codecs,
+     * MP4:
+     * audio codec must be "aac"
+     * video codec can be "h264", "h265", "vp9"
+     * MKV:
+     * the combination of video and audio codecs not listed in MP4
+     */
+    container={ "auto" | "mkv" | "mp4" }
 
 response body:
 
@@ -1098,7 +1111,7 @@ Token data in JSON example:
         room: roomID,
         user: participant's user ID,
         role: participant's role,
-        reprefence: object(Preference)
+        preference: object(Preference)
     }
     object(Preference):
     {