Package org.bluez
Interface MediaFolder1
- All Superinterfaces:
org.freedesktop.dbus.interfaces.DBusInterface
public interface MediaFolder1
extends org.freedesktop.dbus.interfaces.DBusInterface
File generated - 2023-02-20.
Based on bluez Documentation: media-api.txt.
Service: unique name (Target role)
Interface: org.bluez.MediaFolder1
Object path:
freely definable (Target role)
[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/playerX
(Controller role)
Supported properties:
uint32 NumberOfItems [readonly]
Number of items in the folder
string Name [readonly]
Folder name:
Possible values:
"/Filesystem/...": Filesystem scope
"/NowPlaying/...": NowPlaying scope
Note: /NowPlaying folder might not be listed if player
is stopped, folders created by Search are virtual so
once another Search is perform or the folder is
changed using ChangeFolder it will no longer be listed.
Offset of the first item.
Default value: 0
uint32 End:
Offset of the last item.
Default value: NumbeOfItems
array{string} Attributes
Item properties that should be included in the list.
Possible Values:
"title", "artist", "album", "genre",
"number-of-tracks", "number", "duration"
Default Value: All
Based on bluez Documentation: media-api.txt.
Service: unique name (Target role)
Interface: org.bluez.MediaFolder1
Object path:
freely definable (Target role)
[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/playerX
(Controller role)
Supported properties:
uint32 NumberOfItems [readonly]
Number of items in the folder
string Name [readonly]
Folder name:
Possible values:
"/Filesystem/...": Filesystem scope
"/NowPlaying/...": NowPlaying scope
Note: /NowPlaying folder might not be listed if player
is stopped, folders created by Search are virtual so
once another Search is perform or the folder is
changed using ChangeFolder it will no longer be listed.
Offset of the first item.
Default value: 0
uint32 End:
Offset of the last item.
Default value: NumbeOfItems
array{string} Attributes
Item properties that should be included in the list.
Possible Values:
"title", "artist", "album", "genre",
"number-of-tracks", "number", "duration"
Default Value: All
-
Method Summary
Modifier and TypeMethodDescriptionvoidChangeFolder(org.freedesktop.dbus.DBusPath _folder) From bluez documentation:
Change current folder.
Note: By changing folder the items of previous folder
might be destroyed and have to be listed again, the
exception is NowPlaying folder which should be always
present while the player is active.
TwoTuple<org.freedesktop.dbus.DBusPath,Properties>[] From bluez documentation:
Return a list of items found
org.freedesktop.dbus.DBusPathFrom bluez documentation:
Return a folder object containing the search result.
To list the items found use the folder object returned
and pass to ChangeFolder.
Methods inherited from interface org.freedesktop.dbus.interfaces.DBusInterface
getObjectPath, isRemote
-
Method Details
-
Search
org.freedesktop.dbus.DBusPath Search(String _value, Map<String, org.freedesktop.dbus.types.Variant<?>> _filter) throws BluezNotSupportedException, BluezFailedExceptionFrom bluez documentation:
Return a folder object containing the search result.
To list the items found use the folder object returned
and pass to ChangeFolder.
- Parameters:
_value- value_filter- filter- Returns:
- DBusPath - maybe null
- Throws:
BluezNotSupportedException- when operation not supportedBluezFailedException- on failure
-
ListItems
TwoTuple<org.freedesktop.dbus.DBusPath,Properties>[] ListItems(Map<String, org.freedesktop.dbus.types.Variant<?>> _filter) throws BluezInvalidArgumentsException, BluezNotSupportedException, BluezFailedExceptionFrom bluez documentation:
Return a list of items found
- Parameters:
_filter- filter- Returns:
- TwoTuple<DBusPath, Properties>[] - maybe null
- Throws:
BluezInvalidArgumentsException- when argument is invalidBluezNotSupportedException- when operation not supportedBluezFailedException- on failure
-
ChangeFolder
void ChangeFolder(org.freedesktop.dbus.DBusPath _folder) throws BluezInvalidArgumentsException, BluezNotSupportedException, BluezFailedException From bluez documentation:
Change current folder.
Note: By changing folder the items of previous folder
might be destroyed and have to be listed again, the
exception is NowPlaying folder which should be always
present while the player is active.
- Parameters:
_folder- folder- Throws:
BluezInvalidArgumentsException- when argument is invalidBluezNotSupportedException- when operation not supportedBluezFailedException- on failure
-