docs: Add overview documentation.
[profile/ivi/rygel.git] / doc / reference / librygel-renderer-gst / gtkdoc / overview.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4 <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
5 ]>
6
7 <section id="overview">
8
9 <para>
10 librygel-renderer-gst is part of the <ulink url="http://rygel-project.org/">Rygel</ulink> project.
11 </para>
12
13 <para>
14 This library may be used to create UPnP or DLNA Renderers using GStreamer.
15 The <link linkend="RygelPlaybinRenderer">RygelPlaybinRenderer</link> may
16 wrap an existing GStreamer playbin or create its own.
17 </para>
18
19 <!-- TODO: Find a way to mention this C example code in the RygelPlaybinRenderer valadoc comments instead. -->
20 <para>
21 This example program shows how to instantiate the renderer then configure its GStreamer playbin element
22 and connect it to a network interface.
23 </para>
24 <programlisting role="C">
25   <xi:include  href="../../../../examples/standalone-renderer.c"
26     parse="text"
27     xmlns:xi="http://www.w3.org/2001/XInclude"/>
28 </programlisting>
29
30 <para>
31 librygel-renderer-gst is licensed under the GNU Lesser General Public License (LGPL).
32 </para>
33
34 </section>