TranscoderServiceClient

TranscoderServiceClient

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.

Constructor

new TranscoderServiceClient(optionsopt)

Construct an instance of TranscoderServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint string <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.

fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

createJob(request, optionsopt) → {Promise}

Creates a job in the specified region.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent location to create and process this job. Format: projects/{project}/locations/{location}

job google.cloud.video.transcoder.v1.Job

Required. Parameters for creating transcoding job.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Job. Please see the documentation for more details and examples.
Example
const [response] = await client.createJob(request);

createJobTemplate(request, optionsopt) → {Promise}

Creates a job template in the specified region.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent location to create this job template. Format: projects/{project}/locations/{location}

jobTemplate google.cloud.video.transcoder.v1.JobTemplate

Required. Parameters for creating job template.

jobTemplateId string

Required. The ID to use for the job template, which will become the final component of the job template's resource name.

This value should be 4-63 characters, and valid characters must match the regular expression a-zA-Z*.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing JobTemplate. Please see the documentation for more details and examples.
Example
const [response] = await client.createJobTemplate(request);

deleteJob(request, optionsopt) → {Promise}

Deletes a job.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the job to delete. Format: projects/{project}/locations/{location}/jobs/{job}

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteJob(request);

deleteJobTemplate(request, optionsopt) → {Promise}

Deletes a job template.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the job template to delete. projects/{project}/locations/{location}/jobTemplates/{job_template}

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteJobTemplate(request);

getJob(request, optionsopt) → {Promise}

Returns the job data.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the job to retrieve. Format: projects/{project}/locations/{location}/jobs/{job}

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Job. Please see the documentation for more details and examples.
Example
const [response] = await client.getJob(request);

getJobTemplate(request, optionsopt) → {Promise}

Returns the job template data.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the job template to retrieve. Format: projects/{project}/locations/{location}/jobTemplates/{job_template}

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing JobTemplate. Please see the documentation for more details and examples.
Example
const [response] = await client.getJobTemplate(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

jobPath(project, location, job) → {string}

Return a fully-qualified job resource name string.

Parameters:
Name Type Description
project string
location string
job string
Returns:
Type Description
string

Resource name string.

jobTemplatePath(project, location, job_template) → {string}

Return a fully-qualified jobTemplate resource name string.

Parameters:
Name Type Description
project string
location string
job_template string
Returns:
Type Description
string

Resource name string.

listJobs(request, optionsopt) → {Promise}

Lists jobs in the specified region.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Format: projects/{project}/locations/{location}

pageSize number

The maximum number of items to return.

pageToken string

The next_page_token value returned from a previous List request, if any.

filter string

The filter expression, following the syntax outlined in https://google.aip.dev/160.

orderBy string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Job. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listJobsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listJobsAsync(request, optionsopt) → {Object}

Equivalent to listJobs, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Format: projects/{project}/locations/{location}

pageSize number

The maximum number of items to return.

pageToken string

The next_page_token value returned from a previous List request, if any.

filter string

The filter expression, following the syntax outlined in https://google.aip.dev/160.

orderBy string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Job. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example
const iterable = client.listJobsAsync(request);
for await (const response of iterable) {
  // process response
}

listJobsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Format: projects/{project}/locations/{location}

pageSize number

The maximum number of items to return.

pageToken string

The next_page_token value returned from a previous List request, if any.

filter string

The filter expression, following the syntax outlined in https://google.aip.dev/160.

orderBy string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing Job on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listJobsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listJobTemplates(request, optionsopt) → {Promise}

Lists job templates in the specified region.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent location from which to retrieve the collection of job templates. Format: projects/{project}/locations/{location}

pageSize number

The maximum number of items to return.

pageToken string

The next_page_token value returned from a previous List request, if any.

filter string

The filter expression, following the syntax outlined in https://google.aip.dev/160.

orderBy string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of JobTemplate. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listJobTemplatesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listJobTemplatesAsync(request, optionsopt) → {Object}

Equivalent to listJobTemplates, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent location from which to retrieve the collection of job templates. Format: projects/{project}/locations/{location}

pageSize number

The maximum number of items to return.

pageToken string

The next_page_token value returned from a previous List request, if any.

filter string

The filter expression, following the syntax outlined in https://google.aip.dev/160.

orderBy string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing JobTemplate. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example
const iterable = client.listJobTemplatesAsync(request);
for await (const response of iterable) {
  // process response
}

listJobTemplatesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent location from which to retrieve the collection of job templates. Format: projects/{project}/locations/{location}

pageSize number

The maximum number of items to return.

pageToken string

The next_page_token value returned from a previous List request, if any.

filter string

The filter expression, following the syntax outlined in https://google.aip.dev/160.

orderBy string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing JobTemplate on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listJobTemplatesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:
Name Type Description
project string
location string
Returns:
Type Description
string

Resource name string.

matchJobFromJobName(jobName) → {string}

Parse the job from Job resource.

Parameters:
Name Type Description
jobName string

A fully-qualified path representing Job resource.

Returns:
Type Description
string

A string representing the job.

matchJobTemplateFromJobTemplateName(jobTemplateName) → {string}

Parse the job_template from JobTemplate resource.

Parameters:
Name Type Description
jobTemplateName string

A fully-qualified path representing JobTemplate resource.

Returns:
Type Description
string

A string representing the job_template.

matchLocationFromJobName(jobName) → {string}

Parse the location from Job resource.

Parameters:
Name Type Description
jobName string

A fully-qualified path representing Job resource.

Returns:
Type Description
string

A string representing the location.

matchLocationFromJobTemplateName(jobTemplateName) → {string}

Parse the location from JobTemplate resource.

Parameters:
Name Type Description
jobTemplateName string

A fully-qualified path representing JobTemplate resource.

Returns:
Type Description
string

A string representing the location.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.

Returns:
Type Description
string

A string representing the location.

matchProjectFromJobName(jobName) → {string}

Parse the project from Job resource.

Parameters:
Name Type Description
jobName string

A fully-qualified path representing Job resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromJobTemplateName(jobTemplateName) → {string}

Parse the project from JobTemplate resource.

Parameters:
Name Type Description
jobTemplateName string

A fully-qualified path representing JobTemplate resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.

Returns:
Type Description
string

A string representing the project.