org.bluez.MediaFolder1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bluez-dbus Show documentation
Java native bluetooth library which uses bluez via dbus (linux only)
The newest version!
package org.bluez;

import org.bluez.datatypes.TwoTuple;
import org.bluez.exceptions.*;
import org.freedesktop.dbus.DBusPath;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.Variant;

import java.util.Map;
import java.util.Properties;

/**
 * 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

 * 

 * 

 */
public interface MediaFolder1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * Return a folder object containing the search result.

     * 

     * To list the items found use the folder object returned

     * and pass to ChangeFolder.

     * 

     * 
     * @param _value value
     * @param _filter filter
     * 
     * @return DBusPath - maybe null
     * 
     * @throws BluezNotSupportedException when operation not supported
     * @throws BluezFailedException on failure
     */
    DBusPath Search(String _value, Map> _filter) throws BluezNotSupportedException, BluezFailedException;

    /**
     * From bluez documentation:

     * 

     * Return a list of items found

     * 

     * 
     * @param _filter filter
     * 
     * @return TwoTuple<DBusPath, Properties>[] - maybe null
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezNotSupportedException when operation not supported
     * @throws BluezFailedException on failure
     */
    TwoTuple[] ListItems(Map> _filter) 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.

     * 

     * 
     * @param _folder folder
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezNotSupportedException when operation not supported
     * @throws BluezFailedException on failure
     */
    void ChangeFolder(DBusPath _folder) throws BluezInvalidArgumentsException, BluezNotSupportedException, BluezFailedException;

}