summaryrefslogtreecommitdiffstats
path: root/doc/audio-settings-api.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/audio-settings-api.txt')
-rw-r--r--doc/audio-settings-api.txt26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/audio-settings-api.txt b/doc/audio-settings-api.txt
new file mode 100644
index 00000000..f59a230d
--- /dev/null
+++ b/doc/audio-settings-api.txt
@@ -0,0 +1,26 @@
+Audio settings hierarchy
+========================
+
+Service org.ofono
+Interface org.ofono.AudioSettings
+Object path [variable prefix]/{modem0,modem1,...}
+
+Methods dict GetProperties()
+
+ Returns all audio settings properties. See the
+ properties section for available properties.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+Signals PropertyChanged(string property, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
+Properties boolean Active [readonly]
+
+ Indicates if an audio PCM stream is active or not.
+
+ This is not supported by all modems. Only modems
+ where the audio data can be routed to the host
+ application processor will support this.