Class: Google::Apis::VideointelligenceV1p2beta1::CloudVideoIntelligenceService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/videointelligence_v1p2beta1/service.rb

Overview

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.

Examples:

require 'google/apis/videointelligence_v1p2beta1'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeCloudVideoIntelligenceService

Returns a new instance of CloudVideoIntelligenceService.


47
48
49
50
# File 'generated/google/apis/videointelligence_v1p2beta1/service.rb', line 47

def initialize
  super('https://videointelligence.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

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

Returns:

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


40
41
42
# File 'generated/google/apis/videointelligence_v1p2beta1/service.rb', line 40

def key
  @key
end

#quota_userString

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

Returns:

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


45
46
47
# File 'generated/google/apis/videointelligence_v1p2beta1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#annotate_video(google_cloud_videointelligence_v1p2beta1_annotate_video_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VideointelligenceV1p2beta1::GoogleLongrunningOperation

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:

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


74
75
76
77
78
79
80
81
82
83
# File 'generated/google/apis/videointelligence_v1p2beta1/service.rb', line 74

def annotate_video(google_cloud_videointelligence_v1p2beta1_annotate_video_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1p2beta1/videos:annotate', options)
  command.request_representation = Google::Apis::VideointelligenceV1p2beta1::GoogleCloudVideointelligenceV1p2beta1AnnotateVideoRequest::Representation
  command.request_object = google_cloud_videointelligence_v1p2beta1_annotate_video_request_object
  command.response_representation = Google::Apis::VideointelligenceV1p2beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::VideointelligenceV1p2beta1::GoogleLongrunningOperation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end