MediaControllerCompat.TransportControls

public abstract class 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 final String
EXTRA_LEGACY_STREAM_TYPE = "android.media.session.extra.LEGACY_STREAM_TYPE"

This field is deprecated.

Use TRANSPORT_CONTROLS_EXTRAS_KEY_LEGACY_STREAM_TYPE instead.

Public methods

abstract void

Starts fast forwarding.

abstract void

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

abstract void

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

abstract void
playFromMediaId(String mediaId, Bundle extras)

Request that the player start playback for a specific media id.

abstract void
playFromSearch(String query, Bundle extras)

Request that the player start playback for a specific search query.

abstract void
playFromUri(Uri uri, Bundle extras)

Request that the player start playback for a specific Uri.

abstract void

Request that the player prepare for playback.

abstract void
prepareFromMediaId(String mediaId, Bundle extras)

Request that the player prepare playback for a specific media id.

abstract void
prepareFromSearch(String query, Bundle extras)

Request that the player prepare playback for a specific search query.

abstract void
prepareFromUri(Uri uri, Bundle extras)

Request that the player prepare playback for a specific Uri.

abstract void

Starts rewinding.

abstract void
seekTo(long pos)

Moves to a new location in the media stream.

abstract void
sendCustomAction(String action, Bundle args)

Sends the id and args from a custom action for the MediaSessionCompat to perform.

abstract void
sendCustomAction(
    PlaybackStateCompat.CustomAction customAction,
    Bundle args
)

Sends a custom action for the MediaSessionCompat to perform.

abstract void
setCaptioningEnabled(boolean enabled)

Enables/disables captioning for this session.

void
setPlaybackSpeed(float speed)

Sets the playback speed.

abstract void

Rates the current content.

abstract void
setRating(RatingCompat rating, Bundle extras)

Rates a media item.

abstract void
setRepeatMode(int repeatMode)

Sets the repeat mode for this session.

abstract void
setShuffleMode(int shuffleMode)

Sets the shuffle mode for this session.

abstract void

Skips to the next item.

abstract void

Skips to the previous item.

abstract void
skipToQueueItem(long id)

Plays an item with a specific id in the play queue.

abstract void

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

Constants

EXTRA_LEGACY_STREAM_TYPE

Added in 1.1.0
Deprecated in 1.4.0
public static final String EXTRA_LEGACY_STREAM_TYPE = "android.media.session.extra.LEGACY_STREAM_TYPE"

Used as an integer extra field in playFromMediaId or prepareFromMediaId 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.

Public methods

fastForward

Added in 1.1.0
public abstract void fastForward()

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

pause

Added in 1.1.0
public abstract void pause()

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

play

Added in 1.1.0
public abstract void play()

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

playFromMediaId

Added in 1.1.0
public abstract void playFromMediaId(String mediaId, Bundle extras)

Request that the player start playback for a specific media id.

Parameters
String mediaId

The id of the requested media.

Bundle extras

Optional extras that can include extra information about the media item to be played.

playFromSearch

Added in 1.1.0
public abstract void playFromSearch(String query, Bundle extras)

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
String query

The search query.

Bundle extras

Optional extras that can include extra information about the query.

playFromUri

Added in 1.1.0
public abstract void playFromUri(Uri uri, Bundle extras)

Request that the player start playback for a specific Uri.

Parameters
Uri uri

The URI of the requested media.

Bundle extras

Optional extras that can include extra information about the media item to be played.

prepare

Added in 1.1.0
public abstract void prepare()

Request that the player prepare for playback. This can decrease the time it takes to start playback when a play command is received. Preparation is not required. You can call play without calling this method beforehand.

prepareFromMediaId

Added in 1.1.0
public abstract void prepareFromMediaId(String mediaId, Bundle extras)

Request that the player prepare playback for a specific media id. This can decrease the time it takes to start playback when a play command is received. Preparation is not required. You can call playFromMediaId without calling this method beforehand.

Parameters
String mediaId

The id of the requested media.

Bundle extras

Optional extras that can include extra information about the media item to be prepared.

