class Google::Apis::VideointelligenceV1p1beta1::CloudVideoIntelligenceService

Cloud Video Intelligence API

Detects objects, explicit content, and scene changes in videos. It also

specifies the region for annotation and transcribes speech to text. Supports
both asynchronous API and streaming API.

@example

require 'google/apis/videointelligence_v1p1beta1'

Videointelligence = Google::Apis::VideointelligenceV1p1beta1 # Alias the module
service = Videointelligence::CloudVideoIntelligenceService.new

@see cloud.google.com/video-intelligence/docs/

Attributes

key[RW]

@return [String]

API key. Your API key identifies your project and provides you with API access,
quota, and reports. Required unless you provide an OAuth 2.0 token.
quota_user[RW]

@return [String]

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/videointelligence_v1p1beta1/service.rb, line 47
def initialize
  super('https://videointelligence.googleapis.com/', '',
        client_name: 'google-apis-videointelligence_v1p1beta1',
        client_version: Google::Apis::VideointelligenceV1p1beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

annotate_video(google_cloud_videointelligence_v1p1beta1_annotate_video_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

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). @param [Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1AnnotateVideoRequest] google_cloud_videointelligence_v1p1beta1_annotate_video_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

Available to use for quota purposes for server-side applications. Can be any
arbitrary string assigned to a user, but should not exceed 40 characters.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::VideointelligenceV1p1beta1::GoogleLongrunningOperation] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::VideointelligenceV1p1beta1::GoogleLongrunningOperation]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/videointelligence_v1p1beta1/service.rb, line 76
def annotate_video(google_cloud_videointelligence_v1p1beta1_annotate_video_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p1beta1/videos:annotate', options)
  command.request_representation = Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p1beta1AnnotateVideoRequest::Representation
  command.request_object = google_cloud_videointelligence_v1p1beta1_annotate_video_request_object
  command.response_representation = Google::Apis::VideointelligenceV1p1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::VideointelligenceV1p1beta1::GoogleLongrunningOperation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/videointelligence_v1p1beta1/service.rb, line 89
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end