Class: Google::Cloud::VideoIntelligence::V1p3beta1::StreamingVideoIntelligenceService::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb

Overview

Client for the StreamingVideoIntelligenceService service.

Service that implements streaming Video Intelligence API.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new StreamingVideoIntelligenceService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingVideoIntelligenceService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingVideoIntelligenceService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the StreamingVideoIntelligenceService client.

Yield Parameters:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb', line 127

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/videointelligence/v1p3beta1/video_intelligence_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @streaming_video_intelligence_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingVideoIntelligenceService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @streaming_video_intelligence_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the StreamingVideoIntelligenceService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all StreamingVideoIntelligenceService clients
::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingVideoIntelligenceService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb', line 60

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "VideoIntelligence", "V1p3beta1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.streaming_annotate_video.timeout = 10_800.0
    default_config.rpcs.streaming_annotate_video.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the StreamingVideoIntelligenceService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



97
98
99
100
 
# File 'lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb', line 97

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


183
184
185
 
# File 'lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb', line 183

def logger
  @streaming_video_intelligence_service_stub.logger
end

#streaming_annotate_video(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoResponse>

Performs video annotation with bidirectional streaming: emitting results while sending video/audio bytes. This method is only available via the gRPC API (not REST).

Examples:

Basic example

require "google/cloud/video_intelligence/v1p3beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VideoIntelligence::V1p3beta1::StreamingVideoIntelligenceService::Client.new

# Create an input stream.
input = Gapic::StreamInput.new

# Call the streaming_annotate_video method to start streaming.
output = client.streaming_annotate_video input

# Send requests on the stream. For each request object, set fields by
# passing keyword arguments. Be sure to close the stream when done.
input << Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoRequest.new
input << Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoRequest.new
input.close

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoResponse
output.each do |current_response|
  p current_response
end

Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb', line 231

def streaming_annotate_video request, options = nil
  unless request.is_a? ::Enumerable
    raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
    request = request.to_enum
  end

  request = request.lazy.map do |req|
    ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoRequest
  end

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.streaming_annotate_video.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VideoIntelligence::V1p3beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.streaming_annotate_video.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.streaming_annotate_video.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @streaming_video_intelligence_service_stub.call_rpc :streaming_annotate_video, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


107
108
109
 
# File 'lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb', line 107

def universe_domain
  @streaming_video_intelligence_service_stub.universe_domain
end