📽 RTSP Relay

!npm bundle size

This module allows you to view an RTSP stream in your web browser using an existing express.js server.

Internally, this module uses websockets to create an endpoint in your web server (e.g. /api/stream) which relays the RTSP stream using ffmpeg. On the client side, JS-MPEG is used to decode the websocket stream.

The module handles all the complications that unreliable connections introduce:

- if the connection between server <=> RTSP stream is disconnected, it will automatically be reconnected when available
- if the connection between client <=> server is disconnected, the client will keep trying to reconnect
- if multiple clients connect, only one instance of the RTSP stream is consumed to improve performance (one-to-many)

Install

``sh
npm install -S rtsp-relay express
`

You don't need to install ffmpeg!

Example

`js
const express = require('express');
const app = express();

const { proxy, scriptUrl } = require('rtsp-relay')(app);

const handler = proxy({
url: rtsp://admin:admin@10.0.1.2:554/feed,
// if your RTSP stream need credentials, include them in the URL as above
verbose: false,
});

// the endpoint our RTSP uses
app.ws('/api/stream', handler);

// this is an example html page to view the stream
app.get('/', (req, res) =>
res.send(

),
);

app.listen(2000);
`

Open http://localhost:2000 in your web browser.

Example using ES6 Imports (e.g. React, Vue)

If you have babel/webpack set up, you can import the loadPlayer instead of using a

),
);

server.listen(443);
`

Contributing

We have end-to-end tests to ensure that the module actually works. These tests spin up a RTSP server using aler9/rtsp-simple-server and create several different streams for testing. These tests are far from complete.

To make developing easier, run node test/setupTests. This creates two RTSP streams that can be used instead of real IP cameras (rtsp://localhost:8554/sync-test-1 and rtsp://localhost:8554/sync-test-2`).