Configuration file for mm-renderer

The multimedia renderer configuration file specifies the plugins to load and the default values for plugin parameters. The path of this file is /etc/mm/mm-renderer.conf, and the file must be defined before you start mm-renderer.

A single configuration file is used for all instances of mm-renderer. Thus, all running instances of the service have the same plugins available, with the same default parameters.

Note: After starting, mm-renderer does not support "on-the-fly" configuration changes. To modify the configuration, you must shut down mm-renderer, update its configuration file, and restart the service.

The configuration file is a text file that gets parsed by mm-renderer to load and configure the plugins used in playback. Blank lines are ignored, as is any leading or trailing white space. Lines specifying parameters are in the form key=value. Unknown parameter types are ignored and so they can be made into comments. For example, you can enter My Comment Goes Here on a line and mm-renderer will consider it to be an unsupported parameter and so will ignore that line when parsing the file. However, we recommend using the number sign ('#') to clearly indicate the start of any comments.

The file is divided into sections, each of which configures one plugin. Sections begin with the [plugin] keyword on its own line. The name of the plugin library file is specified on the next line, with the dll key. Default values to any parameters supported by the plugin may be specified on the lines that follow.

Suppose you want to use the audio/video player routing plugin, and override the default status update interval of 1000 ms with an update interval of half that time. You would then write a section in the configuration file as follows:

# Configure the audio/video player routing plugin
[plugin]
dll=mmr-mmf-routing.so
# Set a half-second (500ms) interval between updates
updateinterval=500

Any of the default values set in the configuration file can be overridden by client applications by setting the parameter through the API.

The following plugins and associated parameters are supported:

MMF audio recorder routing plugin

Library file: mmr-mmfrip-routing.so

There are no parameters for this plugin.

Playlist engine plugin

Library file: mmr-playlist-engine.so

This plugin supports the "playlist" and "autolist" input types, and has these parameters:

queue_max: The maximum number of tracks in the queue window.
tracks_max: The maximum number of tracks to keep open.

DLNA playlist engine plugin

Library file: mmr-dlnaplaylist-engine.so

This plugin supports the "dlnatrack" and "dlnaplaylist" input types. There are no parameters for this plugin.

Single-track engine plugin

Library file: mmr-track-engine.so

This plugin supports the "track" input type. There are no parameters for this plugin.

MMF audio/video player routing plugin

Library file: mmr-mmf-routing.so

This plugin has the following parameters:

updateinterval: The interval between status updates, in milliseconds.

BB OS audio management plugin

Library file: mmr-audiomgmt-plugin.so

This plugin supports the audio: output URL, and has these parameters:

writer: The filter to use as the audio writer for audio: outputs.

BB OS network connection monitoring plugin

Library file: mmr-netmgmt-plugin.so

There are no parameters for this plugin.