Configure the Media Plugins

The off-the-shelf media plugin comes with default configuration. This configuration provides a default behavior, such as showing a mini player when music is playing. This configuration is based on the configuration-framework and can be changed if necessary. This guide explains this procedure.

If you want to configure the media frontend plugin for specific media sources, you can follow this guide: How to customize a media source.

Media plugin default configuration

The media plugin default configuration is defined as a resource file that contains configuration keys and their values. The following keys and values are defined in the media plugin:

examples/media/miniplayer/src/main/res/values/example-media-configuration.xml

1<resources>
2 <!-- Indicates whether the media frontend has a mini player or not; `true` by default. -->
3 <bool name="hasMiniPlayerConfigKey">true</bool>
4</resources>

Change the media plugin configuration

The media plugin default configuration can be changed by adding a custom configuration resource file in your application. The custom configuration overrides the default values with the ones provided. For an example, see the template/app/res/value/ttivi-media-configuration.xml file.

Configuring the mini player

When audio is playing, a mini player is shown on the home screen.

If you don't want to use the mini player provided with the off-the-shelf media plugin, or you want to implement your own frontend plugin for the mini player, you can configure it by setting the hasMiniPlayerConfigKey to false:

<bool name="hasMiniPlayerConfigKey">false</bool>

Configuring the dashboard shortcut button

The dashboard shortcut button is shown in the top right corner of the media screen during browsing the media sources. It quickly returns the user to the dashboard.

If you want to hide the dashboard shortcut button within the off-the-shelf media plugin, you can configure it by setting the hasDashboardButtonConfigKey to false:

<bool name="hasDashboardButtonConfigKey">false</bool>

Configuring the collection panel play/pause button

The collection panel contains a button to play or pause the entire media collection. By default this button shows a text: button

If you want to change it and show an icon instead of the text, you can configure it by setting the useTextForCollectionPlayPauseButtonConfigKey to false:

<bool name="useTextForCollectionPlayPauseButtonConfigKey">false</bool>
button