class Google::Cloud::VideoIntelligence::V1p3beta1::StreamingVideoIntelligenceService::Client

Client for the StreamingVideoIntelligenceService service.

Service that implements streaming Video Intelligence API.

Attributes

streaming_video_intelligence_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the StreamingVideoIntelligenceService Client class.

See {::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingVideoIntelligenceService::Client::Configuration} for a description of the configuration fields.

@example

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

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb, line 54
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
new() { |config| ... } click to toggle source

Create a new StreamingVideoIntelligenceService client object.

@example

# 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

@yield [config] Configure the StreamingVideoIntelligenceService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb, line 112
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 == Client.configure.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,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {Client.configure}.

See {::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingVideoIntelligenceService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb, line 91
def configure
  yield @config if block_given?
  @config
end
streaming_annotate_video(request, options = nil) { |response, operation| ... } click to toggle source

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

@param request [::Gapic::StreamInput, ::Enumerable<::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoRequest, ::Hash>]

An enumerable of {::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoRequest} instances.

@param options [::Gapic::CallOptions, ::Hash]

Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Enumerable<::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoResponse>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Enumerable<::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoResponse>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

@example 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, pass in keyword
# arguments to set fields. Be sure to close the stream when done.
input << Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoRequest.new
input << Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoRequest.new
input.close

# Handle streamed responses. These may be interleaved with inputs.
# Each response is of type ::Google::Cloud::VideoIntelligence::V1p3beta1::StreamingAnnotateVideoResponse.
output.each do |response|
  p response
end
# File lib/google/cloud/video_intelligence/v1p3beta1/streaming_video_intelligence_service/client.rb, line 192
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 and x-goog-user-project 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-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?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end