You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -160,7 +160,7 @@ If CanPlay is false, attempting to call this method should have no effect.
160
160
161
161
#### Seek(x: Offset) -> nothing
162
162
163
-
#####Parameters
163
+
#### Parameters
164
164
165
165
-**Offset - x (Time_In_Us)**
166
166
The number of microseconds to seek forward.
@@ -255,32 +255,21 @@ Not all values may be accepted by the media player. It is left to media player i
255
255
256
256
#### Shuffle b Read/Write
257
257
258
+
> When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.
258
259
260
+
A value of false indicates that playback is progressing linearly through a playlist, while true means playback is progressing through a playlist in some other order.
261
+
262
+
If CanControl is false, attempting to set this property should have no effect and raise an error.
259
263
260
264
#### Metadata a{sv} (Metadata_Map) Read only
261
265
262
-
-[x]`mpris:trackid` (D-Bus path): A unique identity for this track within the context of an MPRIS object (eg: tracklist).
263
-
-[x]`mpris:length` (64-bit integer): The duration of the track in microseconds.
264
-
-[x]`mpris:artUrl` (URI): The location of an image representing the track or album. Clients should not assume this will continue to exist when the media player stops giving out the URL.
265
-
-[x]`xesam:album` (String): The album name.
266
-
-[x]`xesam:albumArtist` (List of Strings): The album artist(s).
267
-
-[x]`xesam:artist` (List of Strings): The track artist(s).
268
-
-[x]`xesam:asText` (String): The track lyrics.
269
-
-[x]`xesam:audioBPM` (Integer): The speed of the music, in beats per minute.
270
-
-[x]`xesam:autoRating` (Float): An automatically-generated rating, based on things such as how often it has been played. This should be in the range 0.0 to 1.0.
271
-
-[x]`xesam:comment` (List of Strings): A (list of) freeform comment(s).
272
-
-[x]`xesam:composer` (List of Strings): The composer(s) of the track.
273
-
-[ ]`xesam:contentCreated` (Date/Time): When the track was created. Usually only the year component will be useful.
274
-
-[x]`xesam:discNumber` (Integer): The disc number on the album that this track is from.
275
-
-[ ]`xesam:firstUsed` (Date/Time): When the track was first played.
276
-
-[x]`xesam:genre` (List of Strings): The genre(s) of the track.
277
-
-[ ]`xesam:lastUsed` (Date/Time): When the track was last played.
278
-
-[x]`xesam:lyricist` (List of Strings): The lyricist(s) of the track.
279
-
-[x]`xesam:title` (String): The track title.
280
-
-[x]`xesam:trackNumber` (Integer): The track number on the album disc.
281
-
-[x]`xesam:url` (URI): The location of the media file.
282
-
-[x]`xesam:useCount` (Integer): The number of times the track has been played.
283
-
-[x]`xesam:userRating` (Float): A user-specified rating. This should be in the range 0.0 to 1.0.
266
+
> When this property changes, the org.freedesktop.DBus.Properties.PropertiesChanged signal is emitted with the new value.
267
+
268
+
The metadata of the current element.
269
+
270
+
If there is a current track, this must have a "mpris:trackid" entry (of D-Bus type "o") at the very least, which contains a D-Bus path that uniquely identifies this track.
271
+
272
+
See the type documentation for more details.
284
273
285
274
#### Volume d (Volume) Read/Write
286
275
@@ -376,10 +365,136 @@ This property is not expected to change, as it describes an intrinsic capability
376
365
377
366
If this is false, clients should assume that all properties on this interface are read-only (and will raise errors if writing to them is attempted), no methods are implemented and all other properties starting with "Can" are also false.
378
367
368
+
## Metadata
369
+
370
+
### Type/format
371
+
372
+
A mapping from metadata attribute names to values.
373
+
374
+
The mpris:trackid attribute must always be present, and must be of D-Bus type "o". This contains a D-Bus path that uniquely identifies the track within the scope of the playlist. There may or may not be an actual D-Bus object at that path; this specification says nothing about what interfaces such an object may implement.
375
+
376
+
If the length of the track is known, it should be provided in the metadata property with the "mpris:length" key. The length must be given in microseconds, and be represented as a signed 64-bit integer.
377
+
378
+
If there is an image associated with the track, a URL for it may be provided using the "mpris:artUrl" key. For other metadata, fields defined by the Xesam ontology should be used, prefixed by "xesam:". See the metadata page on the freedesktop.org wiki for a list of common fields.
379
+
380
+
Lists of strings should be passed using the array-of-string ("as") D-Bus type. Dates should be passed as strings using the ISO 8601 extended format (eg: 2007-04-29T14:35:51). If the timezone is known, RFC 3339's internet profile should be used (eg: 2007-04-29T14:35:51+02:00).
381
+
382
+
### Types
383
+
384
+
#### List of Strings
385
+
386
+
Note that some types that you might expect to be strings are, in fact, "lists of strings". These should be sent using the "as" D-Bus type (array of string).
387
+
388
+
#### Date/Time
389
+
390
+
Date/time fields should be sent as strings in ISO 8601 extended format. If the timezone is known (eg: for xesam:lastPlayed), the internet profile format of ISO 8601, as specified in RFC 3339, should be used.
391
+
392
+
For example: "2007-04-29T13:56+01:00" for 29th April 2007, four minutes to 2pm, in a time zone 1 hour ahead of UTC.
393
+
394
+
#### URI
395
+
396
+
URIs should be sent as (UTF-8) strings. Local files should use the "file://" schema.
397
+
398
+
### Fields (MPRIS-specific)
399
+
400
+
#### mpris:trackid
401
+
402
+
D-Bus path: A unique identity for this track within the context of an MPRIS object (eg: tracklist).
403
+
404
+
#### mpris:length
405
+
406
+
64-bit integer: The duration of the track in microseconds.
407
+
408
+
#### mpris:artUrl
409
+
410
+
URI: The location of an image representing the track or album. Clients should not assume this will continue to exist when the media player stops giving out the URL.
411
+
412
+
### Common Xesam properties
413
+
414
+
Common audio properties from the Xesam specification:
415
+
416
+
#### xesam:album
417
+
418
+
String: The album name.
419
+
420
+
#### xesam:albumArtist
421
+
422
+
List of Strings: The album artist(s).
423
+
424
+
#### xesam:artist
425
+
426
+
List of Strings: The track artist(s).
427
+
428
+
#### xesam:asText
429
+
430
+
String: The track lyrics.
431
+
432
+
#### xesam:audioBPM
433
+
434
+
Integer: The speed of the music, in beats per minute.
435
+
436
+
#### xesam:autoRating
437
+
438
+
Float: An automatically-generated rating, based on things such as how often it has been played. This should be in the range 0.0 to 1.0.
439
+
440
+
#### xesam:comment
441
+
442
+
List of Strings: A (list of) freeform comment(s).
443
+
444
+
#### xesam:composer
445
+
446
+
List of Strings: The composer(s) of the track.
447
+
448
+
#### xesam:contentCreated
449
+
450
+
Date/Time: When the track was created. Usually only the year component will be useful.
451
+
452
+
#### xesam:discNumber
453
+
454
+
Integer: The disc number on the album that this track is from.
455
+
456
+
#### xesam:firstUsed
457
+
458
+
Date/Time: When the track was first played.
459
+
460
+
#### xesam:genre
461
+
462
+
List of Strings: The genre(s) of the track.
463
+
464
+
#### xesam:lastUsed
465
+
466
+
Date/Time: When the track was last played.
467
+
468
+
#### xesam:lyricist
469
+
470
+
List of Strings: The lyricist(s) of the track.
471
+
472
+
#### xesam:title
473
+
474
+
String: The track title.
475
+
476
+
#### xesam:trackNumber
477
+
478
+
Integer: The track number on the album disc.
479
+
480
+
#### xesam:url
481
+
482
+
URI: The location of the media file.
483
+
484
+
#### xesam:useCount
485
+
486
+
Integer: The number of times the track has been played.
487
+
488
+
#### xesam:userRating
489
+
490
+
Float: A user-specified rating. This should be in the range 0.0 to 1.0.
0 commit comments