org.bluez.MediaTransport1 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
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.
package org.bluez;
import org.bluez.datatypes.ThreeTuple;
import org.bluez.exceptions.BluezFailedException;
import org.bluez.exceptions.BluezNotAuthorizedException;
import org.bluez.exceptions.BluezNotAvailableException;
import org.freedesktop.dbus.FileDescriptor;
import org.freedesktop.dbus.interfaces.DBusInterface;
import org.freedesktop.dbus.types.UInt16;
/**
* File generated - 2020-06-18.
* Based on bluez Documentation: media-api.txt.
*
* Service: org.bluez
* Interface: org.bluez.MediaTransport1
*
* Object path:
* [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/fdX
*
* Supported properties:
*
* object Device [readonly]
*
* Device object which the transport is connected to.
*
* string UUID [readonly]
*
* UUID of the profile which the transport is for.
*
* byte Codec [readonly]
*
* Assigned number of codec that the transport support.
* The values should match the profile specification which
* is indicated by the UUID.
*
* array{byte} Configuration [readonly]
*
* Configuration blob, it is used as it is so the size and
* byte order must match.
*
* string State [readonly]
*
* Indicates the state of the transport. Possible
* values are:
* "idle": not streaming
* "pending": streaming but not acquired
* "active": streaming and acquired
*
* uint16 Delay [readwrite]
*
* Optional. Transport delay in 1/10 of millisecond, this
* property is only writeable when the transport was
* acquired by the sender.
*
* uint16 Volume [readwrite]
*
* Optional. Indicates volume level of the transport,
* this property is only writeable when the transport was
* acquired by the sender.
*
* Possible Values: 0-127
*
* object Endpoint [readonly, optional, experimental]
*
* Endpoint object which the transport is associated
* with.
*
*/
public interface MediaTransport1 extends DBusInterface {
/**
* From bluez documentation:
*
* Acquire transport file descriptor and the MTU for read
* and write respectively.
*
*
* @return ThreeTuple<FileDescriptor, UInt16, UInt16> - maybe null
*
* @throws BluezNotAuthorizedException when not authorized
* @throws BluezFailedException on failure
*/
ThreeTuple Acquire() throws BluezNotAuthorizedException, BluezFailedException;
/**
* From bluez documentation:
*
* Acquire transport file descriptor only if the transport
* is in "pending" state at the time the message is
* received by BlueZ. Otherwise no request will be sent
* to the remote device and the function will just fail
* with org.bluez.Error.NotAvailable.
*
*
* @return ThreeTuple<FileDescriptor, UInt16, UInt16> - maybe null
*
* @throws BluezNotAuthorizedException when not authorized
* @throws BluezFailedException on failure
* @throws BluezNotAvailableException when not available
*/
ThreeTuple TryAcquire() throws BluezNotAuthorizedException, BluezFailedException, BluezNotAvailableException;
/**
* From bluez documentation:
*
* Releases file descriptor.
*
*/
void Release();
}