https://github.com/valiafetisov/vlc-simple-player
Simple npm package that starts VLC player via command-line together with HTTP interface enabled
https://github.com/valiafetisov/vlc-simple-player
nodejs player video vlc
Last synced: 16 days ago
JSON representation
Simple npm package that starts VLC player via command-line together with HTTP interface enabled
- Host: GitHub
- URL: https://github.com/valiafetisov/vlc-simple-player
- Owner: valiafetisov
- Created: 2017-05-28T14:26:20.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-25T20:17:59.000Z (over 2 years ago)
- Last Synced: 2025-03-28T20:21:17.753Z (about 1 month ago)
- Topics: nodejs, player, video, vlc
- Language: JavaScript
- Homepage:
- Size: 3.35 MB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# VLC simple player
Simple module that starts VLC player via command-line together with HTTP interface enabled.
It provides a unified API to start playing a file and to get information about current track.
## Install
```shell
npm install vlc-simple-player --save
```
(Please note you'll need VLC binary installed in your system, you can download it on [official website](http://www.videolan.org/vlc/#download))
## Example usage
```javascript
var VLC = require('vlc-simple-player')
// start a fullscreen player
var player = new VLC('./path-to-your-movie/test.mp4')
// log current track time every second
player.on('statuschange', (error, status) => {
console.log('current time', status.time)
})
```
## Interface
- `new VLC(path[, options])` – starts a VLC player in fullscreen
- `path` – string path to the video file `./test.mov`
- `options` – object with _additional_ options
- `{password: String}` will set a custom password for the HTTP interface (instead of random, which can be accessed by `player.getPassword()` method, btw)
- `{port: Number}` will set a custom port for the HTTP interface (instead of default 8080)
- `{arguments: Array}` will replace default command-line arguments (`--fullscreen`, `--loop`, `--no-video-title`)
- `player.on(eventName, callback)` - registers an event
- `eventName` – a string, available options are:
- `'error'` – stderr callback with error as an argument
- `'statuschange'` – callback that fires every second if the movie is playing
- `callback` – a function with error and status object as an arguments
- `player.request(path, callback)` - exposed request method to the VLC HTTP interface
- `path` – a string, HTTP GET path with response in JSON format. For example:
`vlc.request('/requests/status.json?command=pl_pause')` – toggles a pause.
[list of HTTP requests and interface description](https://wiki.videolan.org/VLC_HTTP_requests/)
- `callback` – a function with error and status object as an arguments
- `player.process` - exposed [spawned process](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options)
- `player.quit()` – stops the movie and close the player (via `SIGKILL`)
## Contribution
Please feel free to submit a pull request for a bug fix or new features