# media-rtsp

> RTSP Server for NodeJS support tcp/udp

Latest version **1.0.1** (published 2024-02-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install media-rtsp
pnpm add media-rtsp
yarn add media-rtsp
bun add media-rtsp
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-02-07 |
| First published | 2023-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 56.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Vadim Pride |
| Maintainers | pr!de |
| Keywords | rtsp, server, streaming, media, tcp, udp |

## Links

- npm: https://www.npmjs.com/package/media-rtsp
- Repository: https://github.com/VadimPride/rtsp
- Homepage: https://github.com/VadimPride/rtsp#readme
- Issues: https://github.com/VadimPride/rtsp/issues
- npm.io page: https://npm.io/package/media-rtsp

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2024-02-07
- 1.0.0 — 2023-10-24

## README

# RTSP Server:
rtsp tcp/udp media server

## Support protocol:
* TCP
* UDP

## Testing:
* tcp->tcp
* udp->udp
* tcp->udp
* udp->tcp

## Usage:
```javascript

(async () => {
    /**
     * Test debug function
     * @param argument
     * @private
     */
    const _debug = (...argument) => {
        console.info.apply(this, ['['+Date.now()+']', ...argument]);
    }
    
    /**
     * Config server
     * @type {object}
     */
    const CONFIG = {
        // * Port server listen (Default: 544)
        "port" : 5544,
        // * Host server listen (Default: 127.0.0.1)
        "host" : "127.0.0.1",
        // * Name of the server (Use in response header) (Default: RTSP SERVER)
        "serverName" : "RTSP SERVER",
        // * Require request access permission from (method: access(name, callback)) (Default: empty)
        "access" : ["auth", "media"],
        // * Port udp range (Default: 56000-57000)
        "portList" : {
            "start" : 56000, 
            "end" : 57000
        }
    };
    
    const RTSP_SERVER = require('media-rtsp');
    
    // Create server
    const rtspServer = new RTSP_SERVER(CONFIG);

    /**
     * Event connection new client
     * @event connect
     */
    rtspServer.on('connect', (clientObject) => {

        clientObject.on('RTSP:command', (command, data) => {
            console.debug('RTSP:command', command, clientObject.getID(), data);
        });

        clientObject.on('write', (message, isCommand) => {
            if(isCommand){
                console.debug('write', clientObject.getID(), message);
            }

        });

        /**
         * Event auth client
         * @event auth
         */
        clientObject.on('auth', () => {
            _debug(
                'event:[client|auth]',
                'ID: '+clientObject.getID(),
                'HeaderData: '+clientObject.getHeaderData()
            );
        });

        /**
         * Event create new media object from client
         * @event media
         */
        clientObject.on('media', (mediaObject) => {

            /**
             * Event destroy media object
             */
            mediaObject.once('destroy', () => {
                _debug(
                    'event:[client|media|destroy]',
                    'ID: '+mediaObject.getID(),
                    'Name: '+mediaObject.getName(),
                    'Type: '+mediaObject.getType(),
                    'ClientID: '+clientObject.getID(),
                    'DestroyInfo: '+mediaObject.getDestroy(),
                );
            });

            _debug(
                'event:[client|media|create]',
                'ID: '+mediaObject.getID(),
                'Name: '+mediaObject.getName(),
                'Type: '+mediaObject.getType(), // publish, views
                'ClientID: '+clientObject.getID(),
            );
        });


        /**
         * Event destroy client
         */
        clientObject.on('destroy', () => {
            _debug(
                'event:[client|destroy]',
                'ID: '+clientObject.getID(),
                'DestroyInfo: '+clientObject.getDestroy()
            );
        });

        _debug(
            'event:[client|connect]',
            'ID: '+clientObject.getID()
        );
    });


    /**
     * Event listen server
     * @event listen
     */
    rtspServer.on('listen', () => {
        _debug(
            'event:[listen]',
            'Host: '+rtspServer.getHost(),
            'Port: '+rtspServer.getPort()
        );
    });


    /**
     * Client authorization request
     * @param clientObject
     * @returns {Promise<object>|boolean|Error}
     */
    rtspServer.access('auth', async (clientObject) => {
        _debug('request:[access|auth]',
            'ClientID: '+clientObject.getID(),
            'HeaderData: '+clientObject.getHeaderData()
        );
        return true;
    });


    /**
     * Client create media request
     * @param mediaObject
     * @returns {Promise<object>|boolean|Error}
     */
    rtspServer.access('media', async (mediaObject, clientObject) => {
        _debug(
            'request:[access|media]',
            'MediaID: '+mediaObject.getID(),
            'MediaName: '+mediaObject.getName(),
            'MediaType: '+mediaObject.getType(),
            'MediaClientID: '+clientObject.getID(),
        );
        return true;
    });

    // Start listen
    await rtspServer.listen();

})();
```


## Publish
```shell
ffmpeg -re -i test.mp4  -c copy -f rtsp -rtsp_transport udp rtsp://127.0.0.1:5544/test
```
or
```shell

ffmpeg -re -i test.mp4  -c copy -f rtsp -rtsp_transport tcp rtsp://127.0.0.1:5544/test
```


## Views
```shell
ffplay -rtsp_transport udp rtsp://127.0.0.1:5544/test
```
or
```shell
ffplay -rtsp_transport tcp rtsp://127.0.0.1:5544/test
```

---
_Source: https://npm.io/package/media-rtsp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
