Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/googleapis/nodejs-video-live-stream

This repository is deprecated. All of its content and history has been moved to googleapis/google-cloud-node.
https://github.com/googleapis/nodejs-video-live-stream
Last synced: about 1 month ago
JSON representation
This repository is deprecated. All of its content and history has been moved to googleapis/google-cloud-node.
Host: GitHub
URL: https://github.com/googleapis/nodejs-video-live-stream
Owner: googleapis
License: apache-2.0
Archived: true
Created: 2022-01-21T21:56:22.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-07-13T02:29:25.000Z (about 1 year ago)
Last Synced: 2024-05-08T18:15:56.487Z (4 months ago)
Size: 562 KB
Stars: 5
Watchers: 38
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        **_THIS REPOSITORY IS DEPRECATED. ALL OF ITS CONTENT AND HISTORY HAS BEEN MOVED TO [GOOGLE-CLOUD-NODE](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-video-livestream)_**

[//]: # "This README.md file is auto-generated, all changes to this file will be lost."

[//]: # "To regenerate it, use `python -m synthtool`."



# [Live Stream API: Node.js Client](https://github.com/googleapis/nodejs-video-live-stream)

[![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)

[![npm version](https://img.shields.io/npm/v/@google-cloud/livestream.svg)](https://www.npmjs.org/package/@google-cloud/livestream)

livestream client for Node.js

A comprehensive list of changes in each version may be found in

[the CHANGELOG](https://github.com/googleapis/nodejs-video-live-stream/blob/main/CHANGELOG.md).

* [Live Stream API Node.js Client API Reference][client-docs]

* [Live Stream API Documentation][product-docs]

* [github.com/googleapis/nodejs-video-live-stream](https://github.com/googleapis/nodejs-video-live-stream)

Read more about the client libraries for Cloud APIs, including the older

Google APIs Client Libraries, in [Client Libraries Explained][explained].

[explained]: https://cloud.google.com/apis/docs/client-libraries-explained

**Table of contents:**

* [Quickstart](#quickstart)

  * [Before you begin](#before-you-begin)

  * [Installing the client library](#installing-the-client-library)

  * [Using the client library](#using-the-client-library)

* [Samples](#samples)

* [Versioning](#versioning)

* [Contributing](#contributing)

* [License](#license)

## Quickstart

### Before you begin

1.  [Select or create a Cloud Platform project][projects].

1.  [Enable billing for your project][billing].

1.  [Enable the Live Stream API API][enable_api].

1.  [Set up authentication with a service account][auth] so you can access the

    API from your local workstation.

### Installing the client library

```bash

npm install @google-cloud/livestream

```

### Using the client library

```javascript

/**

 * 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/`](https://github.com/googleapis/nodejs-video-live-stream/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.

| Sample                      | Source Code                       | Try it |

| --------------------------- | --------------------------------- | ------ |

| Create Channel | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/createChannel.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/createChannel.js,samples/README.md) |

| Create Channel Event | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/createChannelEvent.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/createChannelEvent.js,samples/README.md) |

| Create Channel With Backup Input | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/createChannelWithBackupInput.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/createChannelWithBackupInput.js,samples/README.md) |

| Create Input | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/createInput.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/createInput.js,samples/README.md) |

| Delete Channel | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/deleteChannel.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/deleteChannel.js,samples/README.md) |

| Delete Channel Event | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/deleteChannelEvent.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/deleteChannelEvent.js,samples/README.md) |

| Delete Input | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/deleteInput.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/deleteInput.js,samples/README.md) |

| Get Channel | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/getChannel.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/getChannel.js,samples/README.md) |

| Get Channel Event | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/getChannelEvent.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/getChannelEvent.js,samples/README.md) |

| Get Input | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/getInput.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/getInput.js,samples/README.md) |

| List Channel Events | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/listChannelEvents.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/listChannelEvents.js,samples/README.md) |

| List Channels | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/listChannels.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/listChannels.js,samples/README.md) |

| List Inputs | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/listInputs.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/listInputs.js,samples/README.md) |

| Quickstart | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |

| Start Channel | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/startChannel.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/startChannel.js,samples/README.md) |

| Stop Channel | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/stopChannel.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/stopChannel.js,samples/README.md) |

| Update Channel | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/updateChannel.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/updateChannel.js,samples/README.md) |

| Update Input | [source code](https://github.com/googleapis/nodejs-video-live-stream/blob/main/samples/updateInput.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-video-live-stream&page=editor&open_in_editor=samples/updateInput.js,samples/README.md) |

The [Live Stream API Node.js Client API Reference][client-docs] documentation

also contains samples.

## Supported Node.js Versions

Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).

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](https://docs.npmjs.com/cli/dist-tag).

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](http://semver.org/).

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][launch_stages]

[launch_stages]: https://cloud.google.com/terms/launch-stages

## Contributing

Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-video-live-stream/blob/main/CONTRIBUTING.md).

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](https://github.com/googleapis/synthtool).

## License

Apache Version 2.0

See [LICENSE](https://github.com/googleapis/nodejs-video-live-stream/blob/main/LICENSE)

[client-docs]: https://cloud.google.com/nodejs/docs/reference/livestream/latest

[product-docs]: https://cloud.google.com/livestream/

[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png

[projects]: https://console.cloud.google.com/project

[billing]: https://support.google.com/cloud/answer/6293499#enable-billing

[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=livestream.googleapis.com

[auth]: https://cloud.google.com/docs/authentication/getting-started