com.google.cloud.videointelligence.v1p3beta1

Class StreamingVideoIntelligenceServiceClient

java.lang.Object

com.google.cloud.videointelligence.v1p3beta1.StreamingVideoIntelligenceServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class StreamingVideoIntelligenceServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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().

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

1. 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.
2. 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.
3. 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 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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceSettings settings) Constructs an instance of StreamingVideoIntelligenceServiceClient, using the given settings.
protected	StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static StreamingVideoIntelligenceServiceClient	create() Constructs an instance of StreamingVideoIntelligenceServiceClient with default settings.
static StreamingVideoIntelligenceServiceClient	create(StreamingVideoIntelligenceServiceSettings settings) Constructs an instance of StreamingVideoIntelligenceServiceClient, using the given settings.
static StreamingVideoIntelligenceServiceClient	create(StreamingVideoIntelligenceServiceStub stub) Constructs an instance of StreamingVideoIntelligenceServiceClient, using the given stub for making calls.
StreamingVideoIntelligenceServiceSettings	getSettings()
StreamingVideoIntelligenceServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()
com.google.api.gax.rpc.BidiStreamingCallable<StreamingAnnotateVideoRequest,StreamingAnnotateVideoResponse>	streamingAnnotateVideoCallable() Performs video annotation with bidirectional streaming: emitting results while sending video/audio bytes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamingVideoIntelligenceServiceClient

protected StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceSettings settings)
                                           throws IOException

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.

Throws:

IOException

StreamingVideoIntelligenceServiceClient

protected StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceStub stub)

Method Detail

create

public static final StreamingVideoIntelligenceServiceClient create()
                                                            throws IOException

Constructs an instance of StreamingVideoIntelligenceServiceClient with default settings.

Throws:

IOException

create

public static final StreamingVideoIntelligenceServiceClient create(StreamingVideoIntelligenceServiceSettings settings)
                                                            throws IOException

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.

Throws:

IOException

create

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).

getSettings

public final StreamingVideoIntelligenceServiceSettings getSettings()

getStub

public StreamingVideoIntelligenceServiceStub getStub()

streamingAnnotateVideoCallable

public final com.google.api.gax.rpc.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.
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException