Live Stream API: Node.js Client
livestream client for Node.js
A comprehensive list of changes in each version may be found inthe CHANGELOG.
- Live Stream API Node.js Client API Reference
- Live Stream API Documentation
- github.com/googleapis/google-cloud-node/packages/google-cloud-video-livestream
Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.
Table of contents:
Quickstart
Before you begin
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Live Stream API API.
- Set up authentication with a service account so you can access theAPI from your local workstation.
Installing the client library
npm install @google-cloud/livestreamUsing 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 libraryconst {LivestreamServiceClient} = require('@google-cloud/livestream').v1;// Instantiates a clientconst livestreamClient = newLivestreamServiceClient();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 thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.
| Sample | Source Code | Try it |
|---|---|---|
| Livestream_service.create_asset | source code | ![]() |
| Livestream_service.create_channel | source code | ![]() |
| Livestream_service.create_event | source code | ![]() |
| Livestream_service.create_input | source code | ![]() |
| Livestream_service.delete_asset | source code | ![]() |
| Livestream_service.delete_channel | source code | ![]() |
| Livestream_service.delete_event | source code | ![]() |
| Livestream_service.delete_input | source code | ![]() |
| Livestream_service.get_asset | source code | ![]() |
| Livestream_service.get_channel | source code | ![]() |
| Livestream_service.get_event | source code | ![]() |
| Livestream_service.get_input | source code | ![]() |
| Livestream_service.get_pool | source code | ![]() |
| Livestream_service.list_assets | source code | ![]() |
| Livestream_service.list_channels | source code | ![]() |
| Livestream_service.list_events | source code | ![]() |
| Livestream_service.list_inputs | source code | ![]() |
| Livestream_service.start_channel | source code | ![]() |
| Livestream_service.stop_channel | source code | ![]() |
| Livestream_service.update_channel | source code | ![]() |
| Livestream_service.update_input | source code | ![]() |
| Livestream_service.update_pool | source code | ![]() |
| Quickstart | source code | ![]() |
TheLive Stream API Node.js Client API Reference documentationalso contains samples.
Supported Node.js Versions
Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/livestream@legacy-8 installs client librariesfor versions compatible with Node.js 8.
Versioning
This library followsSemantic Versioning.
This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.
More Information:Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See theContributing Guide.
Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.
License
Apache Version 2.0
SeeLICENSE
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
