diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2006-12-06 13:58:19 +0000 | 
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2006-12-06 13:58:19 +0000 | 
| commit | 539522aa346cd7d49f5665ee83a5659e3464d83c (patch) | |
| tree | 3bb4322573be56ad5605454031b12c56c71c7ca5 | |
| parent | b8ab52e9c23b6c63145edbefb2020b3f945d4efb (diff) | |
Add initial version of the audio API document
| -rw-r--r-- | audio/Makefile.am | 2 | ||||
| -rw-r--r-- | audio/audio-api.txt | 41 | 
2 files changed, 43 insertions, 0 deletions
| diff --git a/audio/Makefile.am b/audio/Makefile.am index 054def33..85025d5b 100644 --- a/audio/Makefile.am +++ b/audio/Makefile.am @@ -13,4 +13,6 @@ AM_CFLAGS = @BLUEZ_CFLAGS@ @DBUS_CFLAGS@  INCLUDES = -I$(top_srcdir)/common +EXTRA_DIST = audio-api.txt +  MAINTAINERCLEANFILES = Makefile.in diff --git a/audio/audio-api.txt b/audio/audio-api.txt new file mode 100644 index 00000000..9427ca71 --- /dev/null +++ b/audio/audio-api.txt @@ -0,0 +1,41 @@ +Audio API description for BlueZ +******************************* + +Copyright (C) 2004-2006  Marcel Holtmann <marcel@holtmann.org> +Copyright (C) 2005-2006  Johan Hedberg <johan.hedberg@nokia.com> +Copyright (C) 2005-2006  Brad Midgley <bmidgley@xmission.com> + + +Audio hierarchy +=============== + +Service		org.bluez.audio +Interface	org.bluez.Audio +Object path	/org/bluez/audio + +Methods		array{string} ListHeadsets() + +			Returns list of Bluetooth addresses for devices that +			are configured as headsets. + +		string GetDefaultHeadset() + +			Returns the Bluetooth address of the default headset +			device. + +		void SetDefaultHeadset(string address) + +		void CreateHeadset(string address) + +		void RemoveHeadset(string address) + +		string ConnectHeadset(string address) + +			Connects to the headset and setups a new stream. The +			new stream identifier is returned. + +Signals		void HeadsetCreated(string address) + +		void HeadsetRemoved(string address) + +		void DefaultHeadsetChanged(string address) | 
