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. See the subsequent parameters for more details.

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.

Members

(static) apiEndpoint

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

(static) port

The port for this API service.

(static) scopes

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

(static) servicePath

The DNS address for this API service.

Methods

close()

Terminate the GRPC channel and close the client.

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

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.v1beta1.Job

Required. Parameters for creating transcoding job.
options object <optional>

Call options. See CallOptions for more details.

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.v1beta1.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.

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.

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.

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.

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.

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current 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.

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

Return a fully-qualified job resource name string.

Parameters:
Name Type Description
project string
location string
job 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

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.
options object <optional>

Call options. See CallOptions for more details.

listJobsAsync(request, optionsopt) → {Object}

Equivalent to listJobs, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element 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.
options object <optional>

Call options. See CallOptions for more details.

listJobsStream(request, optionsopt) → {Stream}

Equivalent to listJobs, but returns a NodeJS Stream object.

This fetches the paged responses for listJobs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

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.
options object <optional>

Call options. See CallOptions for more details.
See:

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.
options object <optional>

Call options. See CallOptions for more details.

listJobTemplatesAsync(request, optionsopt) → {Object}

Equivalent to listJobTemplates, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element 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.
options object <optional>

Call options. See CallOptions for more details.

listJobTemplatesStream(request, optionsopt) → {Stream}

Equivalent to listJobTemplates, but returns a NodeJS Stream object.

This fetches the paged responses for listJobTemplates continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

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.
options object <optional>

Call options. See CallOptions for more details.
See:

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:
Name Type Description
project string
location string

matchJobFromJobName(jobName) → {string}

Parse the job from Job resource.

Parameters:
Name Type Description
jobName string

A fully-qualified path representing Job resource.

matchJobTemplateFromJobTemplateName(jobTemplateName) → {string}

Parse the job_template from JobTemplate resource.

Parameters:
Name Type Description
jobTemplateName string

A fully-qualified path representing JobTemplate resource.

matchLocationFromJobName(jobName) → {string}

Parse the location from Job resource.

Parameters:
Name Type Description
jobName string

A fully-qualified path representing Job resource.

matchLocationFromJobTemplateName(jobTemplateName) → {string}

Parse the location from JobTemplate resource.

Parameters:
Name Type Description
jobTemplateName string

A fully-qualified path representing JobTemplate resource.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.

matchProjectFromJobName(jobName) → {string}

Parse the project from Job resource.

Parameters:
Name Type Description
jobName string

A fully-qualified path representing Job resource.

matchProjectFromJobTemplateName(jobTemplateName) → {string}

Parse the project from JobTemplate resource.

Parameters:
Name Type Description
jobTemplateName string

A fully-qualified path representing JobTemplate resource.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location resource.