Google Cloud Platform logo

Live Stream API: Node.js Client

release level npm version

livestream 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 Live Stream 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/livestream

Using the client library

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent location for the resource, in the form of:
 *  `projects/{project}/locations/{location}`.
 */
// const parent = 'abc123'
/**
 *  The maximum number of items to return. If unspecified, server
 *  will pick an appropriate default. Server may return fewer items than
 *  requested. A caller should only rely on response's
 *  next_page_token google.cloud.video.livestream.v1.ListChannelsResponse.next_page_token  to
 *  determine if there are more items left to be queried.
 */
// const pageSize = 1234
/**
 *  The next_page_token value returned from a previous List request, if any.
 */
// const pageToken = 'abc123'
/**
 *  The filter to apply to list results.
 */
// const filter = 'abc123'
/**
 *  Specifies the ordering of results following syntax at
 *  https://cloud.google.com/apis/design/design_patterns#sorting_order.
 */
// const orderBy = 'abc123'

// Imports the Livestream library
const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;

// Instantiates a client
const livestreamClient = new LivestreamServiceClient();

async function callListChannels() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = await livestreamClient.listChannelsAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListChannels();

Samples

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

Sample Source Code Try it
Create Channel source code Open in Cloud Shell
Create Channel Event source code Open in Cloud Shell
Create Channel With Backup Input source code Open in Cloud Shell
Create Input source code Open in Cloud Shell
Delete Channel source code Open in Cloud Shell
Delete Channel Event source code Open in Cloud Shell
Delete Input source code Open in Cloud Shell
Get Channel source code Open in Cloud Shell
Get Channel Event source code Open in Cloud Shell
Get Input source code Open in Cloud Shell
List Channel Events source code Open in Cloud Shell
List Channels source code Open in Cloud Shell
List Inputs source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell
Start Channel source code Open in Cloud Shell
Stop Channel source code Open in Cloud Shell
Update Channel source code Open in Cloud Shell
Update Input source code Open in Cloud Shell

The Live Stream 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. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/livestream@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be 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 stable 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