source: x/lib/clutter-gst.xml@ b733933

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY clutter-gst-download-http
           "&gnome-download-http;/clutter-gst/3.0/clutter-gst-&clutter-gst-version;.tar.xz">
  <!ENTITY clutter-gst-download-ftp
           "&gnome-download-ftp;/clutter-gst/3.0/clutter-gst-&clutter-gst-version;.tar.xz">
  <!ENTITY clutter-gst-md5sum        "2bf9d7ca146c9d71e86c45cd00e9a28e">
  <!ENTITY clutter-gst-size          "396 KB">
  <!ENTITY clutter-gst-buildsize     "10 MB">
  <!ENTITY clutter-gst-time          "0.2 SBU">
]>

<sect1 id="clutter-gst" xreflabel="clutter-gst-&clutter-gst-version;">
  <?dbhtml filename="clutter-gst.html"?>


  <title>clutter-gst-&clutter-gst-version;</title>

  <indexterm zone="clutter-gst">
    <primary sortas="a-clutter-gst">clutter-gst</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Clutter Gst</title>

    <para>
      The <application>Clutter Gst</application> package contains an
      integration library for using <application>GStreamer</application> with
      <application>Clutter</application>. Its purpose is to implement the
      ClutterMedia interface using <application>GStreamer</application>.
    </para>

    &lfs120_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&clutter-gst-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&clutter-gst-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &clutter-gst-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &clutter-gst-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &clutter-gst-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &clutter-gst-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Clutter Gst Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="clutter"/>,
      <xref linkend="gst10-plugins-base"/>, and
      <xref linkend="libgudev"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="gst10-plugins-bad"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <ulink url="https://github.com/castano/cgc-opensrc">Cgc</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Clutter Gst</title>

    <para>
      Install <application>Clutter Gst</application> by running the following
      commands:
    </para>
<!--
    <note><para>
      This package<!- -must be built from an Xterm.  It will- -> fails to build
      over an ssh session.
    </para></note>
Seems to work now 20151016. - Bruce
-->
<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libclutter-gst-3.0.so and /usr/lib/gstreamer-1.0/libcluttergst3.so
        </seg>
        <seg>
          /usr/include/clutter-gst-3.0 and
          /usr/share/gtk-doc/html/clutter-gst-3.0
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libclutter-gst-3">
        <term><filename class="libraryfile">libclutter-gst-3.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>Clutter Gst</application> API functions
          </para>
          <indexterm zone="clutter-gst libclutter-gst-3">
            <primary sortas="c-libclutter-gst-3">libclutter-gst-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>