nodejs-webcam-streaming

KO | EN

gitlite — search

#javascript #llm #machine-learning #rust #deep-learning #macos #java #windows #awesome #cli #awesome-list #pytorch #security #openai

nodejs-webcam-streaming

(★ 22)

Streaming a webcam over http with node.js

nodejs-webcam-streaming Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# webcam-http-streaming
Stream a webcam over http with node.js

# API

* **createHTTPStreamingServer(_[options]_)**: creates a [HTTP](https://nodejs.org/api/http.html#http_class_http_server)
  server ready for streaming yout webcams, the options are explained below
  (and are all optional)

* **streamWebcam(_[encoder]_)**: return the promise of a [Readable](https://nodejs.org/api/stream.html#stream_class_stream_readable)
  stream, defaults to avconv encodinf webm with realtime deadline

Given the flexibility of the API it _should_ be easy to use webcams on the
network or other types of realtime inputs, but keep in mind that the current
implementation spawns **one encoder per viewer** (it was made for a tool where
this limitation wasn't a problem).

Feel free to recommend me ways to overcome this difficulty :) i think that
MPEG-2 with [hsl.js](https://github.com/dailymotion/hls.js) or a similar lib may
be a good way to start.

### Complete API example
```js
const webcam = require('webcam-http-streaming');

/* Suppose i want to use the default REST API */
const server = webcam.createHTTPStreamingServer({
  /*
   * Optional: A list of the permitted webcams, if it's specified overrides
   * isValidWebcam
   */
  permittedWebcams: ['/dev/video0', '/dev/video1'],
  /*
   * Validates if a given path is a valid webcam for use, the default is shown
   * below
   */
  isValidWebcam(webcam) {
    const webcamRegex = /\/dev\/video[0-9]+/;

return new Promise((accept, reject) => {
      /* If doesn't seem like a video device block we will fail */
      if(!webcamRegex.test(webcam)) {
        reject(false);
      } else {
        /* ... and if the file doesn't exists */
        fileExists(webcam).then(accept, reject);
      }
    });
  },
  /*
   * The endpoint for requesting streams of the REST api
   *   Defaults to '/webcam'
   */
  webcamEndpoint: '/webcam',
  /*
   * Custom endpoints to extend the REST API
   *   req: [IncomingMessage](https://nodejs.org/api/http.html#http_class_http_incomingmessage)
   *   res: [ServerResponse](https://nodejs.org/api/http.html#http_class_http_serverresponse)
   *   reqUrl: [URL Object](https://nodejs.org/api/url.html#url_url_strings_and_url_objects)
   *            with [QueryString](https://nodejs.org/api/querystring.html#querystring_querystring_parse_str_sep_eq_options)
   *
   * Note: the endpoint 'default' is used for any non-matching request
   */
  additionalEndpoints: {
    '/list_webcams': (req, res, reqUrl) => { res.end('<html>...</html>'); }
  },
  encoder: encoder
}).listen(8080);

/* Returns a promise that resolves to the video stream (stream.Readable) */
const videoStream = webcam.streamWebcam('/dev/video0', encoder);
```

# Default REST API

* `/webcam?webcam=<webcam_device_block>`: Returns a _video/webm_ (by default, it
   can be changed) stream or an error (invalid_webcam, webcam_in_use by another
   process)

### Errors

* `invalid_webcam`: The webcam you requested hasn't been found or isn't in the
  list of permitted webcams
```json
  {
    "code": "invalid_webcam",
    "error": "That webcam doesn't exist",
    "webcam": "/dev/video0"
  }
```

* `webcam_in_use`: The webcam you requested was in use by another process
```json
  {
    "code": "webcam_in_use",
    "error": "The webcam is already in use by another process",
    "webcam": "/dev/video0"
  }
```

nodejs-webcam-streaming

nodejs-webcam-streaming Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

nodejs-webcam-streaming

nodejs-webcam-streaming Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README