org.bluez.Media1 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.exceptions.*;
import org.freedesktop.dbus.DBusPath;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.Variant;

import java.util.Map;

/**
 * File generated - 2023-02-20.

 * Based on bluez Documentation: media-api.txt.

 * 

 * Service: org.bluez

 * Interface: org.bluez.Media1

 * 

 * Object path:

 *             [variable prefix]/{hci0,hci1,...}

 * 

 * Supported properties: 

 * 

 * 		array{string} SupportedUUIDs [readonly]:

 * 

 * 			List of 128-bit UUIDs that represents the supported

 * 			Endpoint registration.

 * 

 * 

 */
public interface Media1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * Register a local end point to sender, the sender can

     * register as many end points as it likes.

     * 

     * Note: If the sender disconnects the end points are

     * automatically unregistered.

     * 

     * possible properties:

     * 

     * 	string UUID:

     * 

     * 		UUID of the profile which the endpoint

     * 		is for.

     * 

     * 		UUID must be in the list of

     * 		SupportedUUIDS.

     * 

     * 	byte Codec:

     * 

     * 		Assigned number of codec that the

     * 		endpoint implements. The values should

     * 		match the profile specification which

     * 		is indicated by the UUID.

     * 

     * 	array{byte} Capabilities:

     * 

     * 		Capabilities blob, it is used as it is

     * 		so the size and byte order must match.

     * 

     * 
     * @param _endpoint endpoint
     * @param _properties properties
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     */
    void RegisterEndpoint(DBusPath _endpoint, Map> _properties) throws BluezInvalidArgumentsException;

    /**
     * From bluez documentation:

     * 

     * Unregister sender end point.

     * 

     * 
     * @param _endpoint endpoint
     */
    void UnregisterEndpoint(DBusPath _endpoint);

    /**
     * From bluez documentation:

     * 

     * Register a media player object to sender, the sender

     * can register as many objects as it likes.

     * 

     * Object must implement at least

     * org.mpris.MediaPlayer2.Player as defined in MPRIS 2.2

     * spec:

     * 

     * http://specifications.freedesktop.org/mpris-spec/latest/

     * 

     * Note: If the sender disconnects its objects are

     * automatically unregistered.

     * 

     * 
     * @param _player player
     * @param _properties properties
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezNotSupportedException when operation not supported
     */
    void RegisterPlayer(DBusPath _player, Map> _properties) throws BluezInvalidArgumentsException, BluezNotSupportedException;

    /**
     * From bluez documentation:

     * 

     * Unregister sender media player.

     * 

     * 
     * @param _player player
     */
    void UnregisterPlayer(DBusPath _player);

    /**
     * From bluez documentation:

     * 

     * Register endpoints an player objects within root

     * object which must implement ObjectManager.

     * 

     * The application object path together with the D-Bus

     * system bus connection ID define the identification of

     * the application.

     * 

     * 
     * @param _root root
     * @param _options options
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezAlreadyExistsException when item already exists
     */
    void RegisterApplication(DBusPath _root, Map> _options) throws BluezInvalidArgumentsException, BluezAlreadyExistsException;

    /**
     * From bluez documentation:

     * 

     * This unregisters the services that has been

     * previously registered. The object path parameter

     * must match the same value that has been used

     * on registration.

     * 

     * 
     * @param _application application
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezDoesNotExistException when item does not exist
     */
    void UnregisterApplication(DBusPath _application) throws BluezInvalidArgumentsException, BluezDoesNotExistException;

}