iin-rtsp-stream
v2.2.6
Published
This Node.js library allows you to easily stream RTSP video to a WebSocket server. It supports MPEG1 video with MPEGTS and is highly optimized and customizable. This library is an altered version of node-rtsp-stream with performance improvements and a som
Downloads
13
Readme
RTSP Stream to WebSocket Server Library
This Node.js library allows you to easily stream RTSP video to a WebSocket server. It supports MPEG1 video with MPEGTS and is highly optimized and customizable. This library is an altered version of node-rtsp-stream with performance improvements and a some new features, like udp rtsp transport implemented into it.
Installation
To install this library, simply run:
npm install iin-rtsp-stream
Usage
This code initializes a new instance of the Stream class with the specified parameters. The Stream class represents a video stream and is responsible for starting and stopping the stream.
The ffmpegOptions object specifies various options for the ffmpeg library that is used to handle the video stream.
The stream.on() method is used to register event listeners for the Stream instance.
The exitWithError event is triggered when the stream exits with an error. In this case, the stream.stop() method is called to stop the stream.
The socketClosed event is triggered when the socket connection for the stream is closed. In this case, the stream.stop() method is called to stop the stream.
The camdata event is triggered when camera data is received. In this case, the function passed as the third argument to stream.on() does not do anything with the data.
Finally, a setTimeout() method is used to stop the stream after 10 minutes (600 seconds). If the stream is not stopped within 10 minutes, the Promise will be resolved.
import * as Stream from "iin-rtsp-stream";
const stream = await new Stream({
name: `${port}`,
streamUrl: rtspURL,
wsPort: port,
ffmpegOptions: {
"-r": 30,
"-bufsize": "2000k",
"-crf": "600k",
"-preset": "realtime",
"-threads": 0,
"-maxrate": "700k",
"-bf": 4,
"-tune": "grain",
"-g": 90,
"-rtsp_transport": "udp",
},
});
stream.on("exitWithError", () => {
//Handle exit with error
});
stream.on("all-clients-closed", () => {
//Handle port manager logic when all clients have been disconnected from the websocket server
console.log(`Port ${stream.options.wsPort} is closed.`);
});
stream.on("camdata", (data) => {
//Capture the data being streamed
});
setTimeout(async () => {
//Stops streamin afterr 10 minutes it has started
await new Promise(() => {
stream.stop();
Promise.resolve();
});
}, 10 * 60 * 1000);
License
This library is licensed under the MIT License.