appsuite_media_api_common_frontend/com.tomtom.ivi.appsuite.media.api.common.frontend/MediaTaskPanel

MediaTaskPanel

abstract class MediaTaskPanel( val mediaFrontendContext: MediaFrontendContext, val sourceId: SourceId?, initialMediaItem: IviMediaItem?) : TaskPanel

Base panel type for media-related Frontends.

This type of TaskPanel contains a MediaFrontendContext to hold relevant data for media.

Media task panels may be tied to a certain source, for example to browse its content, or not, such as a generic media settings panel. When a media task panel is made to operate on or with a media source, it will have a non-nullsourceId, and null otherwise.

mutableMediaItem can be used to store additional state by adding Bundle fields to it, since the framework will re-create panels with the same mutableMediaItem; for example, to keep track of the activation state of a feature when closing and reopening the stock media frontend.

Note: The mediaItem is used by the stock media frontend to display navigation breadcrumbs.

Constructors

MediaTaskPanel

fun MediaTaskPanel( mediaFrontendContext: MediaFrontendContext, sourceId: SourceId?, initialMediaItem: IviMediaItem?)

Properties

mediaFrontendContext

val mediaFrontendContext: MediaFrontendContext

Context in which the panel is to be opened. Most decisions should be taken using this state, such as using the panel mapping or the stack to decide which kind of panel to open next.

mediaItem