</varlistentry>
<varlistentry>
<term>
- <option>enable-mp3-transcoder</option>
- </term>
- <listitem>
- <para>Set to <userinput>true</userinput> to enable transcoding to MP3.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>enable-mp2ts-transcoder</option>
- </term>
- <listitem>
- <para>
- Set to <userinput>true</userinput> to enable transcoding to MPEG2
- in TS container.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <option>enable-lpcm-transcoder</option>
+ <option>log-level=<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>[,<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>,…]</option>
</term>
<listitem>
- <para>
- Set to <userinput>true</userinput> to enable transcoding to Linear PCM.
- </para>
+ <para>Comma-separated list of <replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable> pairs, allowing to set the log level individually for each domain, where <replaceable>DOMAIN</replaceable> is eiher <userinput>"*"</userinput>, "<userinput>rygel</userinput>" or the name of a plugin. Allowed log levels are 1=critical, 2=error, 3=warning, 4=message/info,
+ 5=debug.
+ Note that on recent versions of GLib (>= 2.36) it is required to set the environment variable <envar>G_MESSAGES_DEBUG</envar> to <userinput>all</userinput> to get any debug output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <option>enable-wmv-transcoder</option>
+ <option>plugin-path=<replaceable>PATH</replaceable></option>
</term>
<listitem>
- <para>
- Set to <userinput>true</userinput> to enable transcoding to WMV.
- </para>
+ <para>Set the plugin search path.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <option>log-level=<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>[,<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>,…]</option>
+ <option>engine-path=<replaceable>PATH</replaceable></option>
</term>
<listitem>
- <para>Comma-separated list of <replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable> pairs, allowing to set the log level individually for each domain, where <replaceable>DOMAIN</replaceable> is eiher <userinput>"*"</userinput>, "<userinput>rygel</userinput>" or the name of a plugin. Allowed log levels are 1=critical, 2=error, 3=warning, 4=message/info,
- 5=debug.
- </para>
+ <para>Set the engine search path.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <option>plugin-path=<replaceable>PATH</replaceable></option>
+ <option>media-engine=<replaceable>ENGINE</replaceable></option>
</term>
<listitem>
- <para>Set the plugin search path.</para>
+ <para>Name of the loadable module to use as media engine back-end.</para>
</listitem>
</varlistentry>
<varlistentry>
<para>If <option>allow-upload</option> is <userinput>true</userinput>, use this folder to store uploaded pictures. It defaults to <userinput>@PICTURES@</userinput> which expands to the default directory for picture files (usually <filename><envar>$HOME</envar>/Pictures</filename>).</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>
+ <option>force-downgrade-for</option>
+ </term>
+ <listitem>
+ <para>Semicolon-separated list of device user-agents (or parts thereof) which need a forced downgrade to <userinput>MediaServer:1</userinput> and/or <userinput>ContentDirectory:1</userinput>.</para>
+ <para><warning>
+ <para>Only use this parameter if you know what your're doing or are being told to do so; overriding the default value might cause incompatibilites. If you find that adding your device here enables its usage with Rygel, please <ulink url="https://bugzilla.gnome.org/enter_bug.cgi?product=Rygel&component=IOP">file an IOP bug</ulink> so we can include it into the default configuration.</para>
+ </warning></para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>Sections for plugins are denoted with <option>[PluginName]</option>
and can contain options specific to a plugin (see below) as well these common options:
</variablelist>
</refsect1>
<refsect1>
+ <title>GStreamer Media Engine settings</title>
+ <para>The settings in the <code>[GstMediaEngine]</code> section are specific to the Gstreamer media engine, which is the default media engine. See the media-engine setting. These following options are available for the <ulink url="http://gstreamer.freedesktop.org">GStreamer</ulink> media engine.</para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>transcoders</option>
+ </term>
+ <listitem>
+ <para>A semicolon-separated list of the active transcoders. This setting has no effect if <option>enable-transcoding</option> is set to <code>false</code>. Possible values are: <code>lpcm,mp3,mp2ts,aac,avc</code> or <code>wmv</code>. Its default value is <code>lpcm;mp3;mp2ts;aac;wmv</code>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+ <refsect1>
<title>Tracker Plugin</title>
<para>The tracker plugin uses the centralized database of meta information
from the tracker project. See the
- <ulink url="http://www.tracker-project.org">tracker project website </ulink> for more information about tracker.
+ <ulink url="http://projects.gnome.org/tracker/">tracker project website </ulink> for more information about tracker.
</para>
<variablelist>
<varlistentry>
<option>uris</option>
</term>
<listitem>
- <para>A list of uris to expose via UPnP. May be files, folders or anything supported by gvfs. If left emtpy it defaults to export the user's music, video and picture folders as defined per XDG special user directories spec.</para>
+ <para>A list of URIS to expose via UPnP. May be files, folders or anything supported by GVFS. If left emtpy it defaults to export the user's music, video and picture folders as defined per XDG special user directories spec. These default folders can be referenced by <userinput>@MUSIC@</userinput>, <userinput>@PICTURES@</userinput> and <userinput>@VIDEOS@</userinput>. Locations can be entered as either fully escaped URIS or normal paths.</para>
+ <para><note>
+ <para>If you enter a normal path that contains whitespace there is no need to escape them with either a backslash or putting the string in quotes.</para>
+ </note></para>
+ <example>
+ <title>Possible values for <userinput>uris</userinput></title>
+ <para/>
+ <para><userinput>uris=@MUSIC@;/home/user/My Pictures;file:///home/user/My%20Videos</userinput></para>
+ </example>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <option>include-filter</option>
+ <option>extract-metadata</option>
</term>
<listitem>
- <para>A list of filename extensions. If this option is omitted or empty, every file will be analyzed for meta-data. The extensions are case-insensitive.</para>
+ <para>Set to <userinput>false</userinput> if you do not care about duration or any other meta-data like artist. This speeds up the initial crawl of the media a lot. Use it to quickly share some files via UPnP. Make sure to define an <option>include-filter</option>, otherwise you will end up with a lot of files exposed which the client cannot display anyway.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <option>extract-metadata</option>
+ <option>monitor-changes</option>
</term>
<listitem>
- <para>Set to <userinput>false</userinput> if you do not care about duration or any other meta-data like artist. This speeds up the initial crawl of the media a lot. Use it to quickly share some files via UPnP. Make sure to define an <option>include-filter</option>, otherwise you will end up with a lot of files exposed which the client cannot display anyway.</para>
+ <para>Set to <userinput>false</userinput> if you don't want to have new files picked up automatically by &dhpackage;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <option>monitor-changes</option>
+ <option>virtual-folders</option>
</term>
<listitem>
- <para>Set to <userinput>false</userinput> if you don't want to have new files picked up automatically by &dhpackage;.</para>
+ <para>Set to <userinput>false</userinput> if you don't need the virtual folder hierarchy.</para>
</listitem>
</varlistentry>
</variablelist>
</citerefentry>.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>
+ <option>identifier-dlnaprofile</option>
+ </term>
+ <listitem>
+ <para>DLNA profile for the stream.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>An example configuration is available in the distributed configuration file <filename>/etc/&dhucpackage;</filename>.</para>
</refsect1>
<refsect1>
<title>External</title>
- <para>The External plugin is an consumer of the <ulink url="http://live.gnome.org/Rygel/MediaServer2Spec">MediaServer2 DBus interface specification</ulink>. This allows external programs to share their data via UPnP by implementing this DBus specification. The plugin picks up any implementation of this interface on the session bus and exposes the presented media via UPnP. Known implementors of this spec are <ulink url="http://live.gnome.org/DVBDaemon">gnome-dvb-daemon</ulink> and <ulink url="http://live.gnome.org/Grilo">Grilo </ulink> via the grilo-rygel project.</para>
+ <para>The External plugin is an consumer of the <ulink url="http://live.gnome.org/Rygel/MediaServer2Spec">MediaServer2 DBus interface specification</ulink>. This allows external programs to share their data via UPnP by implementing this DBus specification. The plugin picks up any implementation of this interface on the session bus and exposes the presented media via UPnP. Known implementors of this spec are <ulink url="http://live.gnome.org/DVBDaemon">gnome-dvb-daemon</ulink>, <ulink url="http://www.rhythmbox.org">Rhythmbox</ulink> and <ulink url="http://live.gnome.org/Grilo">Grilo </ulink> via the grilo-ms2 project.</para>
+ <para>You can disable the whole functionality by setting <userinput>enabled=false</userinput> in the <userinput>[External]</userinput> section of the configuration file.</para>
+ <para>Individual peers may be enabled or disabled by creating sections corresponding to the D-Bus names of the peer:</para>
+ <programlisting>[org.gnome.UPnP.MediaServer2.Rhythmbox]
+enabled=false</programlisting>
<para>This plugin has no additional options.</para>
</refsect1>
<refsect1>
<para>The MPRIS plugin is a consumer of the <ulink url="http://www.mpris.org">MPRIS2 DBus interface specification</ulink>. The implementation conforms to version 2.0 of the standard.
</para>
<para><application>&dhpackage;</application> exposes media players that implement the provider side of this DBus specification as DLNA Digital Media Renderers (DMR) similar to the Playbin plugin. This means that you can easily turn your media player into a DMR by implementing this DBus specification.</para>
- <para>Players that implement this spec and are known to work with <application>&dhpackage;</application> are <ulink url="http://banshee.fm">Banshee</ulink> and <ulink url="http://www.rhythmbox.org">Rhythmbox</ulink>.
+ <para>Players that implement this spec and are known to work with <application>&dhpackage;</application> are <ulink url="http://banshee.fm">Banshee</ulink>, <ulink url="http://www.rhythmbox.org">Rhythmbox</ulink> and <ulink url="http://live.gnome.org/Totem">Totem</ulink>
</para>
+ <para>You can disable the whole functionality by setting <userinput>enabled=false</userinput> in the <userinput>[MRPIS]</userinput> section of the configuration file.</para>
<para>The configuration of this plugin is special. Plugin configuration is not done on the plugin but rather per peer that is found providing the MPRIS2 interface. See the following example to set the title for Banshee on MPRIS:</para>
<para><programlisting>[org.mpris.MediaPlayer2.banshee]
title=@REALNAME@'s Banshee on @HOSTNAME@</programlisting></para>
projects / profile / ivi / rygel.git / blobdiff