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

Package com.tomtom.ivi.appsuite.media.api.common.frontend

Media source configuration and panel types; this package contains all classes to configure how the content from a media source is displayed, as well as the classes to use to create new panels to realize new user experiences for specific media sources.

Types

MediaConfiguration

@IviExperimental(reasons = [])

data class MediaConfiguration

Configures the behavior of the media frontend by providing a PolicyProvider for SourceId.

MediaFrontendContext

@IviExperimental(reasons = [])

class MediaFrontendContext( val frontendContext: FrontendContext, val panelStack: LiveData<out List<MediaTaskPanel>>, val mediaConfiguration: MediaConfiguration, val mediaService: MediaServiceApi, val panels: MediaFrontendContext.Panels, 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.

MediaPolicyFrontendExtension

@IviExperimental(reasons = [])

class MediaPolicyFrontendExtension( val sourcePackageName: String?, val sourceClassName: String? = null, val policyProvider: PolicyProvider) : FrontendExtension

Frontend extension for the media frontend that configures the frontend to use policyProvider when a policy is required for a media source with sourcePackageName. Policies offer a way to customize the user interface for a specific source, like adjusting browse source, login and settings user flows through the UserFlowPolicy.

MediaTaskPanel

@IviExperimental(reasons = [])

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

Base panel type for media-related Frontends.

Properties

fallbackMediaPolicyFrontendExtension

@IviInternal

val fallbackMediaPolicyFrontendExtension: FrontendExtension

A frontend extension for the media frontend, for sources where no specific MediaPolicyFrontendExtension is configured. For those sources, a PolicyProvider is provided with all default policies.

Functions

asMediaConfiguration

@IviExperimental(reasons = [])

fun Collection<MediaPolicyFrontendExtension>.asMediaConfiguration(): MediaConfiguration

Combines the collection of MediaPolicyFrontendExtensions into a MediaConfiguration.

getSettingsIntent

@IviExperimental(reasons = [])

fun SourceId.getSettingsIntent(context: Context): Intent?

Gets the settings Activity provided by the media source. Returns null if no settings Activity exists in the media source.