summaryrefslogtreecommitdiffstats
path: root/src/uca-docs.xml.in
blob: 60bcf578b1637b4b1b8baf88ddbb5c0453b3ef5e (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
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<book id="index">
  <bookinfo>
    <title>libuca Reference Manual</title>
    <releaseinfo>
        for libuca ${UCA_VERSION_STRING}. The latest version of this documentation can be found on-line at
      <ulink role="online-location"
          url="http://ufo.kit.edu/extra/libuca">http://ufo.kit.edu/extra/libuca</ulink>.
    </releaseinfo>
  </bookinfo>

  <chapter>
    <title>Unified Camera Access</title>
        <xi:include href="xml/uca-camera.xml"/>
        ${_xml_doc_input}

  </chapter>

  <chapter id="howto-add-camera">
      <title>How to add a new camera</title>

      <para>
          Adding a new camera involves three steps:
          <itemizedlist>
              <listitem><para>Subclass from <link linkend="UcaCamera">UcaCamera</link> and implement all necessary methods
                  to start and stop recording, to grab frames and override and
                  add properties that are special to your
                  camera.</para></listitem>
              <listitem><para>Adapt <filename>src/CMakeLists.txt</filename>, so
                      that your dependencies are detected and your source files
                      are added to the <literal>uca_SRCS</literal> CMake
                      variable. Furthermore you must add an entry to
                      <filename>src/config.h.in</filename> that reflects the
                      CMake option variable</para></listitem>
              <listitem><para>Change <filename>src/uca-camera.c</filename>
                      and add a new (guarded) entry to the factory as well
                      as necessary include files.</para></listitem>
          </itemizedlist>
      </para>
  </chapter>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>

</book>