diff options
| author | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2013-02-28 13:32:57 +0200 |
|---|---|---|
| committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2013-03-04 17:41:34 +0200 |
| commit | 090c5c7fb9ee537fe4447c89638bff86c9a94ed7 (patch) | |
| tree | 8bf8a8f61c0c84ddba481cf3abbb4bf79da142c1 /doc/media-api.txt | |
| parent | 55f158cf636a8ab6feffd550e0f11be4ac89950f (diff) | |
| download | bluez-090c5c7fb9ee537fe4447c89638bff86c9a94ed7.tar.gz | |
media: Rework MediaItem Type property
Type now can assume the value "folder" so it is no longer necessary to
have Folder property, FolderType in introduced to provide the folder type
that before was on the Type itself.
In addition to this add proper documentation what properties are optional
and under what condition they are available.
Diffstat (limited to 'doc/media-api.txt')
| -rw-r--r-- | doc/media-api.txt | 47 |
1 files changed, 32 insertions, 15 deletions
diff --git a/doc/media-api.txt b/doc/media-api.txt index 2656a9ee1..699affabf 100644 --- a/doc/media-api.txt +++ b/doc/media-api.txt @@ -352,51 +352,68 @@ Properties string Name [readonly] Item displayable name - boolean Folder [readonly] - - Indicates whether the item is a folder - string Type [readonly] Item type - Possible values: + Possible values: "video", "audio", "folder" + + string FolderType [readonly, optional] - Folder: "Mixed", "Titles", "Albums", "Artists" - Other Items: "Video", "Audio" + Folder type. - boolean Playable [readonly] + Possible values: "mixed", "titles", "albums", "artists" + + Available if property Type is "Folder" + + boolean Playable [readonly, optional] Indicates if the item can be played - string Title: + Available if property Type is "folder" + + string Title [readonly, optional] Item title name - string Artist: + Available if property Type is "audio" or "video" + + string Artist [readonly, optional] Item artist name - string Album: + Available if property Type is "audio" or "video" + + string Album [readonly, optional] Item album name - string Genre: + Available if property Type is "audio" or "video" + + string Genre [readonly, optional] Item genre name - uint32 NumberOfTracks: + Available if property Type is "audio" or "video" + + uint32 NumberOfTracks [readonly, optional] Item album number of tracks in total - uint32 Number: + Available if property Type is "audio" or "video" + + uint32 Number [readonly, optional] Item album number - uint32 Duration: + Available if property Type is "audio" or "video" + + uint32 Duration [readonly, optional] Item duration in milliseconds + Available if property Type is "audio" or "video" + MediaEndpoint1 hierarchy ======================== |