mirror of git://git.sysmocom.de/ofono
doc: Add audio settings API description
This commit is contained in:
parent
fb864c91c0
commit
860be0ad4f
|
@ -337,7 +337,8 @@ doc_files = doc/overview.txt doc/ofono-paper.txt \
|
||||||
doc/call-volume-api.txt doc/cell-broadcast-api.txt \
|
doc/call-volume-api.txt doc/cell-broadcast-api.txt \
|
||||||
doc/message-api.txt doc/message-waiting-api.txt \
|
doc/message-api.txt doc/message-waiting-api.txt \
|
||||||
doc/phonebook-api.txt doc/radio-settings-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 \
|
test_scripts = test/backtrace \
|
||||||
|
|
|
@ -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.
|
Loading…
Reference in New Issue