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

Package-level declarations

Media controls; the classes in this package implement the concept of #media-controls.

Types

ActionLaunchCall

@IviExperimental(reasons = [])

typealias ActionLaunchCall = (Action) -> Boolean

Type alias for the callback to invoke when a MediaControl's Action is launched.

ActionMediaControl

@IviExperimental(reasons = [])

abstract class ActionMediaControl(context: MediaControlContext) : MediaControl

A MediaControl which can be performed on active media.

CompositeMediaControl

@IviExperimental(reasons = [])

class CompositeMediaControl(controls: List<MediaControl>) : ToggleMediaControl

Continuously picks the first visible media control from the given controls list, and delegates all calls to it. If there is no visible control, it will delegate to the last control in the list.

InvisibleControlFactory

@IviExperimental(reasons = [])

object InvisibleControlFactory : MediaControlFactory

Factory that creates an invisible MediaControl.

LiveSourceId

@IviExperimental(reasons = [])

typealias LiveSourceId = LiveData<SourceId?>

Type alias for a LiveData with the current media source, if one is playing.

MediaControl

@IviExperimental(reasons = [])

interface MediaControl

A visual control for a media-related command. It can be used anywhere the user can interact with active media.

MediaControlContext

@IviExperimental(reasons = [])

class MediaControlContext(val source: LiveSourceId, val playbackState: LiveData<IviPlaybackState>, val activeMediaItem: LiveData<IviMediaItem?>, val actions: LiveDataActionList, val actionLauncher: ActionLaunchCall, val coroutineScope: CoroutineScope)

Provides access to contextual information for MediaControls. Actual use of the information provided by MediaControlContext is not mandatory.

MediaControlFactory

@IviExperimental(reasons = [])

interface MediaControlFactory

Creates MediaControls within the given MediaControlContext.

MediaControlPriority

@IviExperimental(reasons = [])

enum MediaControlPriority : Enum<MediaControlPriority>

Priority of a MediaControl. When room for controls is limited, their priority is used to determine which controls are displayed.

MultipleActionMediaControl

@IviExperimental(reasons = [])

abstract class MultipleActionMediaControl(context: MediaControlContext) : ActionMediaControl

An ActionMediaControl that cycles between multiple states.

SingleActionMediaControl

@IviExperimental(reasons = [])

abstract class SingleActionMediaControl(context: MediaControlContext) : ActionMediaControl

An ActionMediaControl always resulting in one single Action which can be performed on active media.

ToggleActionMediaControl

@IviExperimental(reasons = [])

abstract class ToggleActionMediaControl(context: MediaControlContext) : ActionMediaControl, ToggleMediaControl

An ActionMediaControl with two states: activated and deactivated.

ToggleMediaControl

@IviExperimental(reasons = [])

interface ToggleMediaControl : MediaControl

A MediaControl with two states: activated and deactivated. These will be automatically represented to the end-user by highlighting the given drawable when isActivated is true.

Functions

asMediaControlContext

@IviExperimental(reasons = [])

fun MediaServiceApi.asMediaControlContext(viewModelScope: CoroutineScope): MediaControlContext

Use a MediaServiceApi to obtain a MediaControlContext to use on MediaControls. The given viewModelScope should be attached to a LifecycleViewModel: it is necessary for MediaControls to perform asynchronous operations.