https://github.com/ciderapp/mpris-service
https://github.com/ciderapp/mpris-service
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ciderapp/mpris-service
- Owner: ciderapp
- License: mit
- Created: 2025-02-21T02:10:13.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-05T01:48:01.000Z (about 1 year ago)
- Last Synced: 2025-10-10T18:22:58.088Z (9 months ago)
- Language: JavaScript
- Size: 116 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mpris-service
[](https://travis-ci.org/dbusjs/mpris-service)
Node.js implementation for the MPRIS D-Bus Interface Specification to create a mediaplayer service.
[Documentation](http://specifications.freedesktop.org/mpris-spec/latest/)
[Chat](https://discord.gg/UdbXHVX)
```js
var Player = require('mpris-service');
var player = new Player({
name: 'nodejs',
identity: 'Node.js media player',
supportedUriSchemes: ['file'],
supportedMimeTypes: ['audio/mpeg', 'application/ogg'],
supportedInterfaces: ['player']
});
```
Implemented interfaces:
* [`org.mpris.MediaPlayer2`](http://specifications.freedesktop.org/mpris-spec/latest/Media_Player.html)
* [`org.mpris.MediaPlayer2.Player`](http://specifications.freedesktop.org/mpris-spec/latest/Player_Interface.html)
* [`org.mpris.MediaPlayer2.TrackList`](http://specifications.freedesktop.org/mpris-spec/latest/Track_List_Interface.html)
* [`org.mpris.MediaPlayer2.Playlists`](http://specifications.freedesktop.org/mpris-spec/latest/Playlists_Interface.html)
Examples are available in [`examples/`](https://github.com/dbusjs/mpris-service/tree/master/examples).
## Default interface
```js
player.on('quit', function () {
process.exit();
});
```
Events:
* `raise`
* `quit`
* `fullscreen`
Properties:
* `identity`
* `name`
* `supportedUriSchemes`
* `supportedMimeTypes`
* `desktopEntry`
## Player
```js
// See http://www.freedesktop.org/wiki/Specifications/mpris-spec/metadata/
player.metadata = {
'mpris:trackid': player.objectPath('track/0'),
'mpris:length': 60 * 1000 * 1000, // In microseconds
'mpris:artUrl': 'https://pbs.twimg.com/profile_images/378800000822867536/3f5a00acf72df93528b6bb7cd0a4fd0c.jpeg',
'xesam:title': 'Best song',
'xesam:album': 'Best album',
'xesam:artist': ['Best singer']
};
player.playbackStatus = 'Playing';
```
See `examples/player.js`.
Events:
* `next`
* `previous`
* `pause`
* `playpause`
* `stop`
* `play`
* `seek`
* `open`
* `loopStatus`
* `rate`
* `shuffle`
* `volume`
Properties:
* `playbackStatus`
* `loopStatus`
* `rate`
* `shuffle`
* `volume`
* `metadata`
* `minimumRate`
* `maximumRate`
* `canGoNext`
* `canGoPrevious`
* `canPlay`
* `canPause`
* `canSeek`
* `canControl`
Methods:
* `seeked(position)`
* `getPosition()` (should be overridden to return the current position)
## TrackList
Events:
* `addTrack`
* `removeTrack`
* `goTo`
Properties:
* `tracks`
* `canEditTracks`
Methods:
* `addTrack(track)`
* `removeTrack(trackId)`
## Playlists
Events:
* `activatePlaylist`
Properties:
* `playlists`
* `activePlaylist`
Methods:
* `setPlaylists(playlists)`
* `setActivePlaylist(playlistId)`