appsuite_media_api_common_core/com.tomtom.ivi.appsuite.media.api.common.core.actions.standard

Package com.tomtom.ivi.appsuite.media.api.common.core.actions.standard

Standard Action types are provided to simplify use of media-related operations that the user commonly performs, such as skipping between tracks (SkipForwardAction) or pausing (PauseAction).

Types

FastForwardAction

@IviExperimental(reasons = [])

class FastForwardAction : Action

Request the current source to start fast forwarding.

PauseAction

@IviExperimental(reasons = [])

class PauseAction : Action

Request the current source to pause its playback and stay at its current position.

PlayAction

@IviExperimental(reasons = [])

class PlayAction : Action

Request the current source to start its playback at its current position.

PlayMediaIdAction

@IviExperimental(reasons = [])

class PlayMediaIdAction(val mediaId: String) : Action

Request the current source to start playback of a specific mediaId.

PlayMediaIdFromSourceAction

@IviExperimental(reasons = [])

class PlayMediaIdFromSourceAction(val sourceId: SourceId, val mediaId: String) : Action

Request to start playback of a specific mediaId from a source with ID sourceId.

RepeatMode

@IviExperimental(reasons = [])

enum RepeatMode : Enum<RepeatMode>

Playback repeat mode. This is used to send and receive repeat mode Actions.

RewindAction

@IviExperimental(reasons = [])

class RewindAction : Action

Request the current source to start rewinding.

SeekAction

@IviExperimental(reasons = [])

class SeekAction(val position: Duration) : Action

Request the current source to seek to a specific position in the current media.

SetActiveSourceAction

@IviExperimental(reasons = [])

class SetActiveSourceAction(val sourceId: SourceId) : Action

Request to make a specific source active. The action will be ignored if another source is playing, and if the requested source has nothing to play.

SetRatingAction

@IviExperimental(reasons = [])

class SetRatingAction(val rating: IviMediaRating) : Action

Request the current source to set the rating for the current item.

SetRepeatModeAction

@IviExperimental(reasons = [])

class SetRepeatModeAction(val mode: RepeatMode) : Action

Request the current source to change the repeat mode for the current media or queue.

SetShuffleModeAction

@IviExperimental(reasons = [])

class SetShuffleModeAction(val mode: ShuffleMode) : Action

Request the current source to play the current queue in a specific shuffling mode.

ShuffleMode

@IviExperimental(reasons = [])

enum ShuffleMode : Enum<ShuffleMode>

Playback order mode. This is used to send and receive shuffle mode Actions.

SkipBackwardAction

@IviExperimental(reasons = [])

class SkipBackwardAction : Action

Request the current source to skip to the previous item.

SkipForwardAction

@IviExperimental(reasons = [])

class SkipForwardAction : Action

Request the current source to skip to the next item.

SkipToQueueItemAction

@IviExperimental(reasons = [])

class SkipToQueueItemAction(val queuePosition: Int) : Action

Request the current source to play an item at position queuePosition in its play queue.

StandardActionId

@IviExperimental(reasons = [])

enum StandardActionId : Enum<StandardActionId> , ActionId

Common Action IDs recognized by the stock IVI media service.

StopAction

@IviExperimental(reasons = [])

class StopAction : Action

Request the current source to stop playback.