prepareFromSearch

Added in 1.1.0
public abstract void prepareFromSearch(String query, Bundle extras)

Request that the player prepare playback for a specific search query. This can decrease the time it takes to start playback when a play command is received. An empty or null query should be treated as a request to prepare any music. Preparation is not required. You can call playFromSearch without calling this method beforehand.

Parameters
String query

The search query.

Bundle extras

Optional extras that can include extra information about the query.

prepareFromUri

Added in 1.1.0
public abstract void prepareFromUri(Uri uri, Bundle extras)

Request that the player prepare playback for a specific Uri. This can decrease the time it takes to start playback when a play command is received. Preparation is not required. You can call playFromUri without calling this method beforehand.

Parameters
Uri uri

The URI of the requested media.

Bundle extras

Optional extras that can include extra information about the media item to be prepared.

rewind

Added in 1.1.0
public abstract void rewind()

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

seekTo

Added in 1.1.0
public abstract void seekTo(long pos)

Moves to a new location in the media stream.

Parameters
long pos

Position to move to, in milliseconds.

sendCustomAction

Added in 1.1.0
public abstract void sendCustomAction(String action, Bundle args)

Sends the id and args from a custom action for the MediaSessionCompat to perform.

Parameters
String action

The action identifier of the PlaybackStateCompat.CustomAction as specified by the MediaSessionCompat.

Bundle args

Optional arguments to supply to the MediaSessionCompat for this custom action.

sendCustomAction

Added in 1.1.0
public abstract void sendCustomAction(
    PlaybackStateCompat.CustomAction customAction,
    Bundle args
)

Sends a custom action for the MediaSessionCompat to perform.

Parameters
PlaybackStateCompat.CustomAction customAction

The action to perform.

Bundle args

Optional arguments to supply to the MediaSessionCompat for this custom action.

setCaptioningEnabled

Added in 1.1.0
public abstract void setCaptioningEnabled(boolean enabled)

Enables/disables captioning for this session.

Parameters
boolean enabled

true to enable captioning, false to disable.

setPlaybackSpeed

Added in 1.2.0
public void setPlaybackSpeed(float speed)

Sets the playback speed. A value of 1.0f is the default playback value, and a negative value indicates reverse playback. 0.0f is not allowed.

Parameters
float speed

The playback speed

Throws
java.lang.IllegalArgumentException

if the speed is equal to zero.

setRating

Added in 1.1.0
public abstract void setRating(RatingCompat rating)

Rates the current content. This will cause the rating to be set for the current user. The rating type of the given RatingCompat must match the type returned by getRatingType.

Parameters
RatingCompat rating

The rating to set for the current content

setRating

Added in 1.1.0
public abstract void setRating(RatingCompat rating, Bundle extras)

Rates a media item. This will cause the rating to be set for the specific media item. The rating type of the given RatingCompat must match the type returned by getRatingType.

Parameters
RatingCompat rating

The rating to set for the media item.

Bundle extras

Optional arguments that can include information about the media item to be rated.

setRepeatMode

Added in 1.1.0
public abstract void setRepeatMode(int repeatMode)

Sets the repeat mode for this session.

Parameters
int repeatMode

The repeat mode. Must be one of the followings: REPEAT_MODE_NONE, REPEAT_MODE_ONE, REPEAT_MODE_ALL, REPEAT_MODE_GROUP

setShuffleMode

Added in 1.1.0
public abstract void setShuffleMode(int shuffleMode)

Sets the shuffle mode for this session.

Parameters
int shuffleMode

The shuffle mode. Must be one of the followings: SHUFFLE_MODE_NONE, SHUFFLE_MODE_ALL, SHUFFLE_MODE_GROUP

skipToNext

Added in 1.1.0
public abstract void skipToNext()

Skips to the next item.

skipToPrevious

Added in 1.1.0
public abstract void skipToPrevious()

Skips to the previous item.

skipToQueueItem

Added in 1.1.0
public abstract void skipToQueueItem(long id)

Plays 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.

stop

Added in 1.1.0
public abstract void stop()

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