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

ActionMediaControl

@IviExperimental(reasons = [])
abstract class ActionMediaControl(context: MediaControlContext) : MediaControl

A MediaControl which can be performed on active media.

When launch is invoked on an ActionMediaControl, it is converted to a suitable Action reflecting its current state.

The MediaControlContext gives access to the current state of media playback and hides the link to the media service implementation.

Parameters

context

The context in which this control operates.

See also

Inheritors

Constructors

Link copied to clipboard
constructor(context: MediaControlContext)

Inherited properties

Link copied to clipboard
open val actionType: TtButton.ActionType

The type of the control, which is used by TtButton to apply one of the predefined styles. May be overridden in subclasses in order to apply a specialized style. TtButton.ActionType.TERTIARY is used by default as the most neutral option.

Link copied to clipboard
abstract val drawable: LiveData<DrawableResolver?>

The icon of the control, which is used to represent the control to the user.

Link copied to clipboard
abstract val isAvailable: LiveData<Boolean>

Whether or not it is possible to launch the action right now.

Link copied to clipboard
open val isVisible: LiveData<Boolean>

Whether the control is visible. This can be used to show the control as disabled. Defaults to isAvailable.

Link copied to clipboard
open val tag: Int?

Int resource ID to tag this MediaControl with. The tag can be used in tests to refer to one or more controls with the same tag.

Link copied to clipboard
open val text: LiveData<StringResolver>

Textual description of the control.

Functions

Link copied to clipboard
open override fun launch(): Boolean

Launch this action using the current action context. The Action, determined by toAction, is performed using the current context. If the action is not currently available, the operation will fail.

Link copied to clipboard
abstract fun toAction(): Action

Convert this ActionMediaControl to an Action to launch it. The IVI media service uses Action objects to issue commands to media sources.

Inherited functions

Link copied to clipboard
open fun asIconTtButtonViewModel(): LiveData<TtButtonViewModel>

Creates a TtButtonViewModel representation of this MediaControl as an icon button. This implies only the drawable is included.