grilo-plugins-0.2-base 0.2.17-0ubuntu2 / usr / share / help / C / grilo-plugins / grilo-plugins.xml

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://docbook.org/xml/4.5/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY url_refdocs_base "http://developer.gnome.org/grilo/unstable/">
  <!ENTITY url_examples_base "http://git.gnome.org/browse/grilo-plugins/tree/help/examples/">
  <!ENTITY uuml "&#252;" >
  <!ENTITY szlig "&#223;" >
  <!ENTITY verbar "&#124;" >
  <!ENTITY copy "&#169;" >
  <!ENTITY nbsp "&#160;" >
]>

<!-- The XSL for developer.gnome.org requires this id. -->
<book id="index">

  <bookinfo>

    <title>Grilo Plugins</title>

    <authorgroup>
      <author>
        <firstname>Murray</firstname>
        <surname>Cumming</surname>
      </author>
    </authorgroup>

    <abstract>

      <!-- This text is copied from the introduction. -->
      <para>Grilo is a framework for browsing and searching media content from various sources using a single API. The Grilo Plugins plugins for the Grilo framework to provide access to various sources of media and metadata.
      </para>
    </abstract>

    <copyright>
      <year>2012</year>
      <holder>Openismus GmbH</holder>
    </copyright>

    <legalnotice>
      <para>
        Permission is granted to copy, distribute and/or modify this document
        under the terms of the GNU Free Documentation License, Version 1.2
        or any later version published by the Free Software Foundation;
        with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
        You may obtain a copy of the GNU Free Documentation License from the Free Software Foundation by visiting their Web site or by writing to: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301, USA.
      </para>
    </legalnotice>

  </bookinfo>

<chapter id="chapter-introduction">
<title>Introduction</title>

<para>Grilo is a framework for browsing and searching media content from various sources using a single API. The Grilo Plugins plugins for the Grilo framework to provide access to various sources of media and metadata.</para>
</chapter>


<chapter id="chapter-plugins">
<title>Grilo Plugins</title>


<sect1 id="sec-plugin-apple-trailers">
<title>Apple Trailers</title>
<para>This is a Grilo plugin for Apple trailers. Its plugin ID is <literal>"grl-apple-trailers"</literal></para>
</sect1>

<sect1 id="sec-plugin-bookmarks">
<title>Bookmarks</title>
<para>This is a Grilo plugin for bookmarks. Its plugin ID is <literal>"grl-bookmarks"</literal></para>
</sect1>

<sect1 id="sec-plugin-dmap">
<title>DMap</title>
<para>This is a Grilo plugin for DMap. Its plugin ID is <literal>"grl-dmap"</literal></para>
</sect1>

<sect1 id="sec-plugin-filesystem">
<title>Filesystem</title>
<para>This is a Grilo plugin for the filesystem. Its plugin ID is <literal>"grl-filesystem"</literal></para>
</sect1>

<sect1 id="sec-plugin-flickr">
<title>Flickr</title>
<para>This is a Grilo plugin for Flickr. Its plugin ID is <literal>"grl-flickr"</literal></para>
</sect1>

<sect1 id="sec-plugin-gravatar">
<title>Gravatar</title>
<para>This is a Grilo plugin for Gravatar Its plugin ID is <literal>"grl-gravatar"</literal>.</para>
</sect1>

<sect1 id="sec-plugin-jamendo">
<title>Jamendo</title>
<para>This is a Grilo plugin for Jamendo. Its plugin ID is <literal>"grl-jamendo"</literal></para>
</sect1>

<sect1 id="sec-plugin-local-metadata">
<title>Local Metadata</title>
<para>This is a Grilo plugin for Local metadata. Its plugin ID is <literal>"grl-local-metadata"</literal></para>
</sect1>

<sect1 id="sec-plugin-metadata-store">
<title>Metadata Store</title>
<para>This is a Grilo plugin for metadata store. Its plugin ID is <literal>"grl-metadata-store"</literal></para>
</sect1>

<sect1 id="sec-plugin-optical-media">
<title>Optical Media</title>
<para>This is a Grilo plugin for optical media. Its plugin ID is <literal>"grl-optical-media"</literal></para>
</sect1>

<sect1 id="sec-plugin-podcasts">
<title>Podcasts</title>
<para>This is a Grilo plugin for podcasts. Its plugin ID is <literal>"grl-podcasts"</literal></para>
</sect1>

<sect1 id="sec-plugin-shoutcast">
<title>Shoutcast</title>
<para>This is a Grilo plugin for Shoutcast. Its plugin ID is <literal>"grl-shoutcast"</literal></para>
</sect1>

<sect1 id="sec-plugin-tmdb">
<title>TMDb Plugin</title>
<para>The TMDb plugin retrieves information about movies from the <ulink url="http://themoviedb.org">TMDb online service</ulink>, which is a community-maintained movie database. Its plugin ID is <literal>"grl-tmdb"</literal></para>
<para>Before using this plugin, you should set the TMDB API Key with <ulink url="&url_refdocs_base;GrlConfig.html#grl-config-set-api-key"><function>grl_config_set_api_key()</function></ulink>.</para>
<para>You may then use <ulink url="&url_refdocs_base;GrlSource.html#grl-source-resolve"><function>grl_source_resolve()</function></ulink> to discover details about an existing GrlMediaItem.</para>
<para>This plugin does not support search via <ulink url="&url_refdocs_base;GrlSource.html#grl-source-search"><function>grl_source_search()</function></ulink> or queries via <ulink url="&url_refdocs_base;GrlSource.html#grl-source-query"><function>grl_source_query()</function></ulink>.</para>

<para>Here is a simple example of the use of the Grilo TMDb plugin:</para>

<para>File: <ulink url="&url_examples_base;example-tmdb.c"><filename>example-tmdb.c</filename></ulink></para>
<programlisting>
<xi:include  href="../examples/example-tmdb.c" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</programlisting>

</sect1>

<sect1 id="sec-plugin-tracker">
<title>Tracker</title>
<para>This is a Grilo plugin for Tracker. Its plugin ID is <literal>"grl-tracker"</literal></para>
</sect1>

<sect1 id="sec-plugin-vimeo">
<title>Vimeo</title>
<para>This is a Grilo plugin for Vimeo. Its plugin ID is <literal>"grl-vimeo"</literal></para>
</sect1>

<sect1 id="sec-plugin-youtube">
<title>YouTube</title>
<para>This is a Grilo plugin for YouTube. Its plugin ID is <literal>"grl-youtube"</literal></para>
</sect1>

<sect1 id="sec-plugin-dleyna">
<title>DLeyna</title>
<para>This is a Grilo plugin for UPnP/DLNA. Its plugin ID is <literal>"grl-dleyna"</literal></para>
</sect1>

</chapter>

</book>