node_vlc_remote/README.md

18 lines
436 B
Markdown
Raw Normal View History

2017-05-31 20:27:53 +00:00
# node_vlc_rc
NodeJS Binding for the VLC Media Player remote control
2017-06-01 08:58:29 +00:00
## Example
### Create a new VLC instance
```javascript
var VLC_RC = require('vlc_rc').VLC_RC;
var VLC = new VLC_RC();
```
You can pass options too:
```javascript
var VLC = new VLC_RC({verbose: true});
```
2017-06-01 09:02:46 +00:00
**Available Settings**
* *verbose* (Boolean): `true` or `false`, display verbose information
* *debug* (Boolean): `true` or `false`, pipe VLC-Output to console