TransportControls

Kotlin |Java

abstract class TransportControls

kotlin.Any
↳	android.support.v4.media.session.MediaControllerCompat.TransportControls

Interface for controlling media playback on a session. This allows an app to send media transport commands to the session.

Summary

Constants
static String	`EXTRA_LEGACY_STREAM_TYPE` Used as an integer extra field in `playFromMediaId(String, Bundle)` or `prepareFromMediaId(String, Bundle)` to indicate the stream type to be used by the media player when playing or preparing the specified media id.

Public methods
abstract Unit	`fastForward()` Starts fast forwarding.
abstract Unit	`pause()` Request that the player pause its playback and stay at its current position.
abstract Unit	`play()` Request that the player start its playback at its current position.
abstract Unit	`playFromMediaId(mediaId: String!, extras: Bundle!)` Request that the player start playback for a specific `Uri`.
abstract Unit	`playFromSearch(query: String!, extras: Bundle!)` Request that the player start playback for a specific search query.
abstract Unit	`playFromUri(uri: Uri!, extras: Bundle!)` Request that the player start playback for a specific `Uri`.
abstract Unit	`prepare()` Request that the player prepare for playback.
abstract Unit	`prepareFromMediaId(mediaId: String!, extras: Bundle!)` Request that the player prepare playback for a specific media id.
abstract Unit	`prepareFromSearch(query: String!, extras: Bundle!)` Request that the player prepare playback for a specific search query.
abstract Unit	`prepareFromUri(uri: Uri!, extras: Bundle!)` Request that the player prepare playback for a specific `Uri`.
abstract Unit	`rewind()` Starts rewinding.
abstract Unit	`seekTo(pos: Long)` Moves to a new location in the media stream.
abstract Unit	`sendCustomAction(customAction: PlaybackStateCompat.CustomAction!, args: Bundle!)` Sends a custom action for the `MediaSessionCompat` to perform.
abstract Unit	`sendCustomAction(action: String!, args: Bundle!)` Sends the id and args from a custom action for the `MediaSessionCompat` to perform.
abstract Unit	`setCaptioningEnabled(enabled: Boolean)` Enables/disables captioning for this session.
abstract Unit	`setRating(rating: RatingCompat!)` Rates the current content.
abstract Unit	`setRating(rating: RatingCompat!, extras: Bundle!)` Rates a media item.
abstract Unit	`setRepeatMode(repeatMode: Int)` Sets the repeat mode for this session.
abstract Unit	`setShuffleMode(shuffleMode: Int)` Sets the shuffle mode for this session.
abstract Unit	`skipToNext()` Skips to the next item.
abstract Unit	`skipToPrevious()` Skips to the previous item.
abstract Unit	`skipToQueueItem(id: Long)` Plays an item with a specific id in the play queue.
abstract Unit	`stop()` Request that the player stop its playback; it may clear its state in whatever way is appropriate.

Constants

EXTRA_LEGACY_STREAM_TYPE

static val EXTRA_LEGACY_STREAM_TYPE: String

Used as an integer extra field in playFromMediaId(String, Bundle) or prepareFromMediaId(String, Bundle) to indicate the stream type to be used by the media player when playing or preparing the specified media id. See AudioManager for a list of stream types.

Value: "android.media.session.extra.LEGACY_STREAM_TYPE"

Public methods

fastForward

abstract fun fastForward(): Unit

Starts fast forwarding. If playback is already fast forwarding this may increase the rate.