org.bluez.ProfileManager1 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.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: profile-api.txt.

 * 

 * Service: org.bluez

 * Interface: org.bluez.ProfileManager1

 * 

 * Object path:

 *             /org/bluez

 * 

 */
public interface ProfileManager1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * This registers a profile implementation.

     * 

     * If an application disconnects from the bus all

     * its registered profiles will be removed.

     * 

     * Some predefined services:

     * 

     * HFP AG UUID: 0000111f-0000-1000-8000-00805f9b34fb

     * 

     * 	Default profile Version is 1.7, profile Features

     * 	is 0b001001 and RFCOMM channel is 13.

     * 	Authentication is required.

     * 

     * HFP HS UUID: 0000111e-0000-1000-8000-00805f9b34fb

     * 

     * 	Default profile Version is 1.7, profile Features

     * 	is 0b000000 and RFCOMM channel is 7.

     * 	Authentication is required.

     * 

     * HSP AG UUID: 00001112-0000-1000-8000-00805f9b34fb

     * 

     * 	Default profile Version is 1.2, RFCOMM channel

     * 	is 12 and Authentication is required. Does not

     * 	support any Features, option is ignored.

     * 

     * HSP HS UUID: 00001108-0000-1000-8000-00805f9b34fb

     * 

     * 	Default profile Version is 1.2, profile Features

     * 	is 0b0 and RFCOMM channel is 6. Authentication

     * 	is required. Features is one bit value, specify

     * 	capability of Remote Audio Volume Control

     * 	(by default turned off).

     * 

     * Available options:

     * 

     * 	string Name

     * 

     * 		Human readable name for the profile

     * 

     * 	string Service

     * 

     * 		The primary service class UUID

     * 		(if different from the actual

     * 		 profile UUID)

     * 

     * 	string Role

     * 

     * 		For asymmetric profiles that do not

     * 		have UUIDs available to uniquely

     * 		identify each side this

     * 		parameter allows specifying the

     * 		precise local role.

     * 

     * 		Possible values: "client", "server"

     * 

     * 	uint16 Channel

     * 

     * 		RFCOMM channel number that is used

     * 		for client and server UUIDs.

     * 

     * 		If applicable it will be used in the

     * 		SDP record as well.

     * 

     * 	uint16 PSM

     * 

     * 		PSM number that is used for client

     * 		and server UUIDs.

     * 

     * 		If applicable it will be used in the

     * 		SDP record as well.

     * 

     * 	boolean RequireAuthentication

     * 

     * 		Pairing is required before connections

     * 		will be established. No devices will

     * 		be connected if not paired.

     * 

     * 	boolean RequireAuthorization

     * 

     * 		Request authorization before any

     * 		connection will be established.

     * 

     * 	boolean AutoConnect

     * 

     * 		In case of a client UUID this will

     * 		force connection of the RFCOMM or

     * 		L2CAP channels when a remote device

     * 		is connected.

     * 

     * 	string ServiceRecord

     * 

     * 		Provide a manual SDP record.

     * 

     * 	uint16 Version

     * 

     * 		Profile version (for SDP record)

     * 

     * 	uint16 Features

     * 

     * 		Profile features (for SDP record)

     * 

     * 
     * @param _profile profile
     * @param _uuid uuid
     * @param _options options
     * 
     * @throws BluezInvalidArgumentsException when argument is invalid
     * @throws BluezAlreadyExistsException when item already exists
     */
    void RegisterProfile(DBusPath _profile, String _uuid, Map> _options) throws BluezInvalidArgumentsException, BluezAlreadyExistsException;

    /**
     * From bluez documentation:

     * 

     * This unregisters the profile that has been previously

     * registered. The object path parameter must match the

     * same value that has been used on registration.

     * 

     * 
     * @param _profile profile
     * 
     * @throws BluezDoesNotExistException when item does not exist
     */
    void UnregisterProfile(DBusPath _profile) throws BluezDoesNotExistException;

}