Class StreamingVideoIntelligenceServiceClient (2.1.0) 

public class StreamingVideoIntelligenceServiceClient implements 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 StreamingVideoIntelligenceServiceSettings streamingVideoIntelligenceServiceSettings =
     StreamingVideoIntelligenceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 StreamingVideoIntelligenceServiceClient streamingVideoIntelligenceServiceClient =
     StreamingVideoIntelligenceServiceClient.create(streamingVideoIntelligenceServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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

Implements

BackgroundResource

Static Methods

create()

public static final StreamingVideoIntelligenceServiceClient create()

Constructs an instance of StreamingVideoIntelligenceServiceClient with default settings.

Returns
TypeDescription
StreamingVideoIntelligenceServiceClient
Exceptions
TypeDescription
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
NameDescription
settingsStreamingVideoIntelligenceServiceSettings
Returns
TypeDescription
StreamingVideoIntelligenceServiceClient
Exceptions
TypeDescription
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
NameDescription
stubStreamingVideoIntelligenceServiceStub
Returns
TypeDescription
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
NameDescription
settingsStreamingVideoIntelligenceServiceSettings

StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceStub stub)

protected StreamingVideoIntelligenceServiceClient(StreamingVideoIntelligenceServiceStub stub)
Parameter
NameDescription
stubStreamingVideoIntelligenceServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

getSettings()

public final StreamingVideoIntelligenceServiceSettings getSettings()
Returns
TypeDescription
StreamingVideoIntelligenceServiceSettings

getStub()

public StreamingVideoIntelligenceServiceStub getStub()
Returns
TypeDescription
StreamingVideoIntelligenceServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
BidiStreamingCallable<StreamingAnnotateVideoRequest,StreamingAnnotateVideoResponse>