summaryrefslogtreecommitdiffstats
path: root/doc/call-volume-api.txt
blob: 320b25f9e0c692fc03eddd48b413a80b14fdf90b (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
CallVolume hierarchy
===============

Service		org.ofono
Interface	org.ofono.CallVolume
Object path	[variable prefix]/{modem0,modem1,...}

Methods		dict GetProperties()

			Returns properties for the CallVolume object. See
			the properties section for available properties.

		void SetProperty(string property, variant value)

			Changes the value of the specified property. Only
			properties that are listed as readwrite are
			changeable. On success a PropertyChanged signal
			will be emitted.

			Possible Errors: [service].Error.InProgress
					 [service].Error.NotImplemented
					 [service].Error.InvalidArguments
					 [service].Error.InvalidFormat
					 [service].Error.Failed

Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.

Properties	boolean Muted [readwrite]

			Boolean representing whether the microphone is muted.

		byte SpeakerVolume [readwrite]

			Represents the current volume of the speaker in
			percentage points.  Valid values are 0-100.

		byte MicrophoneVolume [readwrite]

			Represents the current volume of the microphone in
			percentage points.  Valid values are 0-100.