Reference documentation and code samples for the Cloud Video Intelligence V1 Client class VideoIntelligenceServiceClient.
Service Description: Service that implements the 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:
$videoIntelligenceServiceClient = new VideoIntelligenceServiceClient();
try {
$inputUri = 'gs://cloud-samples-data/video/cat.mp4';
$featuresElement = Feature::LABEL_DETECTION;
$features = [$featuresElement];
$operationResponse = $videoIntelligenceServiceClient->annotateVideo(['inputUri' => $inputUri, 'features' => $features]);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$inputUri = 'gs://cloud-samples-data/video/cat.mp4';
$featuresElement = Feature::LABEL_DETECTION;
$features = [$featuresElement];
$operationResponse = $videoIntelligenceServiceClient->annotateVideo(['inputUri' => $inputUri, 'features' => $features]);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $videoIntelligenceServiceClient->resumeOperation($operationName, 'annotateVideo');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$videoIntelligenceServiceClient->close();
}
Methods
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\LongRunning\OperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
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).
| Parameters | |
|---|---|
| Name | Description |
optionalArgs |
array
Optional. |
↳ inputUri |
string
Input video location. Currently, only Cloud Storage URIs are supported. URIs must be specified in the following format: |
↳ inputContent |
string
The video data bytes. If unset, the input video(s) should be specified via the |
↳ features |
int[]
Required. Requested video annotation features. For allowed values, use constants defined on Google\Cloud\VideoIntelligence\V1\Feature |
↳ videoContext |
VideoContext
Additional video context and/or feature-specific parameters. |
↳ outputUri |
string
Optional. Location where the output (in JSON format) should be stored. Currently, only Cloud Storage URIs are supported. These must be specified in the following format: |
↳ locationId |
string
Optional. Cloud region where annotation should take place. Supported cloud regions are: |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\VideoIntelligence\V1\AnnotateVideoResponse;
use Google\Cloud\VideoIntelligence\V1\VideoIntelligenceServiceClient;
use Google\Rpc\Status;
/**
* This sample 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,
* please see the apiEndpoint client configuration option for more details.
*/
function annotate_video_sample(): void
{
// Create a client.
$videoIntelligenceServiceClient = new VideoIntelligenceServiceClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $videoIntelligenceServiceClient->annotateVideo();
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AnnotateVideoResponse $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
Constants
SERVICE_NAME
Value: 'google.cloud.videointelligence.v1.VideoIntelligenceService'The name of the service.
SERVICE_ADDRESS
Value: 'videointelligence.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.