[rygel] docs: librygel-renderer-gst: Mention the fullscreen example.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [rygel] docs: librygel-renderer-gst: Mention the fullscreen example.
- Date: Tue, 22 Jan 2013 14:23:31 +0000 (UTC)
commit 39f8c13a58cdffc8d4c682d9d073166455f685cd
Author: Murray Cumming <murrayc murrayc com>
Date: Tue Jan 22 15:23:00 2013 +0100
docs: librygel-renderer-gst: Mention the fullscreen example.
.../gtkdoc/implementing-renderers-gst.xml | 38 ++++++++++++++++++--
.../gtkdoc/librygel-renderer-gst-docs.xml | 5 +--
2 files changed, 36 insertions(+), 7 deletions(-)
---
diff --git a/doc/reference/librygel-renderer-gst/gtkdoc/implementing-renderers-gst.xml b/doc/reference/librygel-renderer-gst/gtkdoc/implementing-renderers-gst.xml
index ab28a60..484d9cf 100644
--- a/doc/reference/librygel-renderer-gst/gtkdoc/implementing-renderers-gst.xml
+++ b/doc/reference/librygel-renderer-gst/gtkdoc/implementing-renderers-gst.xml
@@ -4,7 +4,11 @@
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
-<section id="implementing-renderers-gst">
+<chapter id="implementing-renderers-gst">
+<title>Implementing GStreamer-based Renderers</title>
+
+<section id="implementing-renderers-gst-overview">
+<title>Implementing GStreamer-based Renderers: Overview</title>
<para>
This library may be used to create in-process UPnP/DLNA Renderers, or Players based on GStreamer, via
@@ -12,10 +16,19 @@ the <link linkend="RygelPlaybinRenderer">RygelPlaybinRenderer</link> class. For
this may be used to add UPnP/DLNA Renderer or Player capability to an existing GStreamer-based media player application.
</para>
+<para>The <link linkend="RygelPlaybinRenderer">RygelPlaybinRenderer</link> reference documentation
+and these examples explain how to implement renderers.
+</para>
+
+</section>
+
+<section id="implementing-renderers-gst-simple-example">
+<title>Implementing GStreamer-based Renderers: Simple Example</title>
+
<!-- TODO: Find a way to mention this C example code in the RygelPlaybinRenderer valadoc comments instead. -->
<para>
-This example program shows how to instantiate the renderer then configure its GStreamer playbin element
-and connect it to a network interface.
+This simple example program shows how to instantiate the renderer then configure its GStreamer playbin element
+and connect it to a network interface, rendering the content to stdout as ASCII.
</para>
<!-- Do not indent the xi:include node. That puts spaces at the start of the code. -->
@@ -26,3 +39,22 @@ and connect it to a network interface.
</programlisting>
</section>
+
+<section id="implementing-renderers-gst-x-window-example">
+<title>Implementing GStreamer-based Renderers: X Window Example</title>
+
+<!-- TODO: Find a way to mention this C example code in the RygelPlaybinRenderer valadoc comments instead. -->
+<para>
+This slightly fuller example program shows how to instantiate the renderer then configure its GStreamer playbin element and connect it to a network interface, rendering the content in a full-screen X window.
+</para>
+
+<!-- Do not indent the xi:include node. That puts spaces at the start of the code. -->
+<programlisting role="C">
+<xi:include href="../../../../examples/fullscreen-renderer.c"
+ parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</programlisting>
+
+</section>
+
+</chapter>
diff --git a/doc/reference/librygel-renderer-gst/gtkdoc/librygel-renderer-gst-docs.xml b/doc/reference/librygel-renderer-gst/gtkdoc/librygel-renderer-gst-docs.xml
index f86d8f7..d6b59c6 100644
--- a/doc/reference/librygel-renderer-gst/gtkdoc/librygel-renderer-gst-docs.xml
+++ b/doc/reference/librygel-renderer-gst/gtkdoc/librygel-renderer-gst-docs.xml
@@ -20,10 +20,7 @@
<xi:include href="overview.xml"/>
</preface>
- <chapter>
- <title>Implementing GStreamer-based Renderers</title>
- <xi:include href="implementing-renderers-gst.xml"/>
- </chapter>
+ <xi:include href="implementing-renderers-gst.xml"/>
<!-- These are generated: -->
<chapter>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]