Class StreamingVideoIntelligenceServiceClient (2.52.0)

Service Description: Service that implements streaming 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 (StreamingVideoIntelligenceServiceClient streamingVideoIntelligenceServiceClient =
     StreamingVideoIntelligenceServiceClient.create()) {
   BidiStream<StreamingAnnotateVideoRequest, StreamingAnnotateVideoResponse> bidiStream =
       streamingVideoIntelligenceServiceClient.streamingAnnotateVideoCallable().call();
   StreamingAnnotateVideoRequest request = StreamingAnnotateVideoRequest.newBuilder().build();
   bidiStream.send(request);
   for (StreamingAnnotateVideoResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

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

Methods
Method	Description	Method Variants
StreamingAnnotateVideo	Performs video annotation with bidirectional streaming: emitting results while sending video/audio bytes. This method is only available via the gRPC API (not REST).	Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. streamingAnnotateVideoCallable()

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 StreamingVideoIntelligenceServiceSettings 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
 StreamingVideoIntelligenceServiceSettings streamingVideoIntelligenceServiceSettings =
     StreamingVideoIntelligenceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 StreamingVideoIntelligenceServiceClient streamingVideoIntelligenceServiceClient =
     StreamingVideoIntelligenceServiceClient.create(streamingVideoIntelligenceServiceSettings);

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
 StreamingVideoIntelligenceServiceSettings streamingVideoIntelligenceServiceSettings =
     StreamingVideoIntelligenceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 StreamingVideoIntelligenceServiceClient streamingVideoIntelligenceServiceClient =
     StreamingVideoIntelligenceServiceClient.create(streamingVideoIntelligenceServiceSettings);

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

Inheritance

java.lang.Object > StreamingVideoIntelligenceServiceClient

Static Methods

create()

public static final StreamingVideoIntelligenceServiceClient create()

Constructs an instance of StreamingVideoIntelligenceServiceClient with default settings.

Returns
Type	Description
`StreamingVideoIntelligenceServiceClient`

Exceptions
Type	Description
`IOException`

create(StreamingVideoIntelligenceServiceSettings settings)

public static final StreamingVideoIntelligenceServiceClient create(StreamingVideoIntelligenceServiceSettings settings)

Constructs an instance of StreamingVideoIntelligenceServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`StreamingVideoIntelligenceServiceSettings`

Returns
Type	Description
`StreamingVideoIntelligenceServiceClient`

Exceptions
Type	Description
`IOException`

create(StreamingVideoIntelligenceServiceStub stub)

public static final StreamingVideoIntelligenceServiceClient create(StreamingVideoIntelligenceServiceStub stub)

Constructs an instance of StreamingVideoIntelligenceServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(StreamingVideoIntelligenceServiceSettings).

Parameter
Name	Description
`stub`	`StreamingVideoIntelligenceServiceStub`

Returns
Type	Description
`StreamingVideoIntelligenceServiceClient`

Constructors

StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceSettings settings)

protected StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceSettings settings)

Constructs an instance of StreamingVideoIntelligenceServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`StreamingVideoIntelligenceServiceSettings`

StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceStub stub)

protected StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceStub stub)

Parameter
Name	Description
`stub`	`StreamingVideoIntelligenceServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getSettings()

public final StreamingVideoIntelligenceServiceSettings getSettings()

Returns
Type	Description
`StreamingVideoIntelligenceServiceSettings`

getStub()

public StreamingVideoIntelligenceServiceStub getStub()

Returns
Type	Description
`StreamingVideoIntelligenceServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

streamingAnnotateVideoCallable()

public final BidiStreamingCallable<StreamingAnnotateVideoRequest,StreamingAnnotateVideoResponse> streamingAnnotateVideoCallable()

Performs video annotation with bidirectional streaming: emitting results while sending video/audio bytes. This method is only available via the gRPC API (not REST).

Sample code:


 // 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 (StreamingVideoIntelligenceServiceClient streamingVideoIntelligenceServiceClient =
     StreamingVideoIntelligenceServiceClient.create()) {
   BidiStream<StreamingAnnotateVideoRequest, StreamingAnnotateVideoResponse> bidiStream =
       streamingVideoIntelligenceServiceClient.streamingAnnotateVideoCallable().call();
   StreamingAnnotateVideoRequest request = StreamingAnnotateVideoRequest.newBuilder().build();
   bidiStream.send(request);
   for (StreamingAnnotateVideoResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

Returns
Type	Description
`BidiStreamingCallable<StreamingAnnotateVideoRequest,StreamingAnnotateVideoResponse>`