Reference documentation and code samples for the Transcoder API module Google::Cloud::Video::Transcoder.
Methods
.configure
defself.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
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Transcoder API - Module Google::Cloud::Video::Transcoder (v2.0.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.1 (latest)](/ruby/docs/reference/google-cloud-video-transcoder/latest/Google-Cloud-Video-Transcoder)\n- [2.0.0](/ruby/docs/reference/google-cloud-video-transcoder/2.0.0/Google-Cloud-Video-Transcoder)\n- [1.6.0](/ruby/docs/reference/google-cloud-video-transcoder/1.6.0/Google-Cloud-Video-Transcoder)\n- [1.5.1](/ruby/docs/reference/google-cloud-video-transcoder/1.5.1/Google-Cloud-Video-Transcoder)\n- [1.4.0](/ruby/docs/reference/google-cloud-video-transcoder/1.4.0/Google-Cloud-Video-Transcoder)\n- [1.3.0](/ruby/docs/reference/google-cloud-video-transcoder/1.3.0/Google-Cloud-Video-Transcoder)\n- [1.2.0](/ruby/docs/reference/google-cloud-video-transcoder/1.2.0/Google-Cloud-Video-Transcoder)\n- [1.1.0](/ruby/docs/reference/google-cloud-video-transcoder/1.1.0/Google-Cloud-Video-Transcoder)\n- [1.0.2](/ruby/docs/reference/google-cloud-video-transcoder/1.0.2/Google-Cloud-Video-Transcoder) \nReference documentation and code samples for the Transcoder API module Google::Cloud::Video::Transcoder.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-video-transcoder library.\n\nThe following configuration parameters are supported:\n\n- `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.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.video_transcoder) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .transcoder_service\n\n def self.transcoder_service(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for TranscoderService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Video::Transcoder::V1::TranscoderService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-video-transcoder-v1/latest/Google-Cloud-Video-Transcoder-V1-TranscoderService-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the TranscoderService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the TranscoderService service.\nYou can determine whether the method will succeed by calling\n[Transcoder.transcoder_service_available?](/ruby/docs/reference/google-cloud-video-transcoder/latest/Google-Cloud-Video-Transcoder#Google__Cloud__Video__Transcoder_transcoder_service_available__class_ \"Google::Cloud::Video::Transcoder.transcoder_service_available? (method)\").\n\n#### About TranscoderService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nUsing the Transcoder API, you can queue asynchronous jobs for transcoding\nmedia into various output formats. Output formats may include different\nstreaming standards such as HTTP Live Streaming (HLS) and Dynamic Adaptive\nStreaming over HTTP (DASH). You can also customize jobs using advanced\nfeatures such as Digital Rights Management (DRM), audio equalization, content\nconcatenation, and digital ad-stitch ready content generation. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .transcoder_service_available?\n\n def self.transcoder_service_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the TranscoderService service is supported by the current client.\nIf true, you can retrieve a client object by calling [Transcoder.transcoder_service](/ruby/docs/reference/google-cloud-video-transcoder/latest/Google-Cloud-Video-Transcoder#Google__Cloud__Video__Transcoder_transcoder_service_class_ \"Google::Cloud::Video::Transcoder.transcoder_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the TranscoderService service,\nor if the versioned client gem needs an update to support the TranscoderService service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"2.0.1\""]]