mirror of
https://github.com/make-42/xyosc
synced 2025-01-18 18:57:10 +01:00
5.4 KiB
5.4 KiB
go-mpris
go-mpris is an implementation of the mpris dbus interface written in go (golang). Implemented and tested against version 2.2. See: https://specifications.freedesktop.org/mpris-spec/2.2.
Example
Example cli has been implemented.
git clone git@github.com:leberKleber/go-mpris.git
go build examples/cli.go
./cli-client
Features:
Player
https://specifications.freedesktop.org/mpris-spec/2.2/Player_Interface.html
Methods
| method | library path | implemented |
|---|---|---|
| Next | mpris.Player.Next() |
✔️ |
| Previous | mpris.Player.Previous() |
✔️ |
| Pause | mpris.Player.Pause() |
✔️ |
| PlayPause | mpris.Player.PlayPause() |
✔️ |
| Stop | mpris.Player.Stop() |
✔️ |
| Seek | mpris.Player.SeekTo(<offset> int64)¹ |
✔️ |
| SetPosition | mpris.Player.SetPosition(<trackID> dbus.ObjectPath, <position> int64) |
✔️ |
| OpenUri | mpris.Player.OpenUri(<uri> string) |
✔️ |
¹ Could not be named Seek, it's a reserved function name.
Properties
| property | library path | implemented |
|---|---|---|
| PlaybackStatus | mpris.Player.PlaybackStatus() (mpris.PlaybackStatus, error) |
✔️ |
| LoopStatus | mpris.Player.LoopStatus() (mpris.LoopStatus, error) |
✔️ |
| LoopStatus | mpris.Player.SetLoopStatus(<loopStatus> mpris.LoopStatus) error |
✔️ |
| Rate | mpris.Player.Rate() (float64, error) |
✔️ |
| Rate | mpris.Player.SetRate(<rate> float64) error |
✔️ |
| Shuffle | mpris.Player.Shuffle() (bool, error) |
✔️ |
| Shuffle | mpris.Player.SetShuffle(<shuffle> bool) error |
✔️ |
| Metadata | mpris.Player.Metadata() (mpris.Metadata, error) |
✔️ |
| Volume | mpris.Player.Volume() (float64, error) |
✔️ |
| Volume | mpris.Player.SetVolume(<volume> float64) (error) |
✔️ |
| Position | mpris.Player.Position() (int64, error) |
✔️ |
| Position | mpris.Player.SetPosition(<trackID> dbus.ObjectPath, <position> int64) |
✔️ |
| MinimumRate | mpris.Player.MinimumRate() (float64, error) |
✔️ |
| MaximumRate | mpris.Player.MaximumRate() (float64, error) |
✔️ |
| CanGoNext | mpris.Player.CanGoNext() (bool, error) |
✔️ |
| CanGoPrevious | mpris.Player.CanGoPrevious() (bool, error) |
✔️ |
| CanPlay | mpris.Player.CanPlay() (bool, error) |
✔️ |
| CanPause | mpris.Player.CanPause() (bool, error) |
✔️ |
| CanSeek | mpris.Player.CanSeek() (bool, error) |
✔️ |
| CanControl | mpris.Player.CanControl(bool, error) |
✔️ |
Signals
| signal | library path | implemented |
|---|---|---|
| Seeked | mpris.Player.Seeked(<ctx> context.Context) (<-chan int, error) |
✔️ |
Development
Versioning
This library follows the semantic versioning concept.
Commits
Commits should follow the conventional commit rules.
See: https://conventionalcommits.org.
Mocks
Mocks will be generated with github.com/matryer/moq. It can be installed with
go install github.com/matryer/moq@latest. Generation can be triggered with go generate ./....
Go Docs
Read the docs at https://pkg.go.dev/github.com/leberKleber/go-mpris