@google-cloud/video-intelligence 2.1.0 » Class: StreamingVideoIntelligenceServiceClient

Properties

apiEndpoint
port

scopes
servicePath

Methods

getProjectId(callback)

streamingAnnotateVideo([options])

new StreamingVideoIntelligenceServiceClient([options])

Construct an instance of StreamingVideoIntelligenceServiceClient.

Parameters

Name Type Optional Description

options

Yes

The configuration object. See the subsequent parameters for more details.

Values in options have the following properties:

Name	Optional	Description
credentials	Yes	Credentials object.
credentials.client_email	Yes
credentials.private_key	Yes
email	Yes	Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename	Yes	Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port	Yes	The port on which to connect to the remote host.
projectId	Yes	The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
promise	Yes	Custom promise module to use instead of native Promises.
servicePath	Yes	The domain name of the API remote host.

Properties

static

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

static

port

The port for this API service.

static

scopes

The scopes needed to make gRPC calls for every method defined in this service.

static

servicePath

The DNS address for this API service.

Methods

getProjectId(callback)

Return the project ID used by this class.

Parameter

Name	Type	Optional	Description
callback	function(Error, string)		the callback to be called with the current project Id.

streamingAnnotateVideo([options]) → Stream

Performs video annotation with bidirectional streaming: emitting results while sending video/audio bytes. This method is only available via the gRPC API (not REST).

Example

const videoIntelligence = require('@google-cloud/video-intelligence');

const client = new videoIntelligence.v1p3beta1.StreamingVideoIntelligenceServiceClient({
  // optional auth parameters.
});

const stream = client.streamingAnnotateVideo().on('data', response => {
  // doThingsWith(response)
});
const request = {};
// Write request objects.
stream.write(request);

Parameter

Name	Type	Optional	Description
options	Object	Yes	Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns

Stream

An object stream which is both readable and writable. It accepts objects representing StreamingAnnotateVideoRequest for write() method, and will emit objects representing StreamingAnnotateVideoResponse on 'data' event asynchronously.