doc: Add audio settings API description

diff --git a/Makefile.am b/Makefile.am
index 378dbca..a364d4c 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -337,7 +337,8 @@ doc_files = doc/overview.txt doc/ofono-paper.txt \
                        doc/call-volume-api.txt doc/cell-broadcast-api.txt \
                        doc/message-api.txt doc/message-waiting-api.txt \
                        doc/phonebook-api.txt doc/radio-settings-api.txt \
-                       doc/sim-api.txt doc/stk-api.txt
+                       doc/sim-api.txt doc/stk-api.txt \
+                       doc/audio-settings-api.txt
 
 
 test_scripts = test/backtrace \

diff --git a/doc/audio-settings-api.txt b/doc/audio-settings-api.txt
new file mode 100644 (file)
index 0000000..f59a230
--- /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.