Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
MprisPlayer.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
6#include <PhosphorServiceMpris/phosphorservicempris_export.h>
7
8#include <QObject>
9#include <QString>
10
11#include <memory>
12
13namespace PhosphorServiceMpris {
14
15class PHOSPHORSERVICEMPRIS_EXPORT MprisPlayer : public QObject
16{
17 Q_OBJECT
18 Q_DISABLE_COPY_MOVE(MprisPlayer)
19
20 Q_PROPERTY(QString identity READ identity NOTIFY identityChanged)
21 Q_PROPERTY(QString desktopEntry READ desktopEntry NOTIFY desktopEntryChanged)
22 Q_PROPERTY(QString serviceName READ serviceName CONSTANT)
24 Q_PROPERTY(bool isPlaying READ isPlaying NOTIFY playbackStateChanged)
25 Q_PROPERTY(QString trackTitle READ trackTitle NOTIFY metadataChanged)
26 Q_PROPERTY(QString trackArtist READ trackArtist NOTIFY metadataChanged)
27 Q_PROPERTY(QString trackAlbum READ trackAlbum NOTIFY metadataChanged)
28 Q_PROPERTY(QString trackArtUrl READ trackArtUrl NOTIFY metadataChanged)
29 Q_PROPERTY(qreal position READ position NOTIFY positionChanged)
30 Q_PROPERTY(qreal length READ length NOTIFY metadataChanged)
31 Q_PROPERTY(qreal volume READ volume WRITE setVolume NOTIFY volumeChanged)
32 Q_PROPERTY(qreal rate READ rate NOTIFY rateChanged)
33 Q_PROPERTY(LoopState loopState READ loopState WRITE setLoopState NOTIFY loopStateChanged)
34 Q_PROPERTY(bool shuffle READ shuffle WRITE setShuffle NOTIFY shuffleChanged)
35 Q_PROPERTY(bool canPlay READ canPlay NOTIFY canPlayChanged)
36 Q_PROPERTY(bool canPause READ canPause NOTIFY canPauseChanged)
37 Q_PROPERTY(bool canSeek READ canSeek NOTIFY canSeekChanged)
38 Q_PROPERTY(bool canGoNext READ canGoNext NOTIFY canGoNextChanged)
39 Q_PROPERTY(bool canGoPrevious READ canGoPrevious NOTIFY canGoPreviousChanged)
40 Q_PROPERTY(bool canControl READ canControl NOTIFY canControlChanged)
41
42public:
48 Q_ENUM(PlaybackState)
49
55 Q_ENUM(LoopState)
56
57 explicit MprisPlayer(const QString& serviceName, QObject* parent = nullptr);
58 ~MprisPlayer() override;
59
60 [[nodiscard]] QString identity() const;
61 [[nodiscard]] QString desktopEntry() const;
62 [[nodiscard]] QString serviceName() const;
63 [[nodiscard]] PlaybackState playbackState() const;
64 [[nodiscard]] bool isPlaying() const;
65 [[nodiscard]] QString trackTitle() const;
66 [[nodiscard]] QString trackArtist() const;
67 [[nodiscard]] QString trackAlbum() const;
68 [[nodiscard]] QString trackArtUrl() const;
69 [[nodiscard]] qreal position() const;
70 [[nodiscard]] qreal length() const;
71 [[nodiscard]] qreal volume() const;
72 void setVolume(qreal volume);
73 [[nodiscard]] qreal rate() const;
74 [[nodiscard]] LoopState loopState() const;
76 [[nodiscard]] bool shuffle() const;
77 void setShuffle(bool shuffle);
78 [[nodiscard]] bool canPlay() const;
79 [[nodiscard]] bool canPause() const;
80 [[nodiscard]] bool canSeek() const;
81 [[nodiscard]] bool canGoNext() const;
82 [[nodiscard]] bool canGoPrevious() const;
83 [[nodiscard]] bool canControl() const;
84
85 Q_INVOKABLE void play();
86 Q_INVOKABLE void pause();
87 Q_INVOKABLE void stop();
88 Q_INVOKABLE void togglePlaying();
89 Q_INVOKABLE void next();
90 Q_INVOKABLE void previous();
91 Q_INVOKABLE void seek(qreal offsetSeconds);
92 Q_INVOKABLE void setPosition(qreal absoluteSeconds);
93 Q_INVOKABLE void raise();
94 Q_INVOKABLE void quit();
95
96Q_SIGNALS:
112
113private Q_SLOTS:
114 void _q_onPropertiesChanged(const QString& iface, const QVariantMap& changed, const QStringList& invalidated);
115 void _q_onSeeked(qlonglong position);
116
117private:
118 class Private;
119 std::unique_ptr<Private> d;
120};
121
122} // namespace PhosphorServiceMpris
void setPosition(qreal absoluteSeconds)
PlaybackState
Definition MprisPlayer.h:43
@ Playing
Definition MprisPlayer.h:45
@ Stopped
Definition MprisPlayer.h:44
@ Paused
Definition MprisPlayer.h:46
MprisPlayer(const QString &serviceName, QObject *parent=nullptr)
LoopState
Definition MprisPlayer.h:50
@ LoopPlaylist
Definition MprisPlayer.h:53
@ LoopNone
Definition MprisPlayer.h:51
@ LoopTrack
Definition MprisPlayer.h:52
PlaybackState playbackState() const
void seek(qreal offsetSeconds)
void setLoopState(LoopState state)
Definition MprisHost.h:13