Skip to content
Snippets Groups Projects
Commit 2cfdc43e authored by Emmanuel Milou's avatar Emmanuel Milou
Browse files

[#2521] Configuration manager interface documentation

parent 7754c2ff
Branches
Tags
No related merge requests found
...@@ -297,10 +297,12 @@ ...@@ -297,10 +297,12 @@
<method name="getRingtoneList" tp:name-for-bindings="getRingtoneList"> <method name="getRingtoneList" tp:name-for-bindings="getRingtoneList">
<tp:docstring> <tp:docstring>
Get the list of available ringtones.
</tp:docstring> </tp:docstring>
<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/>
<arg type="as" name="list" direction="out"> <arg type="as" name="list" direction="out">
<tp:docstring> <tp:docstring>
A list of path.
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
...@@ -327,9 +329,11 @@ ...@@ -327,9 +329,11 @@
<method name="isRingtoneEnabled" tp:name-for-bindings="isRingtoneEnabled"> <method name="isRingtoneEnabled" tp:name-for-bindings="isRingtoneEnabled">
<tp:docstring> <tp:docstring>
Whether or not to play a custom ringtone.
</tp:docstring> </tp:docstring>
<arg type="i" name="bool" direction="out"> <arg type="i" name="bool" direction="out">
<tp:docstring> <tp:docstring>
If false, the standart tone is played on incoming calls.
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
...@@ -359,50 +363,60 @@ ...@@ -359,50 +363,60 @@
<method name="getAudioManager" tp:name-for-bindings="getAudioManager"> <method name="getAudioManager" tp:name-for-bindings="getAudioManager">
<tp:docstring> <tp:docstring>
Get the current audio manager.
</tp:docstring> </tp:docstring>
<arg type="i" name="api" direction="out"> <arg type="i" name="api" direction="out">
<tp:docstring> <tp:docstring>
<ul>
<li>0: ALSA </li>
<li>1: Pulseaudio </li>
</ul>
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
<method name="setAudioManager" tp:name-for-bindings="setAudioManager"> <method name="setAudioManager" tp:name-for-bindings="setAudioManager">
<tp:docstring> <tp:docstring>
Switch audio manager.
</tp:docstring> </tp:docstring>
<arg type="i" name="api" direction="in"> <arg type="i" name="api" direction="in">
<tp:docstring> <tp:docstring>
<p>The ID of the audio manager to use.</p>
<p>Refer to <tp:member-ref>getAudioManager</tp:member-ref> for possible values.</p>
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
<method name="getRecordPath" tp:name-for-bindings="getRecordPath"> <method name="getRecordPath" tp:name-for-bindings="getRecordPath">
<tp:docstring> <tp:docstring>
Get the path where to save the recorded calls.
</tp:docstring> </tp:docstring>
<arg type="s" name="rec" direction="out"> <arg type="s" name="rec" direction="out">
<tp:docstring> <tp:docstring>
A path.
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
<method name="setRecordPath" tp:name-for-bindings="setRecordPath"> <method name="setRecordPath" tp:name-for-bindings="setRecordPath">
<tp:docstring> <tp:docstring>
Change the path where save recorded calls.
</tp:docstring> </tp:docstring>
<arg type="s" name="rec" direction="in"> <arg type="s" name="rec" direction="in">
<tp:docstring> <tp:docstring>
The new path.
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
<!-- /////////////////////// -->
<!-- Codecs-related methods -->
<method name="getCodecList" tp:name-for-bindings="getCodecList"> <method name="getCodecList" tp:name-for-bindings="getCodecList">
<tp:docstring> <tp:docstring>
Get the core audio codec capabilities.
</tp:docstring> </tp:docstring>
<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/> <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="VectorString"/>
<arg type="as" name="list" direction="out"> <arg type="as" name="list" direction="out">
<tp:docstring> <tp:docstring>
A list of codecs, identified by their RTP payload, delimited by '/'
</tp:docstring> </tp:docstring>
</arg> </arg>
</method> </method>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment