summaryrefslogtreecommitdiffstats
path: root/audio/audio-api.txt
blob: e123689e118cd02439eef2072f95d1dd68b3e58d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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.

		string CreateHeadset(string address)

			Create a new headset device and returns
			its object path on return.

		void RemoveHeadset(string path)

Signals		void HeadsetCreated(string path)

		void HeadsetRemoved(string path)

		void DefaultHeadsetChanged(string path)


Audio Headset hierarchy
=======================

Service		org.bluez.audio
Interface	org.bluez.audio.Headset
Object path	/org/bluez/audio/headset*

Methods		string GetAddress()

		string GetName()

		void Connect()

		void Disconnect()

		boolean IsConnected()

		uint16 GetSpeakerGain()

		uint16 GetMicrophoneGain()

		void SetSpeakerGain(uint16 gain)

			Gain is 0..15

		void SetMicrophoneGain(uint16 gain)

			Gain is 0..15

		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.

Signals		void SpeakerGainChanged(uint16 gain)

			The speaker gain changed.

		void MicrophoneGainChanged(uint16 gain)

			The microphone gain changed.

		void CallIndicated()

			An incoming call was indicated.

		void CallCanceled()

			Incoming call was canceled.