org.bluez.MediaEndpoint1 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bluez-dbus-osgi Show documentation
Java native bluetooth library which uses bluez via dbus (linux only). This is the OSGi compliant bundle of all required libraries in one bundle.
The newest version!
package org.bluez;

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: unique name (Server role)

 * Interface: org.bluez.MediaEndpoint1

 * 

 * Object path:

 *             freely definable (Server role)

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

 *             (Client role) 

 * 

 * Supported properties: 

 * 

 * 		string UUID [readonly, optional]:

 * 

 * 			UUID of the profile which the endpoint is for.

 * 

 * 		byte Codec [readonly, optional]:

 * 

 * 			Assigned number of codec that the endpoint implements.

 * 			The values should match the profile specification which

 * 			is indicated by the UUID.

 * 

 * 		array{byte} Capabilities [readonly, optional]:

 * 

 * 			Capabilities blob, it is used as it is so the size and

 * 			byte order must match.

 * 

 * 		object Device [readonly, optional]:

 * 

 * 			Device object which the endpoint is belongs to.

 * 

 * 		bool DelayReporting [readonly, optional]:

 * 

 * 			Indicates if endpoint supports Delay Reporting.

 * 

 * 		byte Framing [ISO only]

 * 

 * 			Indicates endpoint support framing.

 * 

 * 		byte PHY [ISO only]

 * 

 * 			Indicates endpoint supported PHY.

 * 

 * 		uint16_t MaximumLatency [ISO only]

 * 

 * 			Indicates endpoint maximum latency.

 * 

 * 		uint32_t MinimumDelay [ISO only]

 * 

 * 			Indicates endpoint minimum presentation delay.

 * 

 * 		uint32_t MaximumDelay [ISO only]

 * 

 * 			Indicates endpoint maximum presentation delay.

 * 

 * 		uint32_t PreferredMinimumDelay [ISO only]

 * 

 * 			Indicates endpoint preferred minimum presentation delay.

 * 

 * 		uint32_t PreferredMinimumDelay [ISO only]

 * 

 * 			Indicates endpoint preferred minimum presentation delay.

 * 

 * 		uint32 Location [ISO only]

 * 

 * 			Indicates endpoint supported locations.

 * 

 * 		uint16 SupportedContext [ISO only]

 * 

 * 			Indicates endpoint supported audio context.

 * 

 * 		uint16 Context [ISO only]

 * 

 * 			Indicates endpoint available audio context.

 * 

 * 

 */
public interface MediaEndpoint1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * Set configuration for the transport.

     * 

     * For client role transport must be set with a server

     * endpoint oject which will be configured and the

     * properties must contain the following properties:

     * 

     * 	array{byte} Capabilities [Mandatory]

     * 	array{byte} Metadata [ISO only]

     * 	byte CIG [ISO only]

     * 	byte CIS [ISO only]

     * 	uint32 Interval [ISO only]

     * 	bool Framing [ISO only]

     * 	string PHY [ISO only]

     * 	uint16 SDU [ISO only]

     * 	byte Retransmissions [ISO only]

     * 	uint16 Latency [ISO only]

     * 	uint32 Delay [ISO only]

     * 	uint8 TargetLatency [ISO Latency]

     * 

     * 
     * @param _transport transport
     * @param _properties properties
     */
    void SetConfiguration(DBusPath _transport, Map> _properties);

    /**
     * From bluez documentation:

     * 

     * Select preferable configuration from the supported

     * capabilities.

     * 

     * Returns a configuration which can be used to setup

     * a transport.

     * 

     * Note: There is no need to cache the selected

     * configuration since on success the configuration is

     * send back as parameter of SetConfiguration.

     * 

     * 
     * @param _capabilities capabilities
     * 
     * @return byte[] - maybe null
     */
    byte[] SelectConfiguration(byte[] _capabilities);

    /**
     * From bluez documentation:

     * 

     * Select preferable properties from the supported

     * properties:

     * 	object Endpoint [ISO only]

     * 	Refer to SetConfiguration for the list of

     * 		other possible properties.

     * 

     * Returns propeties which can be used to setup

     * a transport.

     * 

     * Note: There is no need to cache the selected

     * properties since on success the configuration is

     * send back as parameter of SetConfiguration.

     * 

     * 
     * @param _properties properties
     * 
     * @return Map<String, Variant<?>> - maybe null
     */
    Map> SelectProperties(Map> _properties);

    /**
     * From bluez documentation:

     * 

     * Clear transport configuration.

     * 

     * 
     * @param _transport transport
     */
    void ClearConfiguration(DBusPath _transport);

    /**
     * From bluez documentation:

     * 

     * This method gets called when the service daemon

     * unregisters the endpoint. An endpoint can use it to do

     * cleanup tasks. There is no need to unregister the

     * endpoint, because when this method gets called it has

     * already been unregistered.

     * 

     */
    void Release();

}