Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derhuerst/mplayer-wrapper
Let an mplayer instance play media.
https://github.com/derhuerst/mplayer-wrapper
audio headless media mplayer player
Last synced: 6 days ago
JSON representation
Let an mplayer instance play media.
- Host: GitHub
- URL: https://github.com/derhuerst/mplayer-wrapper
- Owner: derhuerst
- License: isc
- Created: 2018-04-06T14:17:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-17T14:03:57.000Z (almost 2 years ago)
- Last Synced: 2024-10-03T23:55:09.026Z (about 1 month ago)
- Topics: audio, headless, media, mplayer, player
- Language: JavaScript
- Homepage: https://github.com/derhuerst/mplayer-wrapper#mplayer-wrapper
- Size: 155 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# mplayer-wrapper
**Let an [`mplayer`](http://www.mplayerhq.hu/) instance play media.**
*Note*: `mpv` is a fork of `mplayer` and much nicer to work with. You might want to use [`mpv-wrapper`](https://github.com/derhuerst/mpv-wrapper) instead.
[](https://www.npmjs.com/package/mplayer-wrapper)
[](https://travis-ci.org/derhuerst/mplayer-wrapper)
[](https://github.com/sponsors/derhuerst)
[](https://twitter.com/derhuerst)
## Installing
```shell
npm install mplayer-wrapper
```
## Usage
```js
const createPlayer = require('mplayer-wrapper')
const player = createPlayer()
player.queue('path/to/audio-1.mp3')
player.queue('path/to/audio-2.ogg')
player.queue('http://example.org/audio-3.ogg')
player.on('time_pos', (val) => {
console.log('track progress is', val)
})
setInterval(() => {
player.getProps(['time_pos'])
}, 2 * 1000)
player.on('metadata', console.log)
player.on('track-change', () => player.getProps(['metadata']))
```
## API
### Methods
- `player.exec(command, args = [])`: Send a command to mplayer. See [the list](http://www.mplayerhq.hu/DOCS/tech/slave.txt).
- `player.getProps(props)`: Request values for one or more props. Run `mplayer -list-properties` for a list.
- `player.play(fileOrUrl)`: Discard the current queue, play this file.
- `player.queue(fileOrUrl)`: Add this file to the queue.
- `player.next()`: Jump to the next file in the queue.
- `player.previous()`: Jump to the previous file in the queue.
- `player.playPause()`: Toggle pause.
- `player.seek(pos)`: Seek to a position in seconds. Prepend `+`/`-` for relative seeking.
- `player.seekPercent(pos)`: Seek to a position in percent of the file. E.g. `30`.
- `player.setVolume(amount)`: Set the volume. `0` is silent, `100` is maximum.
- `player.stop`: Stop playing.
- `player.close`: Stop playing, close the mplayer instance.
### Events
- `feed.on('prop', name, val)`: The value for a prop has been requested (e.g. using `getProps`), and we now know the value.
- `feed.on(propName, val)`: A shorthand for the `prop` event.
- `feed.on('track-change')`: A new track/file is playing now.
## Known Issues
- `mplayer` doesn't print metadata properly (e.g. Unicode, `,` and other special characters), therefore `mplayer-wrapper` doesn't expose it properly.
## Related
- [`mpv-wrapper`](https://github.com/derhuerst/mpv-wrapper) – Let an `mpv` instance play media.
## Contributing
If you have a question or have difficulties using `mplayer-wrapper`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to [the issues page](https://github.com/derhuerst/mplayer-wrapper/issues).