Google Cloud Platform logo

Transcoder API: Node.js Client

release level npm version codecov

Transcoder client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Transcoder API API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/video-transcoder

Using the client library

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const projectId = 'my-project';
// const location = 'us-central1';
const {TranscoderServiceClient} =
  require('@google-cloud/video-transcoder').v1;
const client = new TranscoderServiceClient();
async function listJobs() {
  const [jobs] = await client.listJobs({
    parent: client.locationPath(projectId, location),
  });
  console.info('jobs:');
  for (const job of jobs) {
    console.info(job);
  }
}
listJobs();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Create Job From Ad Hoc source code Open in Cloud Shell
Create Job From Preset source code Open in Cloud Shell
Create Job From Template source code Open in Cloud Shell
Create Job Template source code Open in Cloud Shell
Create Job With Animated Overlay source code Open in Cloud Shell
Create Job With Periodic Images Spritesheet source code Open in Cloud Shell
Create Job With Set Number Images Spritesheet source code Open in Cloud Shell
Create Job With Static Overlay source code Open in Cloud Shell
Delete Job source code Open in Cloud Shell
Delete Job Template source code Open in Cloud Shell
Get Job source code Open in Cloud Shell
Get Job State source code Open in Cloud Shell
Get Job Template source code Open in Cloud Shell
List Job Templates source code Open in Cloud Shell
List Jobs source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Transcoder API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE