Constructor
new VideoIntelligenceServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of VideoIntelligenceServiceClient.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
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
(async) checkAnnotateVideoProgress(name) → {Promise}
Check the status of the long running operation returned by annotateVideo().
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
| Type | Description |
|---|---|
| Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Input video location. Currently, only
* Google Cloud Storage (https://cloud.google.com/storage/) URIs are
* supported, which must be specified in the following format:
* `gs://bucket-id/object-id` (other URI formats return
* google.rpc.Code.INVALID_ARGUMENT google.rpc.Code.INVALID_ARGUMENT). For
* more information, see Request
* URIs (https://cloud.google.com/storage/docs/request-endpoints). A video URI
* may include wildcards in `object-id`, and thus identify multiple videos.
* Supported wildcards: '*' to match 0 or more characters;
* '?' to match 1 character. If unset, the input video should be embedded
* in the request as `input_content`. If set, `input_content` should be unset.
*/
// const inputUri = 'abc123'
/**
* The video data bytes.
* If unset, the input video(s) should be specified via `input_uri`.
* If set, `input_uri` should be unset.
*/
// const inputContent = Buffer.from('string')
/**
* Required. Requested video annotation features.
*/
// const features = [1,2,3,4]
/**
* Additional video context and/or feature-specific parameters.
*/
// const videoContext = {}
/**
* Optional. Location where the output (in JSON format) should be stored.
* Currently, only Google Cloud Storage (https://cloud.google.com/storage/)
* URIs are supported, which must be specified in the following format:
* `gs://bucket-id/object-id` (other URI formats return
* google.rpc.Code.INVALID_ARGUMENT google.rpc.Code.INVALID_ARGUMENT). For
* more information, see Request
* URIs (https://cloud.google.com/storage/docs/request-endpoints).
*/
// const outputUri = 'abc123'
/**
* Optional. Cloud region where annotation should take place. Supported cloud
* regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region
* is specified, a region will be determined based on video file location.
*/
// const locationId = 'abc123'
// Imports the Videointelligence library
const {VideoIntelligenceServiceClient} = require('@google-cloud/video-intelligence').v1beta2;
// Instantiates a client
const videointelligenceClient = new VideoIntelligenceServiceClient();
async function callAnnotateVideo() {
// Construct request
const request = {
features,
};
// Run request
const [operation] = await videointelligenceClient.annotateVideo(request);
const [response] = await operation.promise();
console.log(response);
}
callAnnotateVideo();
close() → {Promise}
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns:
| Type | Description |
|---|---|
| Promise |
A promise that resolves when the client is closed. |
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
| Type | Description |
|---|---|
| Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns:
| Type | Description |
|---|---|
| Promise |
A promise that resolves to an authenticated service stub. |