Merge pull request #357 from shiniwat/feature/issue-115

SDL 0274: Add preferred FPS to VideoStreamingCapability

Author: crokita

lib/js/src/rpc/structs/VideoStreamingCapability.js

@@ -183,6 +183,25 @@ class VideoStreamingCapability extends RpcStruct {
     getScale () {
         return this.getParameter(VideoStreamingCapability.KEY_SCALE);
     }
+
+    /**
+     * Set the PreferredFPS
+     * @param {Number} fps - The preferred frame rate per second of the head unit. The mobile application / app library may take other factors into account that constrain the frame rate lower than this value, but it should not perform streaming at a higher frame rate than this value. - The desired PreferredFPS.
+     * {'num_min_value': 0, 'num_max_value': 2147483647}
+     * @returns {VideoStreamingCapability} - The class instance for method chaining.
+     */
+    setPreferredFPS (fps) {
+        this.setParameter(VideoStreamingCapability.KEY_PREFERRED_FPS, fps);
+        return this;
+    }
+
+    /**
+     * Get the PreferredFPS
+     * @returns {Number} - the KEY_PREFERRED_FPS value
+     */
+    getPreferredFPS () {
+        return this.getParameter(VideoStreamingCapability.KEY_PREFERRED_FPS);
+    }
 }
 
 VideoStreamingCapability.KEY_PREFERRED_RESOLUTION = 'preferredResolution';
@@ -192,5 +211,6 @@ VideoStreamingCapability.KEY_HAPTIC_SPATIAL_DATA_SUPPORTED = 'hapticSpatialDataS
 VideoStreamingCapability.KEY_DIAGONAL_SCREEN_SIZE = 'diagonalScreenSize';
 VideoStreamingCapability.KEY_PIXEL_PER_INCH = 'pixelPerInch';
 VideoStreamingCapability.KEY_SCALE = 'scale';
+VideoStreamingCapability.KEY_PREFERRED_FPS = 'preferredFPS';
 
 export { VideoStreamingCapability };

lib/js/src/streaming/video/_VideoStreamingParameters.js

@@ -104,6 +104,10 @@ class _VideoStreamingParameters {
         if (formats !== null && formats.length > 0) {
             this._format = formats[0];
         }
+        const fps = capability.getPreferredFPS();
+        if (fps !== null) {
+            this._frameRate = fps;
+        }
     }
 
     /**
@@ -214,4 +218,4 @@ class _VideoStreamingParameters {
     }
 }
 
-export { _VideoStreamingParameters };
+export { _VideoStreamingParameters };

lib/rpc_spec

@@ -91,9 +91,11 @@ describe('VideoStreamingParametersTest', function () {
 
         format = new VideoStreamingFormat(VideoStreamingProtocol.RTP, VideoStreamingCodec.H264);
         capability.setSupportedFormats([format]);
+        capability.setPreferredFPS(15);
         params.update(capability);
         Validator.assertEquals(params.getFormat(), format);
+        Validator.assertEquals(params.getFrameRate(), 15);
 
         done();
     });
-});
+});