| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="videointelligence_v1beta1.html">Google Cloud Video Intelligence API</a> . <a href="videointelligence_v1beta1.videos.html">videos</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#annotate">annotate(body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Performs asynchronous video annotation. Progress and results can be</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="annotate">annotate(body, x__xgafv=None)</code> |
| <pre>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). |
| |
| Args: |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Video annotation request. |
| "videoContext": { # Video context and/or feature-specific parameters. # Additional video context and/or feature-specific parameters. |
| "shotChangeDetectionModel": "A String", # Model to use for shot change detection. |
| # Supported values: "latest" and "stable" (the default). |
| "labelDetectionModel": "A String", # Model to use for label detection. |
| # Supported values: "latest" and "stable" (the default). |
| "segments": [ # Video segments to annotate. The segments may overlap and are not required |
| # to be contiguous or span the whole video. If unspecified, each video |
| # is treated as a single segment. |
| { # Video segment. |
| "endTimeOffset": "A String", # End offset in microseconds (inclusive). Unset means 0. |
| "startTimeOffset": "A String", # Start offset in microseconds (inclusive). Unset means 0. |
| }, |
| ], |
| "labelDetectionMode": "A String", # If label detection has been requested, what labels should be detected |
| # in addition to video-level labels or segment-level labels. If unspecified, |
| # defaults to `SHOT_MODE`. |
| }, |
| "features": [ # Requested video annotation features. |
| "A String", |
| ], |
| "inputContent": "A String", # The video data bytes. Encoding: base64. If unset, the input video(s) |
| # should be specified via `input_uri`. If set, `input_uri` should be unset. |
| "inputUri": "A String", # Input video location. Currently, only |
| # [Google Cloud Storage](https://cloud.google.com/storage/) URIs are |
| # supported, which must be specified in the following format: |
| # `gs://bucket-id/object-id` (other URI formats return |
| # google.rpc.Code.INVALID_ARGUMENT). For more information, see |
| # [Request URIs](/storage/docs/reference-uris). |
| # A video URI may include wildcards in `object-id`, and thus identify |
| # multiple videos. Supported wildcards: '*' to match 0 or more characters; |
| # '?' to match 1 character. If unset, the input video should be embedded |
| # in the request as `input_content`. If set, `input_content` should be unset. |
| "locationId": "A String", # Optional cloud region where annotation should take place. Supported cloud |
| # regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region |
| # is specified, a region will be determined based on video file location. |
| "outputUri": "A String", # Optional location where the output (in JSON format) should be stored. |
| # Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) |
| # URIs are supported, which must be specified in the following format: |
| # `gs://bucket-id/object-id` (other URI formats return |
| # google.rpc.Code.INVALID_ARGUMENT). For more information, see |
| # [Request URIs](/storage/docs/reference-uris). |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. |
| # programming environments, including REST APIs and RPC APIs. It is used by |
| # [gRPC](https://github.com/grpc). The error model is designed to be: |
| # |
| # - Simple to use and understand for most users |
| # - Flexible enough to meet unexpected needs |
| # |
| # # Overview |
| # |
| # The `Status` message contains three pieces of data: error code, error message, |
| # and error details. The error code should be an enum value of |
| # google.rpc.Code, but it may accept additional error codes if needed. The |
| # error message should be a developer-facing English message that helps |
| # developers *understand* and *resolve* the error. If a localized user-facing |
| # error message is needed, put the localized message in the error details or |
| # localize it in the client. The optional error details may contain arbitrary |
| # information about the error. There is a predefined set of error detail types |
| # in the package `google.rpc` that can be used for common error conditions. |
| # |
| # # Language mapping |
| # |
| # The `Status` message is the logical representation of the error model, but it |
| # is not necessarily the actual wire format. When the `Status` message is |
| # exposed in different client libraries and different wire protocols, it can be |
| # mapped differently. For example, it will likely be mapped to some exceptions |
| # in Java, but more likely mapped to some error codes in C. |
| # |
| # # Other uses |
| # |
| # The error model and the `Status` message can be used in a variety of |
| # environments, either with or without APIs, to provide a |
| # consistent developer experience across different environments. |
| # |
| # Example uses of this error model include: |
| # |
| # - Partial errors. If a service needs to return partial errors to the client, |
| # it may embed the `Status` in the normal response to indicate the partial |
| # errors. |
| # |
| # - Workflow errors. A typical workflow has multiple steps. Each step may |
| # have a `Status` message for error reporting. |
| # |
| # - Batch operations. If a client uses batch request and batch response, the |
| # `Status` message should be used directly inside batch response, one for |
| # each error sub-response. |
| # |
| # - Asynchronous operations. If an API call embeds asynchronous operation |
| # results in its response, the status of those operations should be |
| # represented directly using the `Status` message. |
| # |
| # - Logging. If some API errors are stored in logs, the message `Status` could |
| # be used directly after any stripping needed for security/privacy reasons. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There will be a |
| # common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If true, the operation is completed, and either `error` or `response` is |
| # available. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should have the format of `operations/some/unique/name`. |
| }</pre> |
| </div> |
| |
| </body></html> |
