summaryrefslogtreecommitdiff
path: root/doc/media-api.txt
diff options
context:
space:
mode:
authorLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2013-01-08 10:43:03 +0200
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2013-01-10 16:36:02 +0200
commite0ee3000d136151cf98874b6a15339f277240ee7 (patch)
tree0d73dc638060199f1c2c23414937f6bcad18a79b /doc/media-api.txt
parent1fe97f411b90fa866cf39302cd591408c0de014a (diff)
downloadbluez-e0ee3000d136151cf98874b6a15339f277240ee7.tar.gz
media-api: Change RegisterPlayer to use MPRIS spec
RegisterPlayer now expect registered paths to implement org.mpris.MediaPlayer2.player interface accourding to MPRIS spec: http://specifications.freedesktop.org/mpris-spec/latest/
Diffstat (limited to 'doc/media-api.txt')
-rw-r--r--doc/media-api.txt72
1 files changed, 7 insertions, 65 deletions
diff --git a/doc/media-api.txt b/doc/media-api.txt
index c9c2e7a6f..972716edd 100644
--- a/doc/media-api.txt
+++ b/doc/media-api.txt
@@ -45,77 +45,19 @@ Methods void RegisterEndpoint(object endpoint, dict properties)
Unregister sender end point.
- void RegisterPlayer(object player, dict properties,
- dict metadata)
+ void RegisterPlayer(object player, dict properties)
Register a media player object to sender, the sender
can register as many objects as it likes.
- Note: If the sender disconnects its objects are
- automatically unregistered.
-
- Properties:
-
- string Equalizer:
-
- Possible values: "off" or "on"
-
- string Repeat:
-
- Possible values: "off", "singletrack",
- "alltracks" or "group"
-
- string Shuffle:
-
- Possible values: "off", "alltracks" or
- "group"
-
- string Scan:
-
- Possible values: "off", "alltracks" or
- "group"
+ Object must implement at least
+ org.mpris.MediaPlayer2.Player as defined in MPRIS 2.2
+ spec:
- string Status:
+ http://specifications.freedesktop.org/mpris-spec/latest/
- Possible values: "playing", "stopped",
- "paused",
- "forward-seek",
- "reverse-seek" or
- "error"
-
- uint32 Position
-
- Playback position in milliseconds
-
- Metadata:
-
- string Title:
-
- Track title name
-
- string Artist:
-
- Track artist name
-
- string Album:
-
- Track album name
-
- string Genre:
-
- Track genre name
-
- uint32 NumberOfTracks:
-
- Number of tracks in total
-
- uint32 Number:
-
- Track number
-
- uint32 Duration:
-
- Track duration in milliseconds
+ Note: If the sender disconnects its objects are
+ automatically unregistered.
Possible Errors: org.bluez.Error.InvalidArguments
org.bluez.Error.NotSupported