Google Cloud Video Intelligence: Node.js Client

release levelnpm versioncodecov

Google Cloud Video Intelligence API client for Node.js

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Video Intelligence API.
  4. Set up authentication with a service account so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/video-intelligence

Using the client library

// Imports the Google Cloud Video Intelligence libraryconst videoIntelligence = require('@google-cloud/video-intelligence');// Creates a clientconst client = new videoIntelligence.VideoIntelligenceServiceClient();// The GCS uri of the video to analyzeconst gcsUri = 'gs://cloud-samples-data/video/cat.mp4';// Construct requestconst request = {  inputUri: gcsUri,  features: ['LABEL_DETECTION'],};// Execute requestconst [operation] = await client.annotateVideo(request);console.log(  'Waiting for operation to complete... (this may take a few minutes)');const [operationResult] = await operation.promise();// Gets annotations for videoconst annotations = operationResult.annotationResults[0];// Gets labels for video from its annotationsconst labels = annotations.segmentLabelAnnotations;labels.forEach(label => {  console.log(`Label ${label.entity.description} occurs at:`);  label.segments.forEach(segment => {    segment = segment.segment;    if (segment.startTimeOffset.seconds === undefined) {      segment.startTimeOffset.seconds = 0;    }    if (segment.startTimeOffset.nanos === undefined) {      segment.startTimeOffset.nanos = 0;    }    if (segment.endTimeOffset.seconds === undefined) {      segment.endTimeOffset.seconds = 0;    }    if (segment.endTimeOffset.nanos === undefined) {      segment.endTimeOffset.nanos = 0;    }    console.log(      `\tStart: ${segment.startTimeOffset.seconds}` +        `.${(segment.startTimeOffset.nanos / 1e6).toFixed(0)}s`    );    console.log(      `\tEnd: ${segment.endTimeOffset.seconds}.` +        `${(segment.endTimeOffset.nanos / 1e6).toFixed(0)}s`    );  });});

Samples

Samples are in thesamples/ directory. The samples'README.mdhas instructions for running the samples.

SampleSource CodeTry it
Analyze-streaming-annotation-to-storagesource codeOpen in Cloud Shell
Analyze-streaming-automl-classificationsource codeOpen in Cloud Shell
Analyze-streaming-labelssource codeOpen in Cloud Shell
Analyze-streaming-objectsource codeOpen in Cloud Shell
Analyze-streaming-safe-searchsource codeOpen in Cloud Shell
Analyze-streaming-shot-changesource codeOpen in Cloud Shell
Analyzesource codeOpen in Cloud Shell
Analyze.v1p2beta1source codeOpen in Cloud Shell
Analyze_face_detectionsource codeOpen in Cloud Shell
Analyze_face_detection_gcssource codeOpen in Cloud Shell
Analyze_person_detectionsource codeOpen in Cloud Shell
Analyze_person_detection_gcssource codeOpen in Cloud Shell
Detect_logosource codeOpen in Cloud Shell
Detect_logo_gcssource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

TheGoogle Cloud Video Intelligence Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.

Client libraries targetting some end-of-life versions of Node.js are available, andcan be installed via npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versionscompatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to beGeneral Availability (GA). This means itis stable; the code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againstGA librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its template in thisdirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.