Skip to content

Latest commit

 

History

History

api-proxy

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
certs
certs
 
 
docs/img
docs/img
 
 
functions
functions
 
 
src
src
 
 
.env.example
.env.example
 
 
.eslintrc.js
.eslintrc.js
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

API Proxy setup

Use this proxy server sample code to connect your Dolby.io communications API based project to our backend services and correctly handle POST requests for features such as starting and stopping RTMP or RTS streams. You can read our guide on webinars and virtual events to understand in more detail about RTMP and RTS based streams.

Setup

note This guide is written with Yarn in mind.

These instructions are all performed inside the api-proxy directory. As a pre-requesite, open up a terminal window in the api-proxy directory.

  1. Run the following command to install all necessary dependencies:
yarn
  1. Rename the api-proxy/.env.example file to api-proxy/.env, then add your KEY and SECRET.

How to obtain App Key and Secret

You can obtain your app key and secret to run this app from the Dolby.io dashboard. Follow the steps to obtain them.

  1. Go to the Dashboard, and click on the API Keys next to your application. dashboard

  2. On the next screen, copy the App key and App secret and paste them in your .env file against the marked variables. token

  3. You can start the proxy server by running the following command.

yarn dev
  1. Observe the traffic on your terminal window, looking for the line
[1] Listening at http://localhost:4000/

You will still need to start your application (port 3000 by default) that will communicate with this API proxy service.

  1. You can now head back to the events app ReadMe file to continue building and running the app.