Android APIs
public final class

MediaController.TransportControls

extends Object
java.lang.Object
   ↳ android.media.session.MediaController.TransportControls

Class Overview

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

Summary

Public Methods
void fastForward()
Start fast forwarding.
void pause()
Request that the player pause its playback and stay at its current position.
void play()
Request that the player start its playback at its current position.
void playFromMediaId(String mediaId, Bundle extras)
Request that the player start playback for a specific Uri.
void playFromSearch(String query, Bundle extras)
Request that the player start playback for a specific search query.
void rewind()
Start rewinding.
void seekTo(long pos)
Move to a new location in the media stream.
void sendCustomAction(String action, Bundle args)
Send the id and args from a custom action back for the MediaSession to perform.
void sendCustomAction(PlaybackState.CustomAction customAction, Bundle args)
Send a custom action back for the MediaSession to perform.
void setRating(Rating rating)
Rate the current content.
void skipToNext()
Skip to the next item.
void skipToPrevious()
Skip to the previous item.
void skipToQueueItem(long id)
Play an item with a specific id in the play queue.
void stop()
Request that the player stop its playback; it may clear its state in whatever way is appropriate.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void fastForward ()

Added in API level 21

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

public void pause ()

Added in API level 21

Request that the player pause its playback and stay at its current position.

public void play ()

Added in API level 21

Request that the player start its playback at its current position.

public void playFromMediaId (String mediaId, Bundle extras)

Added in API level 21

Request that the player start playback for a specific Uri.

Parameters
mediaId The uri of the requested media.
extras Optional extras that can include extra information about the media item to be played.

public void playFromSearch (String query, Bundle extras)

Added in API level 21

Request that the player start playback for a specific search query. An empty or null query should be treated as a request to play any music.

Parameters
query The search query.
extras Optional extras that can include extra information about the query.

public void rewind ()

Added in API level 21

Start rewinding. If playback is already rewinding this may increase the rate.

public void seekTo (long pos)

Added in API level 21

Move to a new location in the media stream.

Parameters
pos Position to move to, in milliseconds.

public void sendCustomAction (String action, Bundle args)

Added in API level 21

Send the id and args from a custom action back for the MediaSession to perform.

Parameters
action The action identifier of the PlaybackState.CustomAction as specified by the MediaSession.
args Optional arguments to supply to the MediaSession for this custom action.

public void sendCustomAction (PlaybackState.CustomAction customAction, Bundle args)

Added in API level 21

Send a custom action back for the MediaSession to perform.

Parameters
customAction The action to perform.
args Optional arguments to supply to the MediaSession for this custom action.

public void setRating (Rating rating)

Added in API level 21

Rate the current content. This will cause the rating to be set for the current user. The Rating type must match the type returned by getRatingType().

Parameters
rating The rating to set for the current content

public void skipToNext ()

Added in API level 21

Skip to the next item.

public void skipToPrevious ()

Added in API level 21

Skip to the previous item.

public void skipToQueueItem (long id)

Added in API level 21

Play an item with a specific id in the play queue. If you specify an id that is not in the play queue, the behavior is undefined.

public void stop ()

Added in API level 21

Request that the player stop its playback; it may clear its state in whatever way is appropriate.