Merge branch 'video-sync'

Author: agrandiere

README.MD

@@ -108,16 +108,40 @@ sightengine.check(['nudity', 'type', 'properties','wad','faces', 'celebrities'])
 ```
 
 # Video and Stream Moderation
-The first step to detect nudity in a video stream is to submit the video stream to the API.
+
+You can perform either _synchronous_ or _asynchronous_ Video Moderation.
+
+* Synchronous Moderation is simple and easy: the Moderation result is provided directly in the reponse to your API request. Synchronous Moderation is only available for videos that are less than 1 minute long.
+* Asynchronous Moderation is available for any video or stream. Moderation results are provided through a so-called callback mechanism. You define a callback URL and the Moderation Engine will send back moderation events to that URL in realtime.
+
+## Synchronous Video Moderation
+
+Beware: this is only for videos that have a duration below 1 minute.
 
 ```javascript
-sightengine.check(['nudity', 'wad']).video('http://www.quirksmode.org/html5/videos/big_buck_bunny.webm', 'https://example.com/yourcallback').then(function(result) {
+sightengine.check(['nudity', 'wad']).video_sync('https://sightengine.com/assets/stream/examples/funfair.mp4').then(function(result) {
   // The result of the API
 }).catch(function(err) {
   // Error
 });
 ```
 
+## Asynchronous Video Moderation
+
+The first step to moderate a video stream is to submit the video stream to the API, along with a callback URL.
+
+```javascript
+sightengine.check(['nudity', 'wad']).video('https://sightengine.com/assets/stream/examples/funfair.mp4', 'https://example.com/yourcallback').then(function(result) {
+  // The result of the API
+}).catch(function(err) {
+  // Error
+});
+```
+
+Once you have submitted the video, the API will start POSTing moderation updates to your callback URL.
+
+Please see our [Documentation](https://sightengine.com/docs) for more details.
+
 # Feedback
 In order to report a misclassification, you need to report the image that was misclassified, the model that was run on this image (models are nudity, face, type, wad), and the correct class of the image.
 

example.js

@@ -32,7 +32,13 @@ sightengine.check(['nudity', 'type', 'properties','wad','faces']).set_bytes(imag
 
 // moderation video
 
-sightengine.check(['nudity', 'type', 'properties','wad','faces']).video('http://www.quirksmode.org/html5/videos/big_buck_bunny.webm', 'http://requestb.in/1d097l71').then(function(result) {
+sightengine.check(['nudity', 'type', 'properties','wad','faces']).video('https://sightengine.com/assets/stream/examples/funfair.mp4', 'http://requestb.in/1d097l71').then(function(result) {
+  console.log(result)
+}).catch(function(error) {
+  console.log(error)
+});
+
+sightengine.check(['nudity', 'type', 'properties','wad','faces']).video_sync('https://sightengine.com/assets/stream/examples/funfair.mp4').then(function(result) {
   console.log(result)
 }).catch(function(error) {
   console.log(error)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sightengine",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "",
   "main": "sightengine.js",
   "scripts": {

sightengine.js

@@ -71,6 +71,18 @@ function makeClient(api_user, api_secret) {
     });
   };
 
+  client.video_sync = (video) => {
+    var url =  endpoint + '/1.0/video/check-sync.json';
+    const data = { 'stream_url': video, 'models': _models.join(), 'api_user': apiUser, 'api_secret': apiSecret };
+    const querystring = encodeQueryData(data);
+
+    return fetch(url + '?' + querystring, { headers: { 'user-agent': 'SE-SDK-NODEJS' + version} }).then((res) => {
+      return res.json();
+    }).catch((error) => {
+      return error;
+    });
+  };
+
   client.feedback = (model, modelClass, image) => {
     var url = endpoint + '1.0/feedback.json'
 

tests.js

@@ -92,5 +92,16 @@ describe('video moderation', () => {
   })
 })
 
+describe('video sync moderation', () => {
+  it('should return success', () => {
+    return sightengine
+    .check(['nudity', 'wad', 'properties', 'type', 'face', 'celebrities'])
+    .video_sync('https://sightengine.com/assets/stream/examples/funfair.mp4')
+    .then(result => {
+      assert.equal('success', result.status)
+    })
+  })
+})
+