From 539522aa346cd7d49f5665ee83a5659e3464d83c Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Wed, 6 Dec 2006 13:58:19 +0000 Subject: Add initial version of the audio API document --- audio/Makefile.am | 2 ++ audio/audio-api.txt | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 audio/audio-api.txt 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 +Copyright (C) 2005-2006 Johan Hedberg +Copyright (C) 2005-2006 Brad Midgley + + +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) -- cgit