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

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

Media view models; these classes are used as view models for data binding in the media frontend views.

Types

class MediaButtonsConfiguration( val replacedStandardControls: Map<StandardMediaControls, MediaControlFactory>, val customControls: List<MediaControlFactory>, val primaryMediaButtonsLimit: Int, val secondaryMediaButtonsLimit: Int)

Configuration of media controls given to a MediaButtonsViewModel. Could be created from a MediaControlPolicy.

MediaButtonsViewModel

@IviExperimental(reasons = [])

class MediaButtonsViewModel(mediaControlContext: MediaControlContext, mediaButtonsConfiguration: LiveData<MediaButtonsConfiguration>)

ViewModel for media buttons that can be used directly in views where the playback controls are displayed. Provides lists of TtButtonViewModel for the primary and secondary media controls defined by MediaButtonsConfiguration.

MediaPlaybackParameters

@IviExperimental(reasons = [])

data class MediaPlaybackParameters( val timeInfo: LiveData<MediaPlaybackTimeInfo?>, val playbackState: LiveData<IviPlaybackState>, val activeSource: LiveData<SourceInfo?>, val activeMediaItem: LiveData<IviMediaItem?>, val activeQueue: LiveData<List<IviMediaItem>>, val availableActions: LiveDataActionList, val isBuffering: LiveData<Boolean>, launchActionCallBack: ActionLaunchCall)

Media playback parameters given to the MediaPlaybackViewModel.

MediaPlaybackViewModel

@IviExperimental(reasons = [])

class MediaPlaybackViewModel( mediaConfiguration: MediaConfiguration, mediaPlaybackParameters: MediaPlaybackParameters, viewModelCoroutineScope: CoroutineScope, sourceAttributionFormat: SourceAttributionFormat = SourceAttributionFormat())

View model for playback information about the media currently being played, such as duration, elapsed time, title, artist, album, etc.

TouchTrackViewModel

@IviExperimental(reasons = [])

class TouchTrackViewModel( mediaDuration: LiveData<Duration>, isSeekActionSupported: LiveData<Boolean>, viewModelCoroutineScope: CoroutineScope, launchSeekAction: (SeekAction) -> Unit)

View model for a touch track control used in MediaPlaybackViewModel.

Functions

asMediaPlaybackParameters

@IviExperimental(reasons = [])

fun MediaServiceApi.asMediaPlaybackParameters(mediaConfiguration: MediaConfiguration): MediaPlaybackParameters

Use a MediaServiceApi to obtain the MediaPlaybackParameters necessary for a MediaPlaybackViewModel.