blob: 33dd17c5e9184fa2e50967d875d5ec54ecded2d6 [file] [log] [blame]
Bluetooth audio service API description
***************************************
Copyright (C) 2004-2007 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 Manager hierarchy
=======================
Service org.bluez.audio
Interface org.bluez.audio.Manager
Object path /org/bluez/audio
Methods array{string} ListHeadsets()
Returns list of headset objects that
are configured.
string DefaultHeadset()
Returns the object path for the default
headset device.
void ChangeDefaultHeadset(string path)
Changes the default headset.
string CreateHeadset(string address)
Create a new headset device and returns
its object path on return.
void RemoveHeadset(string path)
Removes a headset object and all information
related to it.
Signals void HeadsetCreated(string path)
Sent when a new headset object has been created.
void HeadsetRemoved(string path)
Sent when a headset object has been removed.
void DefaultHeadsetChanged(string path)
Sent when the default headset has changed.
Audio Headset hierarchy
=======================
Service org.bluez.audio
Interface org.bluez.audio.Headset
Object path /org/bluez/audio/headset*
Methods void Connect()
void Disconnect()
boolean IsConnected()
void IndicateCall()
Indicate an incoming call on the headset
connected to the stream. Will continue to
ring the headset about every 3 seconds.
void CancelCall()
Cancel the incoming call indication.
void Play()
Open the audio connection to the headset.
void Stop()
Close the audio connection.
boolean IsPlaying()
Returns true if an audio connection to the headset
is active.
Signals void AnswerRequested()
Sent when the answer button is pressed on the headset
void Connected()
Sent when the device has been connected to.
void Disconnected()
Sent when the device has been disconnected from.
void Stopped()
Sent when the audio connection is closed
void Playing()
Sent when the audio connection is opened
void SpeakerGainChanged(uint16 gain)
The speaker gain changed.
void MicrophoneGainChanged(uint16 gain)
The microphone gain changed.