Merge pull request #117 from starwarfan/ana-rest-sample

Add analytics REST API sample

Author: xiandeatintel

src/sdk/rest/API.js

@@ -1311,6 +1311,113 @@ OWT_REST.API = (function(OWT_REST) {
     }, callbackError);
   };
 
+  /*
+     * * @callback onAnalyticsList
+     * * @param {Array.<{id: string, analytics: Object, media: Object}>} analyticsList            -The analytics list.
+     * * @param {Object} analyticsList[x].analytics            -The information of the analytics.
+     * * @param {string} analyticsList[x].analytics.algorithm  -The algorithm of the analytics.
+     * * @param {Object} analyticsList[x].media                -The media description of the analytics, which must follow the definition of object "MediaSubOptions" in section "3.3.11 Participant Starts a Subscription" in "Client-Portal Protocol.md" doc.
+  */
+  /**
+     * @function getAnalytics
+     * @desc This function gets the all the ongoing analytics in the specified room.
+     * @memberOf OWT_REST.API
+     * @param {string} room                          -Room ID.
+     * @param {function} callback                    -Callback function on success
+     * @param {function} callbackError               -Callback function on error
+     * @example
+  var roomId = '51c10d86909ad1f939000001';
+  OWT_REST.API.getAnalytics(roomId, function(analyticsList) {
+    console.log('Analytics:', analyticsList);
+  }, function(status, error) {
+    // HTTP status and error
+    console.log(status, error);
+  });
+     */
+  var getAnalytics = function(room, callback, callbackError) {
+    send('GET', 'rooms/' + room + '/analytics/', undefined, function(analyticsList) {
+      var result = JSON.parse(analyticsList);
+      callback(result);
+    }, callbackError);
+  };
+
+  /*
+     * * @callback onStartingAnalyticsOK
+     * * @param {Object} analyticsInfo               -The object containing the information of the server-side analytics.
+     * * @param {string} analyticsInfo.id            -The analytics ID.
+     * * @param {Object} analyticsInfo.analytics     -The information of the analytics.
+     * * @param {string} analyticsInfo.analytics.algorithm  -The algorithm of the analytics.
+     * * @param {Object} analyticsInfo.media         -The media description of the analytics, which must follow the definition of object "MediaSubOptions" in section "3.3.11 Participant Starts a Subscription" in "Client-Portal Protocol.md" doc.
+  */
+  /**
+     * @function startAnalytics
+     * @desc This function starts a analytics in the specified room.
+     * @memberOf OWT_REST.API
+     * @param {string} room                          -Room ID.
+     * @param {string} algorithm                     -The algorithm ID.
+     * @param {Object} media                         -The media description of the analytics, which must follow the definition of object "MediaSubOptions" in section "3.3.11 Participant Starts a Subscription" in "Client-Portal Protocol.md" doc.
+     * @param {onStartingAnalyticsOK} callback       -Callback function on success
+     * @param {function} callbackError               -Callback function on error
+     * @example
+  var roomId = '51c10d86909ad1f939000001';
+  var algorithm = 'b849f44bee074b08bf3e627f3fc927c7'; //guid in plugin.cfg
+  var media = {
+    audio: {
+      from: '7652773772543651'
+    },
+    video: {
+      from: '7652773772543651',
+      parameters: {
+        keyFrameInterval: 2
+      }
+    }
+  };
+  OWT_REST.API.startAnalytics(roomId, algorithm, media, function(analytics) {
+    console.log('analytics:', analytics);
+  }, function(status, error) {
+    // HTTP status and error
+    console.log(status, error);
+  });
+     */
+  var startAnalytics = function(room, algorithm, media, callback, callbackError) {
+    var options = {
+      algorithm: algorithm,
+      media: media
+    };
+
+    send('POST', 'rooms/' + room + '/analytics/', options, function(analyticsRtn) {
+      var result = JSON.parse(analyticsRtn);
+      callback(result);
+    }, callbackError);
+  };
+
+  /**
+     * @function stopAnalytics
+     * @desc This function stops the specified analytics in the specified room.
+     * @memberOf OWT_REST.API
+     * @param {string} room                          -Room ID
+     * @param {string} id                            -Analytics ID
+     * @param {function} callback                    -Callback function on success
+     * @param {function} callbackError               -Callback function on error
+     * @example
+  var roomId = '51c10d86909ad1f939000001';
+  var id = '878889273471677';
+  OWT_REST.API.stopAnalytics(roomId, id, function(result) {
+    console.log('Analytics:', id, 'in room:', roomId, 'stopped');
+  }, function(status, error) {
+    // HTTP status and error
+    console.log(status, error);
+  });
+     */
+  var stopAnalytics = function(room, id, callback, callbackError) {
+    if (typeof id !== 'string' || id.trim().length === 0) {
+      return callbackError('Invalid analytics ID');
+    }
+    send('DELETE', 'rooms/' + room + '/analytics/' + id, undefined, function(result) {
+      callback(result);
+    }, callbackError);
+  };
+
   /**
      * @function createToken
      * @desc This function creates a new token when a new participant to a room needs to be added.