build: Whitespace & keep vim happy
[platform/upstream/ofono.git] / doc / audio-settings-api.txt
1 Audio settings hierarchy
2 ========================
3
4 Service         org.ofono
5 Interface       org.ofono.AudioSettings
6 Object path     [variable prefix]/{modem0,modem1,...}
7
8 Methods         dict GetProperties()
9
10                         Returns all audio settings properties. See the
11                         properties section for available properties.
12
13 Signals         PropertyChanged(string property, variant value)
14
15                         This signal indicates a changed value of the given
16                         property.
17
18 Properties      boolean Active [readonly] [EXPERIMENTAL]
19
20                         Indicates if an audio PCM stream is active or not.
21
22                         This is not supported by all modems. Only modems
23                         where the audio data can be routed to the host
24                         application processor will support this.
25
26                 string Mode [readonly, optional] [EXPERIMENTAL]
27
28                         Indicates the audio mode setting.
29
30                         This is highly modem specific audio string. Every
31                         modem might use different ones.