Package com.google.cloud.videointelligence.v1p2beta1 (2.26.0)

A client to Cloud Video Intelligence API

The interfaces provided are listed below, along with usage samples.

VideoIntelligenceServiceClient

Service Description: Service that implements Google Cloud Video Intelligence API.

Sample for VideoIntelligenceServiceClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VideoIntelligenceServiceClient videoIntelligenceServiceClient =
     VideoIntelligenceServiceClient.create()) {
   String inputUri = "inputUri470706498";
   List<Feature> features = new ArrayList<>();
   AnnotateVideoResponse response =
       videoIntelligenceServiceClient.annotateVideoAsync(inputUri, features).get();
 }

Classes

AnnotateVideoProgress

Video annotation progress. Included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Protobuf type google.cloud.videointelligence.v1p2beta1.AnnotateVideoProgress

AnnotateVideoProgress.Builder

Video annotation progress. Included in the metadata field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Protobuf type google.cloud.videointelligence.v1p2beta1.AnnotateVideoProgress

AnnotateVideoRequest

Video annotation request.

Protobuf type google.cloud.videointelligence.v1p2beta1.AnnotateVideoRequest

AnnotateVideoRequest.Builder

Video annotation request.

Protobuf type google.cloud.videointelligence.v1p2beta1.AnnotateVideoRequest

AnnotateVideoResponse

Video annotation response. Included in the response field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Protobuf type google.cloud.videointelligence.v1p2beta1.AnnotateVideoResponse

AnnotateVideoResponse.Builder

Video annotation response. Included in the response field of the Operation returned by the GetOperation call of the google::longrunning::Operations service.

Protobuf type google.cloud.videointelligence.v1p2beta1.AnnotateVideoResponse

Entity

Detected entity from video analysis.

Protobuf type google.cloud.videointelligence.v1p2beta1.Entity

Entity.Builder

Detected entity from video analysis.

Protobuf type google.cloud.videointelligence.v1p2beta1.Entity

ExplicitContentAnnotation

Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame.

Protobuf type google.cloud.videointelligence.v1p2beta1.ExplicitContentAnnotation

ExplicitContentAnnotation.Builder

Explicit content annotation (based on per-frame visual signals only). If no explicit content has been detected in a frame, no annotations are present for that frame.

Protobuf type google.cloud.videointelligence.v1p2beta1.ExplicitContentAnnotation

ExplicitContentDetectionConfig

Config for EXPLICIT_CONTENT_DETECTION.

Protobuf type google.cloud.videointelligence.v1p2beta1.ExplicitContentDetectionConfig

ExplicitContentDetectionConfig.Builder

Config for EXPLICIT_CONTENT_DETECTION.

Protobuf type google.cloud.videointelligence.v1p2beta1.ExplicitContentDetectionConfig

ExplicitContentFrame

Video frame level annotation results for explicit content.

Protobuf type google.cloud.videointelligence.v1p2beta1.ExplicitContentFrame

ExplicitContentFrame.Builder

Video frame level annotation results for explicit content.

Protobuf type google.cloud.videointelligence.v1p2beta1.ExplicitContentFrame

LabelAnnotation

Label annotation.

Protobuf type google.cloud.videointelligence.v1p2beta1.LabelAnnotation

LabelAnnotation.Builder

Label annotation.

Protobuf type google.cloud.videointelligence.v1p2beta1.LabelAnnotation

LabelDetectionConfig

Config for LABEL_DETECTION.

Protobuf type google.cloud.videointelligence.v1p2beta1.LabelDetectionConfig

LabelDetectionConfig.Builder

Config for LABEL_DETECTION.

Protobuf type google.cloud.videointelligence.v1p2beta1.LabelDetectionConfig

LabelFrame

Video frame level annotation results for label detection.

Protobuf type google.cloud.videointelligence.v1p2beta1.LabelFrame

LabelFrame.Builder

Video frame level annotation results for label detection.

Protobuf type google.cloud.videointelligence.v1p2beta1.LabelFrame

LabelSegment

Video segment level annotation results for label detection.

Protobuf type google.cloud.videointelligence.v1p2beta1.LabelSegment

LabelSegment.Builder

Video segment level annotation results for label detection.

Protobuf type google.cloud.videointelligence.v1p2beta1.LabelSegment

NormalizedBoundingBox

Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1].

Protobuf type google.cloud.videointelligence.v1p2beta1.NormalizedBoundingBox

NormalizedBoundingBox.Builder

Normalized bounding box. The normalized vertex coordinates are relative to the original image. Range: [0, 1].

Protobuf type google.cloud.videointelligence.v1p2beta1.NormalizedBoundingBox

Normalized bounding polygon for text (that might not be aligned with axis). Contains list of the corner points in clockwise order starting from top-left corner. For example, for a rectangular bounding box: When the text is horizontal it might look like: 0----1 | | 3----2

When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0

and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box.

Protobuf type google.cloud.videointelligence.v1p2beta1.NormalizedBoundingPoly

NormalizedBoundingPoly.Builder

When it's clockwise rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0

and the vertex order will still be (0, 1, 2, 3). Note that values can be less than 0, or greater than 1 due to trignometric calculations for location of the box.

Protobuf type google.cloud.videointelligence.v1p2beta1.NormalizedBoundingPoly

NormalizedVertex

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

Protobuf type google.cloud.videointelligence.v1p2beta1.NormalizedVertex

NormalizedVertex.Builder

A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.

