Transcoder API - Module Google::Cloud::Video::Transcoder (v1.6.0)

Reference documentation and code samples for the Transcoder API module Google::Cloud::Video::Transcoder.

Methods

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-video-transcoder library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.video_transcoder)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.transcoder_service

def self.transcoder_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for TranscoderService.

By default, this returns an instance of Google::Cloud::Video::Transcoder::V1::TranscoderService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the TranscoderService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TranscoderService service. You can determine whether the method will succeed by calling Transcoder.transcoder_service_available?.

About TranscoderService

Using the Transcoder API, you can queue asynchronous jobs for transcoding media into various output formats. Output formats may include different streaming standards such as HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can also customize jobs using advanced features such as Digital Rights Management (DRM), audio equalization, content concatenation, and digital ad-stitch ready content generation.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.transcoder_service_available?

def self.transcoder_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the TranscoderService service is supported by the current client. If true, you can retrieve a client object by calling Transcoder.transcoder_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TranscoderService service, or if the versioned client gem needs an update to support the TranscoderService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "1.6.0"