v1p3beta1. VideoIntelligenceServiceClient
Source: v1p3beta1/
Service that implements Google Cloud Video Intelligence API.
Properties
new VideoIntelligenceServiceClient([options])
Construct an instance of VideoIntelligenceServiceClient.
Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
options |
|
Yes |
The configuration object. See the subsequent parameters for more details. Values in
|
Properties
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
annotateVideo(request[, options][, callback]) → Promise
Performs asynchronous video annotation. Progress and results can be
retrieved through the google.longrunning.Operations interface.
Operation.metadata contains AnnotateVideoProgress (progress).
Operation.response contains AnnotateVideoResponse (results).
Example
const videoIntelligence = require('@google-cloud/video-intelligence');
const client = new videoIntelligence.v1p3beta1.VideoIntelligenceServiceClient({
// optional auth parameters.
});
const inputUri = 'gs://demomaker/cat.mp4';
const featuresElement = 'LABEL_DETECTION';
const features = [featuresElement];
const request = {
inputUri: inputUri,
features: features,
};
// Handle the operation using the promise pattern.
client.annotateVideo(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
const result = responses[0];
const metadata = responses[1];
const finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
const inputUri = 'gs://demomaker/cat.mp4';
const featuresElement = 'LABEL_DETECTION';
const features = [featuresElement];
const request = {
inputUri: inputUri,
features: features,
};
// Handle the operation using the event emitter pattern.
client.annotateVideo(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
const inputUri = 'gs://demomaker/cat.mp4';
const featuresElement = 'LABEL_DETECTION';
const features = [featuresElement];
const request = {
inputUri: inputUri,
features: features,
};
// Handle the operation using the await pattern.
const [operation] = await client.annotateVideo(request);
const [response] = await operation.promise();
Parameters
| Name | Type | Optional | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
request |
Object |
|
The request object that will be sent. Values in
|
||||||||||||||||||||||||||||
|
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. |
||||||||||||||||||||||||||||
|
callback |
function(nullable Error, nullable Object) |
Yes |
The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Returns
-
Promise- The promise which resolves to an array. The first element of the array is a gax.Operation object. The promise has a method named "cancel" which cancels the ongoing API call.
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. |