Protobuf type google.cloud.videointelligence.v1p2beta1.NormalizedVertex

ObjectTrackingAnnotation

Annotations corresponding to one tracked object.

Protobuf type google.cloud.videointelligence.v1p2beta1.ObjectTrackingAnnotation

ObjectTrackingAnnotation.Builder

Annotations corresponding to one tracked object.

Protobuf type google.cloud.videointelligence.v1p2beta1.ObjectTrackingAnnotation

ObjectTrackingFrame

Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence.

Protobuf type google.cloud.videointelligence.v1p2beta1.ObjectTrackingFrame

ObjectTrackingFrame.Builder

Video frame level annotations for object detection and tracking. This field stores per frame location, time offset, and confidence.

Protobuf type google.cloud.videointelligence.v1p2beta1.ObjectTrackingFrame

ShotChangeDetectionConfig

Config for SHOT_CHANGE_DETECTION.

Protobuf type google.cloud.videointelligence.v1p2beta1.ShotChangeDetectionConfig

ShotChangeDetectionConfig.Builder

Config for SHOT_CHANGE_DETECTION.

Protobuf type google.cloud.videointelligence.v1p2beta1.ShotChangeDetectionConfig

TextAnnotation

Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection.

Protobuf type google.cloud.videointelligence.v1p2beta1.TextAnnotation

TextAnnotation.Builder

Annotations related to one detected OCR text snippet. This will contain the corresponding text, confidence value, and frame level information for each detection.

Protobuf type google.cloud.videointelligence.v1p2beta1.TextAnnotation

TextDetectionConfig

Config for TEXT_DETECTION.

Protobuf type google.cloud.videointelligence.v1p2beta1.TextDetectionConfig

TextDetectionConfig.Builder

Config for TEXT_DETECTION.

Protobuf type google.cloud.videointelligence.v1p2beta1.TextDetectionConfig

TextFrame

Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets.

Protobuf type google.cloud.videointelligence.v1p2beta1.TextFrame

TextFrame.Builder

Video frame level annotation results for text annotation (OCR). Contains information regarding timestamp and bounding box locations for the frames containing detected OCR text snippets.

Protobuf type google.cloud.videointelligence.v1p2beta1.TextFrame

TextSegment

Video segment level annotation results for text detection.

Protobuf type google.cloud.videointelligence.v1p2beta1.TextSegment

TextSegment.Builder

Video segment level annotation results for text detection.

Protobuf type google.cloud.videointelligence.v1p2beta1.TextSegment

VideoAnnotationProgress

Annotation progress for a single video.

Protobuf type google.cloud.videointelligence.v1p2beta1.VideoAnnotationProgress

VideoAnnotationProgress.Builder

Annotation progress for a single video.

Protobuf type google.cloud.videointelligence.v1p2beta1.VideoAnnotationProgress

VideoAnnotationResults

Annotation results for a single video.

Protobuf type google.cloud.videointelligence.v1p2beta1.VideoAnnotationResults

VideoAnnotationResults.Builder

Annotation results for a single video.

Protobuf type google.cloud.videointelligence.v1p2beta1.VideoAnnotationResults

VideoContext

Video context and/or feature-specific parameters.

Protobuf type google.cloud.videointelligence.v1p2beta1.VideoContext

VideoContext.Builder

Video context and/or feature-specific parameters.

Protobuf type google.cloud.videointelligence.v1p2beta1.VideoContext

VideoIntelligenceServiceClient

Service Description: Service that implements Google Cloud Video Intelligence API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (VideoIntelligenceServiceClient videoIntelligenceServiceClient =
     VideoIntelligenceServiceClient.create()) {
   String inputUri = "inputUri470706498";
   List<Feature> features = new ArrayList<>();
   AnnotateVideoResponse response =
       videoIntelligenceServiceClient.annotateVideoAsync(inputUri, features).get();
 }

Note: close() needs to be called on the VideoIntelligenceServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of VideoIntelligenceServiceSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VideoIntelligenceServiceSettings videoIntelligenceServiceSettings =
     VideoIntelligenceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VideoIntelligenceServiceClient videoIntelligenceServiceClient =
     VideoIntelligenceServiceClient.create(videoIntelligenceServiceSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VideoIntelligenceServiceSettings videoIntelligenceServiceSettings =
     VideoIntelligenceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 VideoIntelligenceServiceClient videoIntelligenceServiceClient =
     VideoIntelligenceServiceClient.create(videoIntelligenceServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VideoIntelligenceServiceSettings videoIntelligenceServiceSettings =
     VideoIntelligenceServiceSettings.newHttpJsonBuilder().build();
 VideoIntelligenceServiceClient videoIntelligenceServiceClient =
     VideoIntelligenceServiceClient.create(videoIntelligenceServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

The default service address (videointelligence.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of annotateVideo to 30 seconds:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 VideoIntelligenceServiceSettings.Builder videoIntelligenceServiceSettingsBuilder =
     VideoIntelligenceServiceSettings.newBuilder();
 videoIntelligenceServiceSettingsBuilder
     .annotateVideoSettings()
     .setRetrySettings(
         videoIntelligenceServiceSettingsBuilder
             .annotateVideoSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VideoIntelligenceServiceSettings videoIntelligenceServiceSettings =
     videoIntelligenceServiceSettingsBuilder.build();

Package com.google.cloud.videointelligence.v1p2beta1 (2.26.0)

VideoIntelligenceServiceClient

Classes

Interfaces

Enums