Service that implements Google Cloud Video Intelligence API. v1p1beta1
Package
@google-cloud/video-intelligence!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of VideoIntelligenceServiceClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
operationsClient
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
gax.OperationsClient | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
videoIntelligenceServiceStub
videoIntelligenceServiceStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
Methods
annotateVideo(request, options)
annotateVideo(request: protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoResponse, protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoProgress>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoResponse, protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoProgress>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
annotateVideo(request, options, callback)
annotateVideo(request: protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoResponse, protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoProgress>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoResponse, protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoProgress>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
annotateVideo(request, callback)
annotateVideo(request: protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoRequest, callback: Callback<LROperation<protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoResponse, protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoProgress>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoRequest
|
callback |
Callback<LROperation<protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoResponse, protos.google.cloud.videointelligence.v1p1beta1.IAnnotateVideoProgress>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
checkAnnotateVideoProgress(name)
checkAnnotateVideoProgress(name: string): Promise<LROperation<protos.google.cloud.videointelligence.v1p1beta1.AnnotateVideoResponse, protos.google.cloud.videointelligence.v1p1beta1.AnnotateVideoProgress>>;
Check the status of the long running operation returned by annotateVideo()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.videointelligence.v1p1beta1.AnnotateVideoResponse, protos.google.cloud.videointelligence.v1p1beta1.AnnotateVideoProgress>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
|
close()
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<void> | {Promise} A promise that resolves when the client is closed.
|
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
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<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|