summaryrefslogtreecommitdiff
path: root/docs/libs/farsight2-libs-docs.sgml
blob: a648beeeb7ba9a2411a4e5d1283c844536e36ead (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>Farsight2 Reference Manual</title>
    <releaseinfo>
      for version &FS2_VERSION;.
      The latest version of this documentation can be found on-line at
      <ulink role="online-location" url="http://farsight.freedesktop.org/apidoc/farsight2/">http://farsight.freedesktop.org/apidoc/farsight2/</ulink>.
      The bases classes are implemented by multiple plugins described in
      the <ulink url="http://farsight.freedesktop.org/apidoc/farsight2-plugins/">Farsight2 Plugins Manual</ulink>.
    </releaseinfo>
  </bookinfo>

  <part>
    <title>User-oriented classes, interfaces and functions</title>
    <chapter>
      <title>Farsight GStreamer Interfaces</title>
      <xi:include href="xml/fs-conference-iface.xml"/>
    </chapter>
    <chapter>
      <title>Farsight Core Library</title>
      <xi:include href="xml/fs-participant.xml"/>
      <xi:include href="xml/fs-session.xml"/>
      <xi:include href="xml/fs-stream.xml"/>
      <xi:include href="xml/fs-candidate.xml"/>
      <xi:include href="xml/fs-codec.xml"/>
    </chapter>
    <chapter>
      <title>Protocol Specific types</title>
      <xi:include href="xml/fs-rtp.xml"/>
    </chapter>
    <chapter>
      <title>Farsight Utility Functions and Objects</title>
      <xi:include href="xml/fs-element-added-notifier.xml"/>
      <xi:include href="xml/fs-interfaces.xml"/>
      <xi:include href="xml/fs-utils.xml"/>
    </chapter>
  </part>
  <part>
    <title>Classes used to implement Farsight plugins</title>
    <chapter>
      <title>Farsight Classes Base Implementations</title>
      <xi:include href="xml/fs-base-conference.xml"/>
    </chapter>
    <chapter>
      <title>Farsight Transmitter Classes</title> 
      <xi:include href="xml/fs-transmitter.xml"/>
      <xi:include href="xml/fs-stream-transmitter.xml"/>
    </chapter>
    <chapter>
      <title>Farsight Plugins Infrastructure</title>
      <xi:include href="xml/fs-plugin.xml"/>
    </chapter>
  </part>
</book>