baresip/modules/ctrl_dbus/com.github.Baresip.xml
2021-02-06 14:22:12 +01:00

55 lines
1.6 KiB
XML

<!--
Communication channel to control and monitor Baresip via DBUS.
Copyright (C) 2020 commend.com - Christian Spielberger
-->
<node>
<!--
com.github.Baresip:
This DBus interface supports invoking of baresip commands and sends UA Events
as DBus signal.
-->
<interface name="com.github.Baresip">
<!--
invoke:
@command: The command to be executed with appended parameters.
@response: The output of the command.
Invokes a baresip command which can be a single character command or a long
command with appended parameters. Use a blank to separate the command from its
parameters! Multiple parameters are often separated by commas. But this depends
on the implementation of the command.
-->
<method name="invoke">
<arg name="command" direction="in" type="s"/>
<arg name="response" direction="out" type="s"/>
</method>
<!--
event:
@class: The UA event class.
@evtype: The UA event type.
@param: The whole event as JSON object including additional parameters.
-->
<signal name="event">
<arg name="class" type="s" direction="out" />
<arg name="evtype" type="s" direction="out" />
<arg name="param" type="s" direction="out" />
</signal>
<!--
message:
@ua: User-Agent local SIP URI (aor)
@peer: Peer address URI
@ctype: Content type ("text/plain")
@body: SIP message body
-->
<signal name="message">
<arg name="ua" type="s" direction="out" />
<arg name="peer" type="s" direction="out" />
<arg name="ctype" type="s" direction="out" />
<arg name="body" type="s" direction="out" />
</signal>
</interface>
</node>