Move contents of lib/ into root directory

20070419173517-53eee-d91a15d77882d6839193c1f77be4f88803b48f58.gz

1 files changed, 281 insertions, 0 deletions

diff --git a/spec/Media_Stream_Handler.xml b/spec/Media_Stream_Handler.xml
new file mode 100644
index 000000000..1652c708f
--- /dev/null
+++ b/spec/Media_Stream_Handler.xml
@@ -0,0 +1,281 @@
+<?xml version="1.0" ?>
+<node name="/Media_Stream_Handler" 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.Media.StreamHandler">
+    <signal name="AddRemoteCandidate">
+      <arg name="candidate_id" type="s">
+        <tp:docstring>
+          String identifier for this candidate
+        </tp:docstring>
+      </arg>
+      <arg name="transports" type="a(usuussduss)">
+        <tp:docstring>
+          Array of transports for this candidate with fields,
+          as defined in NewNativeCandidate
+        </tp:docstring>
+      </arg>
+      <tp:docstring>
+        Signal emitted when the connection manager wishes to inform the
+        client of a new remote candidate.
+      </tp:docstring>
+    </signal>
+    <signal name="Close">
+      <tp:docstring>
+        Signal emitted when the connection manager wishes the stream to be
+        closed.
+      </tp:docstring>
+    </signal>
+    <method name="CodecChoice">
+      <arg direction="in" name="codec_id" type="u"/>
+      <tp:docstring>
+        Inform the connection manager of the current codec choice.
+      </tp:docstring>
+    </method>
+    <method name="Error">
+      <arg direction="in" name="errno" type="u">
+        <tp:docstring>
+          ID of error, from the MediaStreamError enumeration
+        </tp:docstring>
+      </arg>
+      <arg direction="in" name="message" type="s">
+        <tp:docstring>
+          String describing the error
+        </tp:docstring>
+      </arg>
+      <tp:docstring>
+        Inform the connection manager that an error occured in this stream. The
+        connection manager should emit the StreamError signal for the stream on
+        the relevant channel, and remove the stream from the session.
+      </tp:docstring>
+    </method>
+    <tp:enum name="Media_Stream_Error" type="u">
+      <tp:enumvalue suffix="Unknown" value="0">
+        <tp:docstring>
+        An unknown error occured.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="EOS" value="1">
+        <tp:docstring>
+        The end of the stream was reached.
+        </tp:docstring>
+      </tp:enumvalue>
+    </tp:enum>
+    <method name="NativeCandidatesPrepared">
+      <tp:docstring>
+        Informs the connection manager that all possible native candisates
+        have been discovered for the moment.
+      </tp:docstring>
+    </method>
+    <method name="NewActiveCandidatePair">
+      <arg direction="in" name="native_candidate_id" type="s"/>
+      <arg direction="in" name="remote_candidate_id" type="s"/>
+      <tp:docstring>
+        Informs the connection manager that a valid candidate pair
+        has been discovered and streaming is in progress.
+      </tp:docstring>
+    </method>
+    <tp:enum name="Media_Stream_Base_Proto" type="u">
+      <tp:enumvalue suffix="UDP" value="0">
+        <tp:docstring>UDP (User Datagram Protocol)</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="TCP" value="1">
+        <tp:docstring>TCP (Transmission Control Protocol)</tp:docstring>
+      </tp:enumvalue>
+    </tp:enum>
+    <method name="NewNativeCandidate">
+      <arg direction="in" name="candidate_id" type="s">
+        <tp:docstring>
+          String identifier for this candidate
+        </tp:docstring>
+      </arg>
+      <arg direction="in" name="transports" type="a(usuussduss)">
+        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+          Array of transports for this candidate, with fields:
+          <ul>
+            <li>component number</li>
+            <li>IP address (as a string)</li>
+            <li>port</li>
+            <li>base network protocol (one of the values of MediaStreamBaseProto)</li>
+            <li>proto subtype (e.g. RTP)</li>
+            <li>proto profile (e.g. AVP)</li>
+            <li>our preference value of this transport (double in range 0.0-1.0
+              inclusive); 1 signals the most preferred transport</li>
+            <li>transport type, one of the values of MediaStreamTransportType</li>
+            <li>username if authentication is required</li>
+            <li>password if authentication is required</li>
+          </ul>
+        </tp:docstring>
+      </arg>
+      <tp:docstring>
+        Inform this MediaStreamHandler that a new native transport candidate
+        has been ascertained.
+      </tp:docstring>
+    </method>
+    <tp:enum name="Media_Stream_Transport_Type" type="u">
+      <tp:enumvalue suffix="Local" value="0">
+        <tp:docstring>
+          A local address
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Derived" value="1">
+        <tp:docstring>
+          An external address derived by a method such as STUN
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Relay" value="2">
+        <tp:docstring>
+          An external stream relay
+        </tp:docstring>
+      </tp:enumvalue>
+    </tp:enum>
+    <method name="Ready">
+      <arg direction="in" name="codecs" type="a(usuuua{ss})">
+        <tp:docstring>
+          As for SupportedCodecs.
+        </tp:docstring>
+      </arg>
+      <tp:docstring>
+        Inform the connection manager that a client is ready to handle
+        this StreamHandler. Also provide it with info about all supported
+        codecs.
+      </tp:docstring>
+    </method>
+    <method name="SetLocalCodecs">
+      <arg name="codecs" type="a(usuuua{ss})" direction="in">
+        <tp:docstring>Codecs in the same format as for
+          SupportedCodecs, which have the same semantics as the
+          local codecs passed to Ready</tp:docstring>
+      </arg>
+      <tp:docstring>
+        Used to provide codecs after Ready(), so the media client can go
+        ready for an incoming call and exchange candidates/codecs before
+        knowing what local codecs are available.
+      </tp:docstring>
+    </method>
+    <signal name="RemoveRemoteCandidate">
+      <arg name="candidate_id" type="s">
+        <tp:docstring>
+          String identifier for remote candidate to drop
+        </tp:docstring>
+      </arg>
+      <tp:docstring>
+        Signal emitted when the connection manager wishes to inform the
+        client that the remote end has removed a previously usable
+        candidate.
+      </tp:docstring>
+    </signal>
+    <signal name="SetActiveCandidatePair">
+      <arg name="native_candidate_id" type="s"/>
+      <arg name="remote_candidate_id" type="s"/>
+      <tp:docstring>
+        Emitted by the connection manager to inform the client that a
+        valid candidate pair has been discovered by the remote end
+        and streaming is in progress.
+      </tp:docstring>
+    </signal>
+    <signal name="SetRemoteCandidateList">
+      <arg name="remote_candidates" type="a(sa(usuussduss))">
+        <tp:docstring>
+        A list of candidate id and a list of transports
+        as defined in NewNativeCandidate
+        </tp:docstring>
+      </arg>
+      <tp:docstring>
+        Signal emitted when the connection manager wishes to inform the
+        client of all the available remote candidates at once.
+      </tp:docstring>
+    </signal>
+    <signal name="SetRemoteCodecs">
+      <arg name="codecs" type="a(usuuua{ss})">
+        <tp:docstring>As for SupportedCodecs</tp:docstring>
+      </arg>
+      <tp:docstring>
+        Signal emitted when the connection manager wishes to inform the
+        client of the codecs supported by the remote end.
+      </tp:docstring>
+    </signal>
+    <signal name="SetStreamPlaying">
+      <arg name="playing" type="b"/>
+      <tp:docstring>
+        Signal emitted when the connection manager wishes to set the
+        stream playing or stopped.
+      </tp:docstring>
+    </signal>
+    <signal name="SetStreamSending">
+      <arg name="playing" type="b"/>
+      <tp:docstring>
+        Signal emitted when the connection manager wishes to set whether or not
+        the stream sends to the remote end.
+      </tp:docstring>
+    </signal>
+    <signal name="StartTelephonyEvent">
+      <arg name="event" type="y">
+        <tp:docstring>
+          A telephony event code as defined by RFC 4733.
+        </tp:docstring>
+      </arg>
+      <tp:docstring>
+        Request that a telephony event (as defined by RFC 4733) is transmitted
+        over this stream until StopTelephonyEvent is called.
+      </tp:docstring>
+    </signal>
+    <signal name="StopTelephonyEvent">
+      <tp:docstring>
+        Request that any ongoing telephony events (as defined by RFC 4733)
+        being transmitted over this stream are stopped.
+      </tp:docstring>
+    </signal>
+    <method name="StreamState">
+      <arg direction="in" name="state" type="u"/>
+      <tp:docstring>
+        Informs the connection manager of the stream's current state, as
+        as specified in Channel.Type.StreamedMedia::ListStreams.
+      </tp:docstring>
+    </method>
+    <method name="SupportedCodecs">
+      <arg direction="in" name="codecs" type="a(usuuua{ss})">
+        <tp:docstring>
+          List of codec info structures, each containing:
+          <ul>
+            <li>ID of codec</li>
+            <li>Codec name</li>
+            <li>Media type</li>
+            <li>Clock rate of codec</li>
+            <li>Number of supported channels</li>
+            <li>String key-value pairs for supported optional parameters</li>
+          </ul>
+        </tp:docstring>
+      </arg>
+      <tp:docstring>
+        Inform the connection manager of the supported codecs for this session.
+        This is called after the connection manager has emitted SetRemoteCodecs
+        to notify what codecs are supported by the peer, and will thus be an
+        intersection of all locally supported codecs (passed to Ready)
+        and those supported by the peer.
+      </tp:docstring>
+    </method>
+    <tp:docstring>
+    Handles signalling the information pertaining to a specific media stream.
+    A client should provide information to this handler as and when it is
+    available.
+    </tp:docstring>
+  </interface>
+</node>
+<!-- vim:set sw=2 sts=2 et ft=xml: -->