summaryrefslogtreecommitdiff
path: root/spec/Channel_Interface_Media_Signalling.xml
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2007-04-19 17:35:17 +0000
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2007-04-19 17:35:17 +0000
commit05b3d77a6ceaf9142e0dee8bf52e7637d5823bdd (patch)
treeae7da2dc08fb4c3aa1c6b09ffa1c57d2d3adf24a /spec/Channel_Interface_Media_Signalling.xml
parent90720ee40eb30e2b1c9aa90501391d3a0a411250 (diff)
downloadtelepathy-glib-05b3d77a6ceaf9142e0dee8bf52e7637d5823bdd.tar.gz
Move contents of lib/ into root directory
20070419173517-53eee-d91a15d77882d6839193c1f77be4f88803b48f58.gz
Diffstat (limited to 'spec/Channel_Interface_Media_Signalling.xml')
-rw-r--r--spec/Channel_Interface_Media_Signalling.xml96
1 files changed, 96 insertions, 0 deletions
diff --git a/spec/Channel_Interface_Media_Signalling.xml b/spec/Channel_Interface_Media_Signalling.xml
new file mode 100644
index 000000000..4a0fcd254
--- /dev/null
+++ b/spec/Channel_Interface_Media_Signalling.xml
@@ -0,0 +1,96 @@
+<?xml version="1.0" ?>
+<node name="/Channel_Interface_Media_Signalling" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+ <tp:copyright> Copyright (C) 2005, 2006 Collabora Limited </tp:copyright>
+ <tp:copyright> Copyright (C) 2005, 2006 Nokia Corporation </tp:copyright>
+ <tp:copyright> Copyright (C) 2006 INdT </tp:copyright>
+ <tp:license xmlns="http://www.w3.org/1999/xhtml">
+ <p>This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.</p>
+
+<p>This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Library General Public License for more details.</p>
+
+<p>You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</p>
+ </tp:license>
+ <interface name="org.freedesktop.Telepathy.Channel.Interface.MediaSignalling">
+ <tp:requires interface="org.freedesktop.Telepathy.Channel"/>
+ <method name="GetSessionHandlers">
+ <arg direction="out" type="a(os)"/>
+ <tp:docstring>
+ Returns all currently active session handlers on this channel
+ as a list of (session_handler_path, type).
+ </tp:docstring>
+ </method>
+ <signal name="NewSessionHandler">
+ <arg name="session_handler" type="o">
+ <tp:docstring>
+ Object path of the new MediaSessionHandler object
+ </tp:docstring>
+ </arg>
+ <arg name="type" type="s">
+ <tp:docstring>
+ String indicating type of session, eg &quot;rtp&quot;
+ </tp:docstring>
+ </arg>
+ <tp:docstring>
+ Signal that a session handler object has been created. The client
+ should create a session object and create streams for the streams
+ within.
+ </tp:docstring>
+ </signal>
+ <tp:property name="nat-traversal" type="s">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>A string indicating the NAT traversal techniques employed by the
+ streams within this channel. Can be protocol-specific values, but the
+ following values should be used if appropriate:</p>
+
+ <dl>
+ <dt>none</dt>
+ <dd>No attempt should be made at NAT traversal.</dd>
+
+ <dt>stun</dt>
+ <dd>If appropriate, a STUN request should be made to the given server
+ to open a UDP port mapping and determine the external IP.</dd>
+
+ <dt>gtalk-p2p</dt>
+ <dd>Google Talk peer-to-peer connectivity establishment should be used,
+ as implemented in libjingle 0.3.</dd>
+ </dl>
+ </tp:docstring>
+ </tp:property>
+ <tp:property name="stun-server" type="s">
+ <tp:docstring>
+ The IP address or hostname of the STUN server to use for NAT traversal.
+ </tp:docstring>
+ </tp:property>
+ <tp:property name="stun-port" type="q">
+ <tp:docstring>
+ The UDP port number to use on the provided STUN server.
+ </tp:docstring>
+ </tp:property>
+ <tp:property name="gtalk-p2p-relay-token" type="s">
+ <tp:docstring>
+ The authentication token for use with the Google Talk peer-to-peer relay
+ server.
+ </tp:docstring>
+ </tp:property>
+ <tp:docstring>
+ An interface for signalling a channel containing synchronised media
+ sessions which can contain an arbitrary number of streams. The negotiation
+ interface is based closely around the API of the Farsight library
+ (http://farsight.sourceforge.net/). This in turn is based upon the IETF
+ MMusic ICE drafts where connections are established by signalling potential
+ connection candidates to the peer until a usable connection is found, and
+ codecs are negotiated with an SDP-style offer and answer. However, the
+ principles should be applicable to other media streaming methods and the
+ API re-used without difficulty.
+ </tp:docstring>
+ </interface>
+</node>
+<!-- vim:set sw=2 sts=2 et ft=xml: -->