Documentation ¶
Overview ¶
Package videointelligence is an auto-generated package for the Google Cloud Video Intelligence API.
NOTE: This package is in alpha. It is not stable, and is likely to change.
Google Cloud Video Intelligence API.
Index ¶
- func DefaultAuthScopes() []string
- type AnnotateVideoOperation
- func (op *AnnotateVideoOperation) Done() bool
- func (op *AnnotateVideoOperation) Metadata() (*videointelligencepb.AnnotateVideoProgress, error)
- func (op *AnnotateVideoOperation) Name() string
- func (op *AnnotateVideoOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*videointelligencepb.AnnotateVideoResponse, error)
- func (op *AnnotateVideoOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*videointelligencepb.AnnotateVideoResponse, error)
- type CallOptions
- type Client
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type AnnotateVideoOperation ¶
type AnnotateVideoOperation struct {
// contains filtered or unexported fields
}
AnnotateVideoOperation manages a long-running operation from AnnotateVideo.
func (*AnnotateVideoOperation) Done ¶
func (op *AnnotateVideoOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*AnnotateVideoOperation) Metadata ¶
func (op *AnnotateVideoOperation) Metadata() (*videointelligencepb.AnnotateVideoProgress, error)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*AnnotateVideoOperation) Name ¶
func (op *AnnotateVideoOperation) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*AnnotateVideoOperation) Poll ¶
func (op *AnnotateVideoOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*videointelligencepb.AnnotateVideoResponse, error)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*AnnotateVideoOperation) Wait ¶
func (op *AnnotateVideoOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*videointelligencepb.AnnotateVideoResponse, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CallOptions ¶ added in v0.9.0
type CallOptions struct {
AnnotateVideo []gax.CallOption
}
CallOptions contains the retry settings for each method of Client.
type Client ¶ added in v0.9.0
type Client struct { // LROClient is used internally to handle longrunning operations. // It is exposed so that its CallOptions can be modified if required. // Users should not Close this client. LROClient *lroauto.OperationsClient // The call options for this service. CallOptions *CallOptions // contains filtered or unexported fields }
Client is a client for interacting with Google Cloud Video Intelligence API.
Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
func NewClient ¶ added in v0.9.0
NewClient creates a new video intelligence service client.
Service that implements Google Cloud Video Intelligence API.
Example ¶
package main import ( "context" videointelligence "cloud.google.com/go/videointelligence/apiv1beta1" ) func main() { ctx := context.Background() c, err := videointelligence.NewClient(ctx) if err != nil { // TODO: Handle error. } // TODO: Use client. _ = c }
Output:
func (*Client) AnnotateVideo ¶ added in v0.9.0
func (c *Client) AnnotateVideo(ctx context.Context, req *videointelligencepb.AnnotateVideoRequest, opts ...gax.CallOption) (*AnnotateVideoOperation, error)
AnnotateVideo 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 ¶
package main import ( "context" videointelligence "cloud.google.com/go/videointelligence/apiv1beta1" videointelligencepb "google.golang.org/genproto/googleapis/cloud/videointelligence/v1beta1" ) func main() { ctx := context.Background() c, err := videointelligence.NewClient(ctx) if err != nil { // TODO: Handle error. } req := &videointelligencepb.AnnotateVideoRequest{ // TODO: Fill request struct fields. } op, err := c.AnnotateVideo(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*Client) AnnotateVideoOperation ¶ added in v0.9.0
func (c *Client) AnnotateVideoOperation(name string) *AnnotateVideoOperation
AnnotateVideoOperation returns a new AnnotateVideoOperation from a given name. The name must be that of a previously created AnnotateVideoOperation, possibly from a different process.
func (*Client) Close ¶ added in v0.9.0
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection ¶ added in v0.9.0
func (c *Client) Connection() *grpc.ClientConn
Connection returns the client's connection to the API service.