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

ToggleMediaControl

interface ToggleMediaControl : MediaControl
Content copied to clipboard

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.

Properties

Link copied to clipboard
open override val actionType: TtButton.ActionType
Content copied to clipboard

Toggle-based action type.

Link copied to clipboard
abstract val isActivated: LiveData<Boolean>
Content copied to clipboard

Whether the associated action is currently switched on.

Inherited properties

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

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

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

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

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

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?
Content copied to clipboard

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>
Content copied to clipboard

Textual description of the control.

Inherited functions

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

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

Link copied to clipboard
abstract fun launch(): Boolean
Content copied to clipboard

Perform the action.

Inheritors

Link copied to clipboard
Link copied to clipboard