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

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

Media item policies; these classes are used to customize the media frontend for a specific source.

Types

A user flow performed when the user requests to browse a media source.

class DefaultMediaControlPolicy : MediaControlPolicy

The default policy for configuring media controls. It does not add any customControls, nor does it override any controls in replacedStandardControls.

DefaultMediaItemComparisonPolicy

class DefaultMediaItemComparisonPolicy : Function2<first: IviMediaItem, second: IviMediaItem?, Boolean>

Default implementation of MediaItemComparisonPolicy.

DefaultMediaItemMappingPolicy

class DefaultMediaItemMappingPolicy : Function1<item: IviMediaItem, IviMediaItem>

Default implementation of MediaItemMappingPolicy.

DefaultMediaSourceAttributionPolicy

class DefaultMediaSourceAttributionPolicy : MediaSourceAttributionPolicy

Default implementation of MediaSourceAttributionPolicy.

DefaultSourceDefinitionPolicy

class DefaultSourceDefinitionPolicy : SourceDefinitionPolicy

The default general source definition policy.

IntentUserFlow

fun interface IntentUserFlow

A user flow performed when the source provides an Intent to launch an external flow.

IsPlaylistItemPolicy

typealias IsPlaylistItemPolicy = (mediaItem: IviMediaItem) -> Boolean

Determines if the media item represents a playlist.

This policy can be used to determine whether to open the playlist panel for a given IviMediaItem.

MediaControlPolicy

interface MediaControlPolicy

The policy that configures the available media controls. A media control is a visual control for a media-related command; see MediaControl.

MediaControlsDisplayLimit

data class MediaControlsDisplayLimit( val primaryControlsSmallLimit: Int = 3, val secondaryControlsSmallLimit: Int = 2, val primaryControlsMediumLimit: Int = 3, val secondaryControlsMediumLimit: Int = 3, val primaryControlsLargeLimit: Int = 4, val secondaryControlsLargeLimit: Int = 5)

The maximum numbers of media controls to display based on the available space.

MediaItemComparisonPolicy

typealias MediaItemComparisonPolicy = (first: IviMediaItem, second: IviMediaItem?) -> Boolean

Returns true if the two IviMediaItems represent the same media object; false otherwise.

MediaItemMappingPolicy

typealias MediaItemMappingPolicy = (item: IviMediaItem) -> IviMediaItem

Maps IviMediaItem into a different IviMediaItem by changing its fields as needed.

This is used to improve how the content of IviMediaItems is displayed to the user.

For example, if the media source places both song title and artist in the IviMediaItem.title field, this can be used to split it into IviMediaItem.title and IviMediaItem.artist.

MediaSourceAttributionPolicy

interface MediaSourceAttributionPolicy

A policy for media source attributes customization.

PolicyProvider

data class PolicyProvider( val compareItemsPolicy: MediaItemComparisonPolicy = DefaultMediaItemComparisonPolicy(), val itemMappingPolicy: MediaItemMappingPolicy = DefaultMediaItemMappingPolicy(), val sourceAttributionPolicy: MediaSourceAttributionPolicy = DefaultMediaSourceAttributionPolicy(), val mediaControlPolicy: MediaControlPolicy = DefaultMediaControlPolicy(), val isPlaylistItemPolicy: IsPlaylistItemPolicy? = null, val userFlowPolicy: UserFlowPolicy = UserFlowPolicy(), val sourceDefinitionPolicy: SourceDefinitionPolicy = DefaultSourceDefinitionPolicy())

A container of customization policies for a media source.

SourceAttributionFormat

data class SourceAttributionFormat( val preferWordMark: Boolean = false, val preferMonochrome: Boolean = false, val preferSimplified: Boolean = false, val preferPresentation: Boolean = false)

Specification of what format source attribution is requested in.

SourceDefinitionPolicy

interface SourceDefinitionPolicy

Policy to define general aspects of the media source.

SourceStyle

data class SourceStyle(val accentColor: ColorResolver?) : Parcelable

Style for a media source. Provides branding colors.

UserFlowPolicy

data class UserFlowPolicy( val loginUserFlow: IntentUserFlow? = null, val browseSourceUserFlow: BrowseSourceUserFlow? = null, val settingsUserFlow: IntentUserFlow? = null)

A policy to override the default user flow behavior for a media source.

UserFlowResult

sealed class UserFlowResult

A result returned by an user flow. Can be used to notify the user.