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

MediaFrontendContext

class MediaFrontendContext(val frontendContext: FrontendContext, val panelStack: LiveData<out List<MediaTaskPanel>>, val mediaConfiguration: MediaConfiguration, val mediaService: MediaServiceApi, val mediaFrontendNavigation: MediaFrontendContext.MediaFrontendNavigation, val errorCallback: ErrorCallback)

Entry point for Media related panels to communicate with their frontend and the rest of the system. Should be created by the Frontend.

All available static configuration values are accessible through frontendContext, in FrontendContext.staticConfigurationProvider.

Examples: All example apps can be found in the Android Studio project inside the TomTom Digital Cockpit SDK.

How to set up a custom mini player using static configuration: examples/media/miniplayer/

Parameters

frontendContext

Base FrontendContext. Used to access IVI services.

panelStack

Current stack of panels for the Frontend. Usable to determine which panels are open. The Frontend is responsible for observing this variable, to ensure panels always have access to an updated list.

mediaConfiguration

The configuration of the Frontend. This includes the mapping of SourceId to panel factories, and which MediaControls to use.

mediaService

Reference to the MediaServiceApi based on the MediaService IVI service interface, for ease of access.

mediaFrontendNavigation

Interface to navigate within the media frontend.

errorCallback

Callback container to report media browsing errors to the frontend; necessary since only the frontend can best decide on how to respond to error conditions in different situations.

Constructors

MediaFrontendContext

constructor(frontendContext: FrontendContext, panelStack: LiveData<out List<MediaTaskPanel>>, mediaConfiguration: MediaConfiguration, mediaService: MediaServiceApi, mediaFrontendNavigation: MediaFrontendContext.MediaFrontendNavigation, errorCallback: ErrorCallback)

Types

MediaFrontendNavigation

interface MediaFrontendNavigation

Interface to navigate within the media Frontend, such as opening MediaTaskPanels and performing custom user flows provided by PolicyProvider.userFlowPolicy.

Properties

errorCallback

val errorCallback: ErrorCallback

frontendContext

val frontendContext: FrontendContext

mediaConfiguration

val mediaConfiguration: MediaConfiguration

mediaFrontendNavigation

val mediaFrontendNavigation: MediaFrontendContext.MediaFrontendNavigation

mediaService

val mediaService: MediaServiceApi

panelStack

val panelStack: LiveData<out List<MediaTaskPanel>>