Class: Google::Apis::VideointelligenceV1p3beta1::CloudVideoIntelligenceService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/videointelligence_v1p3beta1/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_v1p3beta1'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://videointelligence.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudVideoIntelligenceService

Returns a new instance of CloudVideoIntelligenceService.



49
50
51
52
53
54
 
# File 'lib/google/apis/videointelligence_v1p3beta1/service.rb', line 49

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-videointelligence_v1p3beta1',
        client_version: Google::Apis::VideointelligenceV1p3beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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.



42
43
44
 
# File 'lib/google/apis/videointelligence_v1p3beta1/service.rb', line 42

def key
  @key
end

#quota_user ⇒ String

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.



47
48
49
 
# File 'lib/google/apis/videointelligence_v1p3beta1/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#annotate_video(google_cloud_videointelligence_v1p3beta1_annotate_video_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VideointelligenceV1p3beta1::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:

  • google_cloud_videointelligence_v1p3beta1_annotate_video_request_object (Google::Apis::VideointelligenceV1p3beta1::GoogleCloudVideointelligenceV1p3beta1AnnotateVideoRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/videointelligence_v1p3beta1/service.rb', line 78

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