An open API service indexing awesome lists of open source software.

https://github.com/freeclimbapi/node-stream-recording-how-to-guide

Node - Stream a Recording Tutorial
https://github.com/freeclimbapi/node-stream-recording-how-to-guide

recordings tutorial

Last synced: about 2 months ago
JSON representation

Node - Stream a Recording Tutorial

Awesome Lists containing this project

README

          

# Node - Stream Recording How-To Guide

This project serves as a guide to help you build an application with FreeClimb. View this how-to guide on [FreeClimb.com](https://docs.freeclimb.com/docs/stream-a-recording#section-nodejs). Specifically, the project will:

- Create a file stream of a recorded file made by FreeClimb. Recordings are created when calls send a PerCL command to FreeClimb to record. They can be seen in the recordings tab in the dashboard.

## Setting up your new app within your FreeClimb account

To get started using a FreeClimb account, follow the instructions [here](https://docs.freeclimb.com/docs/getting-started-with-freeclimb).

## Setting up the how-to guide

1. Install the node packages necessary using command:

```bash
$ yarn install
```

2. Configure environment variables (this how-to guide uses the [dotenv package](https://www.npmjs.com/package/dotenv)).

| ENV VARIABLE | DESCRIPTION |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ACCOUNT_ID | Account ID which can be found under [API credentials](https://www.freeclimb.com/dashboard/portal/account/authentication) in Dashboard |
| API_KEY | API key which can be found under [API credentials](https://www.freeclimb.com/dashboard/portal/account/authentication) in Dashboard |

3. Provide a value for the variable `recordingId` in streamARecording.js. If you have created a recording, you will be able to get the recordingId from the recordings tab in your dashboard. To find out more about recordings, check out the [recording documentation](https://docs.freeclimb.com/docs/recordings-3)

## Runnning the how-to guide

1. Run the application using command:

```bash
$ node streamARecording.js
```

## Getting help

If you are experiencing difficulties, [contact support](https://freeclimb.com/support).