MediaControllerCompat.TransportControls
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 |
|
|---|---|
const String! |
EXTRA_LEGACY_STREAM_TYPE = "android.media.session.extra.LEGACY_STREAM_TYPE"This property is deprecated. Use |
Public functions |
|
|---|---|
abstract Unit |
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 media id. |
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 |
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 |
abstract Unit |
rewind()Starts rewinding. |
abstract Unit |
Moves to a new location in the media stream. |
abstract Unit |
sendCustomAction(action: String!, args: Bundle!)Sends the id and args from a custom action for the |
abstract Unit |
sendCustomAction(Sends a custom action for the |
abstract Unit |
setCaptioningEnabled(enabled: Boolean)Enables/disables captioning for this session. |
Unit |
setPlaybackSpeed(speed: Float)Sets the playback speed. |
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 |
Skips to the next item. |
abstract Unit |
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
const val EXTRA_LEGACY_STREAM_TYPE = "android.media.session.extra.LEGACY_STREAM_TYPE": String!
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 functions
fastForward
abstract fun fastForward(): Unit
Starts fast forwarding. If playback is already fast forwarding this may increase the rate.
pause
abstract fun pause(): Unit
Request that the player pause its playback and stay at its current position.
play
abstract fun play(): Unit
Request that the player start its playback at its current position.
playFromMediaId
abstract fun playFromMediaId(mediaId: String!, extras: Bundle!): Unit
Request that the player start playback for a specific media id.
playFromSearch
abstract fun playFromSearch(query: String!, extras: Bundle!): Unit
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.
playFromUri
abstract fun playFromUri(uri: Uri!, extras: Bundle!): Unit
Request that the player start playback for a specific Uri.
prepare
abstract fun prepare(): Unit
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
abstract fun prepareFromMediaId(mediaId: String!, extras: Bundle!): Unit
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.
prepareFromSearch
abstract fun prepareFromSearch(query: String!, extras: Bundle!): Unit
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.
prepareFromUri
abstract fun prepareFromUri(uri: Uri!, extras: Bundle!): Unit
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.
rewind
abstract fun rewind(): Unit
Starts rewinding. If playback is already rewinding this may increase the rate.
seekTo
abstract fun seekTo(pos: Long): Unit
Moves to a new location in the media stream.
| Parameters | |
|---|---|
pos: Long |
Position to move to, in milliseconds. |
sendCustomAction
abstract fun sendCustomAction(action: String!, args: Bundle!): Unit
Sends the id and args from a custom action for the MediaSessionCompat to perform.
| Parameters | |
|---|---|
action: String! |
The action identifier of the |
args: Bundle! |
Optional arguments to supply to the |
sendCustomAction
abstract fun sendCustomAction(
customAction: PlaybackStateCompat.CustomAction!,
args: Bundle!
): Unit
Sends a custom action for the MediaSessionCompat to perform.
| Parameters | |
|---|---|
customAction: PlaybackStateCompat.CustomAction! |
The action to perform. |
args: Bundle! |
Optional arguments to supply to the |
setCaptioningEnabled
abstract fun setCaptioningEnabled(enabled: Boolean): Unit
Enables/disables captioning for this session.
| Parameters | |
|---|---|
enabled: Boolean |
|
setPlaybackSpeed
fun setPlaybackSpeed(speed: Float): Unit
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 | |
|---|---|
speed: Float |
The playback speed |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if the |
setRating
abstract fun setRating(rating: RatingCompat!): Unit
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 | |
|---|---|
rating: RatingCompat! |
The rating to set for the current content |
setRating
abstract fun setRating(rating: RatingCompat!, extras: Bundle!): Unit
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 | |
|---|---|
rating: RatingCompat! |
The rating to set for the media item. |
extras: Bundle! |
Optional arguments that can include information about the media item to be rated. |
setRepeatMode
abstract fun setRepeatMode(repeatMode: Int): Unit
Sets the repeat mode for this session.
| Parameters | |
|---|---|
repeatMode: Int |
The repeat mode. Must be one of the followings: |
setShuffleMode
abstract fun setShuffleMode(shuffleMode: Int): Unit
Sets the shuffle mode for this session.
| Parameters | |
|---|---|
shuffleMode: Int |
The shuffle mode. Must be one of the followings: |
skipToQueueItem
abstract fun skipToQueueItem(id: Long): Unit
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.