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

PlayPauseMediaControl

class PlayPauseMediaControl(context: MediaControlContext) : ToggleActionMediaControl

Control to switch between paused and playing state.

Constructors

fun PlayPauseMediaControl(context: MediaControlContext)

Types

Factory

object Factory : MediaControlFactory

Creates a PlayPauseMediaControl, to allow switching between paused and playing state.

Properties

actionType

open override 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.

drawable

open override val drawable: LiveData<DrawableResolver>

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

isActivated

open override val isActivated: LiveData<Boolean>

The action is activated when one or more activatedAction are present in the context.

isAvailable

open override val isAvailable: LiveData<Boolean>

The action is available if activatedAction or activateAction are present in the context.

isVisible

open override val isVisible: LiveData<Boolean>

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

tag

open override 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.

Inherited properties

text

open val text: LiveData<StringResolver>

Textual description of the control.

Inherited functions

asIconTtButtonViewModel

open fun asIconTtButtonViewModel(): LiveData<TtButtonViewModel>

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

launch

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.

toAction

open override 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.