1.6 Configure Extended Runtime Options

1.6.1 Extended Runtime Options

extended-runtime-options
Type: Section
Required: False
<extended-runtime-options>
   <ffmpegthumbnailer>...</ffmpegthumbnailer>
   <lastfm>...</lastfm>
</extended-runtime-options>

These options reside under the server tag and allow to additinally control the so called “runtime options”. The difference to the import options is:

Import options are only triggered when data is being imported into the database, this means that if you want new settings to be applied to already imported data, you will have to reimport it. Runtime options can be switched on and off without the need to reimport any media. Unfortunately you still need to restart the server so that these options take effect, however after that they are immediately active.

1.6.1.1 FFMpeg Thumbnailer

ffmpegthumbnailer
Type: Section
Required: False
<ffmpegthumbnailer enabled="yes"></ffmpegthumbnailer>

Ffmpegthumbnailer is a nice, easy to use library that allows to generate thumbnails from video files. Some DLNA compliant devices support video thumbnails, if you think that your device may be one of those you can try enabling this option.

ffmpegthumbnailer enabled
Type: Boolean
Required: False
Default: no
enabled="yes"

The following options allow to control the ffmpegthumbnailer library (these are basically the same options as the ones offered by the ffmpegthumbnailer command line application). All tags below are optional and have sane default values.

ffmpegthumbnailer video-enabled
Type: Boolean
Required: False
Default: yes
video-enabled="no"

Enables or disables the use thumbnails for videos, set to no to disable the feature.

ffmpegthumbnailer image-enabled
Type: Boolean
Required: False
Default: yes
image-enabled="no"

Enables or disables the use thumbnails for images, set to no to disable the feature.

ffmpegthumbnailer cache-dir
Type: Path
Required: False
Default: ${gerbera-home}/cache-dir
<cache-dir enabled="yes">/home/gerbera/cache-dir</cache-dir>

Database location for the thumbnail cache when FFMPEGThumbnailer is enabled. Defaults to Gerbera Home. Creates a thumbnail with file format as: <movie-filename>-thumb.jpg.

The attributes of the tag have the following meaning:

ffmpegthumbnailer cache-dir enabled
Type: Boolean
Required: False
Default: yes
enabled="no"

Enables or disables the use of cache directory for thumbnails, set to yes to enable the feature.

ffmpegthumbnailer thumbnail-size
Type: Integer
Required: False
Default: 160
<thumbnail-size>160</thumbnail-size>

The thumbnail size should not exceed 160x160 pixels, higher values can be used but will mostprobably not be supported by DLNA devices. The value of zero or less is not allowed.

ffmpegthumbnailer seek-percentage
Type: Integer
Required: False
Default: 5
<seek-percentage>5</seek-percentage>

Time to seek to in the movie (percentage), values less than zero are not allowed.

ffmpegthumbnailer filmstrip-overlay
Type: Boolean
Required: False
Default: no
<filmstrip-overlay>yes</filmstrip-overlay>

Creates a filmstrip like border around the image, turn this option off if you want pure images.

ffmpegthumbnailer rotate
Type: Boolean
Required: False
Default: no
<rotate>yes</rotate>

Added in version 3.0.0.

Rotates the thumbnail depending on orientation of the movie/picture.

ffmpegthumbnailer image-quality
Type: Integer
Required: False
Default: 8
<image-quality>5</image-quality>

Sets the image quality of the generated thumbnails.

1.6.1.2 Last.FM

lastfm
Type: Section
Required: False
<lastfm enabled="yes">
lastfm enabled
Type: Boolean
Required: False
Default: no
enabled="yes"

Support for the last.fm service. Gerbera has to be built with LastFM support.

lastfm username
Type: String
Required: True
Default: lastfmuser

Changed in version 3.0.0: Used as apiKey for API 2.0

<username>login</username>

Your last.fm user name or the apiKey for API version 2.0.

lastfm password
Type: String
Required: True
Default: lastfmpass

Changed in version 3.0.0: Used as apiSecret for API 2.0

<password>pass</password>

Your last.fm password or the apiSecret for API version 2.0.

lastfm sessionkey
Type: String
Required: True
Default: sessionKey

Added in version 3.0.0: Support for API 2.0

<sessionkey>sessionKeyFromWeb</sessionkey>

After the user has authorized on last.fm web page, the session key can be retrieved from the console under gerbera --init-lastfm.

Your last.fm password or the apiSecret for API version 2.0.

lastfm auth-url
Type: String
Required: True
Default: https://www.last.fm/api/auth/

Added in version 3.0.0: Support for API 2.0

<auth-url>https://www.libre.fm/api/auth/</auth-url>

URL to redirect the user to for login.

lastfm scrobble-url
Type: String
Required: True
Default: https://ws.audioscrobbler.com/2.0/

Added in version 3.0.0: Support for API 2.0

<scrobble-url>https://ws.audioscrobbler.com/2.1/</scrobble-url>

URL to send the scrobbles to.

1.6.1.3 Mark Played Items

mark-played-items
Type: Section
Required: False
<mark-played-items enabled="yes" suppress-cds-updates="yes">

The attributes of the tag have the following meaning:

mark-played-items enabled
Type: Boolean
Required: False
Default: no
enabled="yes"

Enables or disables the marking of played items, set to yes to enable the feature.

suppress-cds-updates
Type: Boolean
Required: False
Default: yes
suppress-cds-updates="no"

This is an advanced feature, leave the default setting if unsure. Usually, when items are modified the system sends out container updates as specified in the Content Directory Service. This notifies the player that data in a particular container has changed, players that support CDS updates will rebrowse the container and refresh the view. However, in this case we probably do not want it (this actually depends on the particular player implementation). For example, if the system updates the list of currently playing items, the player could interrupt playback and rebrowse the current container - clearly an unwanted behaviour. Because of this, Gerbera provides an option to suppress and not send out container updates - only for the case where the item is marked as “played”. In order to see the changes you will have to get out of the current container and enter it again - then the view on your player should get updated.

Note:

Some players (i.e. PS3) cache a lot of data and do not react to container updates, for those players it may be necessary to leave the server view or restart the player in order to update content (same as when adding new data).

The following tag defines how played items should be marked:

mark-played-items string
Type: String
Required: False
Default: "* "
<string mode="prepend"># </string>

Specifies what string should be appended or prepended to the title of the object that will be marked as “played”.

mark-played-items node
Type: Enum (prepend|append)
Required: False
Default: prepend
mode="append"

Specifies how a string should be added to the object’s title, allowed values are “append” and “prepend”.

mark
Type: Section
Required: False
<mark>

This subsection allows to list which type of content should get marked. It could also be used with audio and image content, but otherwise it’s probably useless. Thefore Gerbera specifies only three supported types that can get marked:

content
Type: String
Required: True
<content>audio</content>
<content>video</content>
<content>image</content>

You can specify any combination of the above tags to mark the items you want.