Address comments (#388)

* Address sgreenberg's comments * Massage package.json + generate README
googleapis · May 18, 2017 · c23a06e · c23a06e
1 parent 47f8e82
commit c23a06e
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 30 deletions.
diff --git a/packages/google-cloud-videointelligence/samples/README.md b/packages/google-cloud-videointelligence/samples/README.md
@@ -2,29 +2,27 @@
 
 # Google Cloud Video Intelligence API Node.js Samples
 
-The [Cloud Video Intelligence API][video_docs] allows developers to easily
-integrate video analysis within applications, including video labeling, safe search
-, and shot change detection.
+[![Build](https://storage.googleapis.com/cloud-docs-samples-badges/GoogleCloudPlatform/nodejs-docs-samples/nodejs-docs-samples-videointelligence.svg)]()
 
-[video_docs]: https://cloud.google.com/video-intelligence/docs/
+The [Cloud Video Intelligence API](https://cloud.google.com/video-intelligence) allows developers to use Google video analysis technology as part of their applications.
 
 ## Table of Contents
 
 * [Setup](#setup)
 * [Samples](#samples)
-  * [Analyze](#analyze)
+  * [Video Intelligence](#video-intelligence)
 * [Running the tests](#running-the-tests)
 
 ## Setup
 
 1.  Read [Prerequisites][prereq] and [How to run a sample][run] first.
 1.  Install dependencies:
 
-    With `npm`:
+    With **npm**:
 
         npm install
 
-    With `yarn`:
+    With **yarn**:
 
         yarn install
 
@@ -33,45 +31,47 @@ integrate video analysis within applications, including video labeling, safe sea
 
 ## Samples
 
-### Analyze
+### Video Intelligence
 
-View the [documentation][analyze_docs] or the [source code][analyze_code].
+View the [documentation][video_0_docs] or the [source code][video_0_code].
 
 __Usage:__ `node analyze.js --help`
 
 ```
 Commands:
+  faces <gcsUri>        Analyzes faces in a video stored in Google Cloud Storage using the Cloud Video Intelligence API.
   shots <gcsUri>        Analyzes shot angles in a video stored in Google Cloud Storage using the Cloud Video
                         Intelligence API.
   labels-gcs <gcsUri>   Labels objects in a video stored in Google Cloud Storage using the Cloud Video Intelligence API.
   labels-file <gcsUri>  Labels objects in a video stored locally using the Cloud Video Intelligence API.
+  safe-search <gcsUri>  Detects adult content in a video stored in Google Cloud Storage.
 
 Options:
   --help  Show help                                                                                            [boolean]
 
 Examples:
-  node analyze.js shots gs://my-bucket/my-video.mp4
-  node analyze.js labels-gcs gs://my-bucket/my-video.mp4
-  node analyze.js labels-file my-video.mp4
-  node analyze.js unsafe-content gs://my-bucket/my-video.mp4
+  node analyze.js faces gs://demomaker/volleyball_court.mp4
+  node analyze.js shots gs://demomaker/volleyball_court.mp4
+  node analyze.js labels-gcs gs://demomaker/volleyball_court.mp4
+  node analyze.js labels-file cat.mp4
+  node analyze.js safe-search gs://demomaker/volleyball_court.mp4
 
 For more information, see https://cloud.google.com/video-intelligence/docs
 ```
 
-[analyze_docs]: https://cloud.google.com/video-intelligence/docs
-[analyze_code]: analyze.js
+[video_0_docs]: https://cloud.google.com/video-intelligence/docs
+[video_0_code]: analyze.js
 
 ## Running the tests
 
-1.  Set the `GCLOUD_PROJECT` and `GOOGLE_APPLICATION_CREDENTIALS` environment
-    variables.
+1.  Set the **GCLOUD_PROJECT** and **GOOGLE_APPLICATION_CREDENTIALS** environment variables.
 
 1.  Run the tests:
 
-    With `npm`:
+    With **npm**:
 
         npm test
 
-    With `yarn`:
+    With **yarn**:
 
         yarn test
diff --git a/packages/google-cloud-videointelligence/samples/package.json b/packages/google-cloud-videointelligence/samples/package.json
@@ -19,14 +19,27 @@
   },
   "dependencies": {
     "@google-cloud/videointelligence": "https://storage.googleapis.com/videointelligence-alpha/videointelligence-nodejs.tar.gz",
+    "googleapis": "19.0.0",
+    "safe-buffer": "5.0.1",
     "yargs": "7.1.0"
   },
   "devDependencies": {
-    "@google-cloud/nodejs-repo-tools": "1.4.7",
-    "ava": "0.19.1"
+    "@google-cloud/nodejs-repo-tools": "1.4.13",
+    "ava": "0.19.1",
+    "proxyquire": "1.7.11"
   },
   "cloud-repo-tools": {
     "requiresKeyFile": true,
-    "requiresProjectId": true
+    "requiresProjectId": true,
+    "product": "video",
+    "samples": [
+      {
+        "id": "video",
+        "name": "Video Intelligence",
+        "file": "analyze.js",
+        "docs_link": "https://cloud.google.com/video-intelligence/docs",
+        "usage": "node analyze.js --help"
+      }
+    ]
   }
 }
diff --git a/packages/google-cloud-videointelligence/samples/quickstart.js b/packages/google-cloud-videointelligence/samples/quickstart.js
@@ -25,7 +25,7 @@ const video = Video.videoIntelligenceServiceClient({
 });
 
 // The GCS filepath of the video to analyze
-const gcsUri = 'gs://nodejs-docs-samples/videointelligence_quickstart.mp4';
+const gcsUri = 'gs://demomaker/volleyball_court.mp4';
 
 // Construct request
 const request = {
@@ -49,26 +49,40 @@ video.annotateVideo(request)
     faces.forEach((face, faceIdx) => {
       console.log('Thumbnail size:', face.thumbnail.length);
       face.segments.forEach((segment, segmentIdx) => {
-        console.log(`Track ${segmentIdx} of face ${faceIdx}: frames ${segment.startTimeOffset} to ${segment.endTimeOffset}`);
+        console.log(`Face #${faceIdx}, appearance #${segmentIdx}:`);
+        if (segment.startTimeOffset === -1 && segment.endTimeOffset === -1) {
+          console.log(`\tEntire video`);
+        } else {
+          console.log(`\tStart: ${segment.startTimeOffset / 1e6}s`);
+          console.log(`\tEnd: ${segment.endTimeOffset / 1e6}s`);
+        }
       });
     });
 
     // Gets labels for video from its annotations
     const labels = annotations.labelAnnotations;
     labels.forEach((label) => {
-      console.log('Label description:', label.description);
-      console.log('Locations:');
+      console.log(`Label ${label.description} occurs at:`);
       label.locations.forEach((location) => {
-        console.log(`\tFrames ${location.segment.startTimeOffset} to ${location.segment.endTimeOffset}`);
+        if (location.segment.startTimeOffset === -1 && location.segment.endTimeOffset === -1) {
+          console.log(`\tEntire video`);
+        } else {
+          console.log(`\tStart: ${location.segment.startTimeOffset / 1e6}s`);
+          console.log(`\tEnd: ${location.segment.endTimeOffset / 1e6}s`);
+        }
       });
     });
 
     // Gets shot changes for video from its annotations
     const shotChanges = annotations.shotAnnotations;
     shotChanges.forEach((shot, shotIdx) => {
-      console.log(`Scene ${shotIdx}:`);
-      console.log(`\tStart: ${shot.startTimeOffset}`);
-      console.log(`\tEnd: ${shot.endTimeOffset}`);
+      console.log(`Scene ${shotIdx} occurs from:`);
+      if (shot.startTimeOffset === -1 && shot.endTimeOffset === -1) {
+        console.log(`\tEntire video`);
+      } else {
+        console.log(`\tStart: ${shot.startTimeOffset / 1e6}s`);
+        console.log(`\tEnd: ${shot.endTimeOffset / 1e6}s`);
+      }
     });
   })
   .catch((err) => {