Added in API level 14
Deprecated in API level 21

Summary: Nested Classes | Constants | Ctors | Methods | Inherited Methods

RemoteControlClient

Kotlin |Java

public class RemoteControlClient
extends Object

java.lang.Object
↳	android.media.RemoteControlClient

This class was deprecated in API level 21.
Use MediaSession instead.

RemoteControlClient enables exposing information meant to be consumed by remote controls capable of displaying metadata, artwork and media transport control buttons.

A remote control client object is associated with a media button event receiver. This event receiver must have been previously registered with AudioManager.registerMediaButtonEventReceiver(ComponentName) before the RemoteControlClient can be registered through AudioManager.registerRemoteControlClient(RemoteControlClient).

Here is an example of creating a RemoteControlClient instance after registering a media button event receiver:

ComponentName myEventReceiver = new ComponentName(getPackageName(), MyRemoteControlEventReceiver.class.getName());
 AudioManager myAudioManager = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
 myAudioManager.registerMediaButtonEventReceiver(myEventReceiver);
 // build the PendingIntent for the remote control client
 Intent mediaButtonIntent = new Intent(Intent.ACTION_MEDIA_BUTTON);
 mediaButtonIntent.setComponent(myEventReceiver);
 PendingIntent mediaPendingIntent = PendingIntent.getBroadcast(getApplicationContext(), 0, mediaButtonIntent, PendingIntent.FLAG_MUTABLE_UNAUDITED);
 // create and register the remote control client
 RemoteControlClient myRemoteControlClient = new RemoteControlClient(mediaPendingIntent);
 myAudioManager.registerRemoteControlClient(myRemoteControlClient);

Summary

Nested classes
`class`	`RemoteControlClient.MetadataEditor` This class was deprecated in API level 21. Use `MediaMetadata` and `MediaSession` instead.
`interface`	`RemoteControlClient.OnGetPlaybackPositionListener` Interface definition for a callback to be invoked when the media playback position is queried.
`interface`	`RemoteControlClient.OnMetadataUpdateListener` Interface definition for a callback to be invoked when one of the metadata values has been updated.
`interface`	`RemoteControlClient.OnPlaybackPositionUpdateListener` Interface definition for a callback to be invoked when the media playback position is requested to be updated.

Constants
`int`	`FLAG_KEY_MEDIA_FAST_FORWARD` Flag indicating a RemoteControlClient makes use of the "fast forward" media key.
`int`	`FLAG_KEY_MEDIA_NEXT` Flag indicating a RemoteControlClient makes use of the "next" media key.
`int`	`FLAG_KEY_MEDIA_PAUSE` Flag indicating a RemoteControlClient makes use of the "pause" media key.
`int`	`FLAG_KEY_MEDIA_PLAY` Flag indicating a RemoteControlClient makes use of the "play" media key.
`int`	`FLAG_KEY_MEDIA_PLAY_PAUSE` Flag indicating a RemoteControlClient makes use of the "play/pause" media key.
`int`	`FLAG_KEY_MEDIA_POSITION_UPDATE` Flag indicating a RemoteControlClient can receive changes in the media playback position through the `OnPlaybackPositionUpdateListener` interface.
`int`	`FLAG_KEY_MEDIA_PREVIOUS` Flag indicating a RemoteControlClient makes use of the "previous" media key.
`int`	`FLAG_KEY_MEDIA_RATING` Flag indicating a RemoteControlClient supports ratings.
`int`	`FLAG_KEY_MEDIA_REWIND` Flag indicating a RemoteControlClient makes use of the "rewind" media key.
`int`	`FLAG_KEY_MEDIA_STOP` Flag indicating a RemoteControlClient makes use of the "stop" media key.
`int`	`PLAYSTATE_BUFFERING` Playback state of a RemoteControlClient which is buffering data to play before it can start or resume playback.
`int`	`PLAYSTATE_ERROR` Playback state of a RemoteControlClient which cannot perform any playback related operation because of an internal error.
`int`	`PLAYSTATE_FAST_FORWARDING` Playback state of a RemoteControlClient which is fast forwarding in the media it is currently playing.
`int`	`PLAYSTATE_PAUSED` Playback state of a RemoteControlClient which is paused.
`int`	`PLAYSTATE_PLAYING` Playback state of a RemoteControlClient which is playing media.
`int`	`PLAYSTATE_REWINDING` Playback state of a RemoteControlClient which is fast rewinding in the media it is currently playing.
`int`	`PLAYSTATE_SKIPPING_BACKWARDS` Playback state of a RemoteControlClient which is skipping back to the previous logical chapter (such as a song in a playlist) in the media it is currently playing.
`int`	`PLAYSTATE_SKIPPING_FORWARDS` Playback state of a RemoteControlClient which is skipping to the next logical chapter (such as a song in a playlist) in the media it is currently playing.
`int`	`PLAYSTATE_STOPPED` Playback state of a RemoteControlClient which is stopped.

Public constructors
`RemoteControlClient(PendingIntent mediaButtonIntent)` Class constructor.
`RemoteControlClient(PendingIntent mediaButtonIntent, Looper looper)` Class constructor for a remote control client whose internal event handling happens on a user-provided Looper.

Public methods
`RemoteControlClient.MetadataEditor`	`editMetadata(boolean startEmpty)` Creates a `MetadataEditor`.
`MediaSession`	`getMediaSession()` Get a `MediaSession` associated with this RCC.
`void`	`setMetadataUpdateListener(RemoteControlClient.OnMetadataUpdateListener l)` Sets the listener to be called whenever the metadata is updated.
`void`	`setOnGetPlaybackPositionListener(RemoteControlClient.OnGetPlaybackPositionListener l)` Sets the listener to be called whenever the media current playback position is needed.
`void`	`setPlaybackPositionUpdateListener(RemoteControlClient.OnPlaybackPositionUpdateListener l)` Sets the listener to be called whenever the media playback position is requested to be updated.
`void`	`setPlaybackState(int state, long timeInMs, float playbackSpeed)` Sets the current playback state and the matching media position for the current playback speed.
`void`	`setPlaybackState(int state)` Sets the current playback state.
`void`	`setTransportControlFlags(int transportControlFlags)` Sets the flags for the media transport control buttons that this client supports.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

FLAG_KEY_MEDIA_FAST_FORWARD

Added in API level 14

public static final int FLAG_KEY_MEDIA_FAST_FORWARD

Flag indicating a RemoteControlClient makes use of the "fast forward" media key.

See also:

Constant Value: 64 (0x00000040)

FLAG_KEY_MEDIA_NEXT

Added in API level 14

public static final int FLAG_KEY_MEDIA_NEXT

Flag indicating a RemoteControlClient makes use of the "next" media key.

See also:

Constant Value: 128 (0x00000080)

FLAG_KEY_MEDIA_PAUSE

Added in API level 14

public static final int FLAG_KEY_MEDIA_PAUSE

Flag indicating a RemoteControlClient makes use of the "pause" media key.

See also:

Constant Value: 16 (0x00000010)

FLAG_KEY_MEDIA_PLAY

Added in API level 14

public static final int FLAG_KEY_MEDIA_PLAY

Flag indicating a RemoteControlClient makes use of the "play" media key.

See also:

Constant Value: 4 (0x00000004)

FLAG_KEY_MEDIA_PLAY_PAUSE

Added in API level 14

public static final int FLAG_KEY_MEDIA_PLAY_PAUSE

Flag indicating a RemoteControlClient makes use of the "play/pause" media key.

See also:

Constant Value: 8 (0x00000008)

FLAG_KEY_MEDIA_POSITION_UPDATE

Added in API level 18
Deprecated in API level 21

public static final int FLAG_KEY_MEDIA_POSITION_UPDATE

Flag indicating a RemoteControlClient can receive changes in the media playback position through the OnPlaybackPositionUpdateListener interface. This flag must be set in order for components that display the RemoteControlClient information, to display and let the user control media playback position.

See also:

Constant Value: 256 (0x00000100)

FLAG_KEY_MEDIA_PREVIOUS

Added in API level 14

public static final int FLAG_KEY_MEDIA_PREVIOUS

Flag indicating a RemoteControlClient makes use of the "previous" media key.

See also:

Constant Value: 1 (0x00000001)

FLAG_KEY_MEDIA_RATING

Added in API level 19
Deprecated in API level 21

public static final int FLAG_KEY_MEDIA_RATING

Flag indicating a RemoteControlClient supports ratings. This flag must be set in order for components that display the RemoteControlClient information, to display ratings information, and, if ratings are declared editable (by calling MediaMetadataEditor.addEditableKey(int) with the MediaMetadataEditor.RATING_KEY_BY_USER key), it will enable the user to rate the media, with values being received through the interface set with setMetadataUpdateListener(android.media.RemoteControlClient.OnMetadataUpdateListener).

See also:

setTransportControlFlags(int)

Constant Value: 512 (0x00000200)

FLAG_KEY_MEDIA_REWIND

Added in API level 14

public static final int FLAG_KEY_MEDIA_REWIND

Flag indicating a RemoteControlClient makes use of the "rewind" media key.

See also:

Constant Value: 2 (0x00000002)

FLAG_KEY_MEDIA_STOP

Added in API level 14

public static final int FLAG_KEY_MEDIA_STOP

Flag indicating a RemoteControlClient makes use of the "stop" media key.

See also:

Constant Value: 32 (0x00000020)

PLAYSTATE_BUFFERING

Added in API level 14

public static final int PLAYSTATE_BUFFERING

Playback state of a RemoteControlClient which is buffering data to play before it can start or resume playback.

See also:

setPlaybackState(int)

Constant Value: 8 (0x00000008)

PLAYSTATE_ERROR

Added in API level 14

public static final int PLAYSTATE_ERROR

Playback state of a RemoteControlClient which cannot perform any playback related operation because of an internal error. Examples of such situations are no network connectivity when attempting to stream data from a server, or expired user credentials when trying to play subscription-based content.

See also:

setPlaybackState(int)

Constant Value: 9 (0x00000009)

PLAYSTATE_FAST_FORWARDING

Added in API level 14

public static final int PLAYSTATE_FAST_FORWARDING

Playback state of a RemoteControlClient which is fast forwarding in the media it is currently playing.

See also:

setPlaybackState(int)

Constant Value: 4 (0x00000004)

PLAYSTATE_PAUSED

Added in API level 14

public static final int PLAYSTATE_PAUSED

Playback state of a RemoteControlClient which is paused.

See also:

setPlaybackState(int)

Constant Value: 2 (0x00000002)

PLAYSTATE_PLAYING

Added in API level 14

public static final int PLAYSTATE_PLAYING

Playback state of a RemoteControlClient which is playing media.

See also:

setPlaybackState(int)

Constant Value: 3 (0x00000003)

PLAYSTATE_REWINDING

Added in API level 14

public static final int PLAYSTATE_REWINDING

Playback state of a RemoteControlClient which is fast rewinding in the media it is currently playing.

See also:

setPlaybackState(int)

Constant Value: 5 (0x00000005)

PLAYSTATE_SKIPPING_BACKWARDS

Added in API level 14

public static final int PLAYSTATE_SKIPPING_BACKWARDS

Playback state of a RemoteControlClient which is skipping back to the previous logical chapter (such as a song in a playlist) in the media it is currently playing.

See also:

setPlaybackState(int)

Constant Value: 7 (0x00000007)

PLAYSTATE_SKIPPING_FORWARDS

Added in API level 14

public static final int PLAYSTATE_SKIPPING_FORWARDS

Playback state of a RemoteControlClient which is skipping to the next logical chapter (such as a song in a playlist) in the media it is currently playing.

See also:

setPlaybackState(int)

Constant Value: 6 (0x00000006)

PLAYSTATE_STOPPED

Added in API level 14

public static final int PLAYSTATE_STOPPED

Playback state of a RemoteControlClient which is stopped.

See also:

setPlaybackState(int)

Constant Value: 1 (0x00000001)

Public constructors

RemoteControlClient

Added in API level 14

public RemoteControlClient (PendingIntent mediaButtonIntent)

Class constructor.

Parameters

Parameters
`mediaButtonIntent`	`PendingIntent`: The intent that will be sent for the media button events sent by remote controls. This intent needs to have been constructed with the `Intent.ACTION_MEDIA_BUTTON` action, and have a component that will handle the intent (set with `Intent.setComponent(ComponentName)`) registered with `AudioManager.registerMediaButtonEventReceiver(ComponentName)` before this new RemoteControlClient can itself be registered with `AudioManager.registerRemoteControlClient(RemoteControlClient)`.

mediaButtonIntent

PendingIntent: The intent that will be sent for the media button events sent by remote controls. This intent needs to have been constructed with the Intent.ACTION_MEDIA_BUTTON action, and have a component that will handle the intent (set with Intent.setComponent(ComponentName)) registered with AudioManager.registerMediaButtonEventReceiver(ComponentName) before this new RemoteControlClient can itself be registered with AudioManager.registerRemoteControlClient(RemoteControlClient).

See also:

RemoteControlClient

Added in API level 14

public RemoteControlClient (PendingIntent mediaButtonIntent, 
                Looper looper)

Class constructor for a remote control client whose internal event handling happens on a user-provided Looper.

Parameters

Parameters
`mediaButtonIntent`	`PendingIntent`: The intent that will be sent for the media button events sent by remote controls. This intent needs to have been constructed with the `Intent.ACTION_MEDIA_BUTTON` action, and have a component that will handle the intent (set with `Intent.setComponent(ComponentName)`) registered with `AudioManager.registerMediaButtonEventReceiver(ComponentName)` before this new RemoteControlClient can itself be registered with `AudioManager.registerRemoteControlClient(RemoteControlClient)`.
`looper`	`Looper`: The Looper running the event loop.

mediaButtonIntent

looper

Looper: The Looper running the event loop.

See also:

Public methods

editMetadata

Added in API level 14

public RemoteControlClient.MetadataEditor editMetadata (boolean startEmpty)

Creates a MetadataEditor.

Parameters
`startEmpty`	`boolean`: Set to false if you want the MetadataEditor to contain the metadata that was previously applied to the RemoteControlClient, or true if it is to be created empty.

Returns
`RemoteControlClient.MetadataEditor`	a new MetadataEditor instance.

getMediaSession

Added in API level 21
Deprecated in API level 21

public MediaSession getMediaSession ()

Get a MediaSession associated with this RCC. It will only have a session while it is registered with AudioManager.registerRemoteControlClient. The session returned should not be modified directly by the application but may be used with other APIs that require a session.

Returns
`MediaSession`	A media session object or null.

setMetadataUpdateListener

Added in API level 19
Deprecated in API level 21

public void setMetadataUpdateListener (RemoteControlClient.OnMetadataUpdateListener l)

Sets the listener to be called whenever the metadata is updated. New metadata values will be received in the same thread as the one in which RemoteControlClient was created.

Parameters
`l`	`RemoteControlClient.OnMetadataUpdateListener`: the metadata update listener

setOnGetPlaybackPositionListener

Added in API level 18
Deprecated in API level 21

public void setOnGetPlaybackPositionListener (RemoteControlClient.OnGetPlaybackPositionListener l)

Sets the listener to be called whenever the media current playback position is needed. Queries will be received in the same thread as the one in which RemoteControlClient was created.

Parameters
`l`	`RemoteControlClient.OnGetPlaybackPositionListener`: the listener to be called to retrieve the playback position

setPlaybackPositionUpdateListener

Added in API level 18
Deprecated in API level 21

public void setPlaybackPositionUpdateListener (RemoteControlClient.OnPlaybackPositionUpdateListener l)

Sets the listener to be called whenever the media playback position is requested to be updated. Notifications will be received in the same thread as the one in which RemoteControlClient was created.

Parameters
`l`	`RemoteControlClient.OnPlaybackPositionUpdateListener`: the position update listener to be called

setPlaybackState

Added in API level 18
Deprecated in API level 21

public void setPlaybackState (int state, 
                long timeInMs, 
                float playbackSpeed)

Sets the current playback state and the matching media position for the current playback speed.

Parameters
`state`	`int`: The current playback state, one of the following values: `PLAYSTATE_STOPPED`, `PLAYSTATE_PAUSED`, `PLAYSTATE_PLAYING`, `PLAYSTATE_FAST_FORWARDING`, `PLAYSTATE_REWINDING`, `PLAYSTATE_SKIPPING_FORWARDS`, `PLAYSTATE_SKIPPING_BACKWARDS`, `PLAYSTATE_BUFFERING`, `PLAYSTATE_ERROR`.
`timeInMs`	`long`: a 0 or positive value for the current media position expressed in ms (same unit as for when sending the media duration, if applicable, with `MediaMetadataRetriever.METADATA_KEY_DURATION` in the `RemoteControlClient.MetadataEditor`). Negative values imply that position is not known (e.g. listening to a live stream of a radio) or not applicable (e.g. when state is `PLAYSTATE_BUFFERING` and nothing had played yet).
`playbackSpeed`	`float`: a value expressed as a ratio of 1x playback: 1.0f is normal playback, 2.0f is 2x, 0.5f is half-speed, -2.0f is rewind at 2x speed. 0.0f means nothing is playing (e.g. when state is `PLAYSTATE_ERROR`).

setPlaybackState

Added in API level 14

public void setPlaybackState (int state)

Sets the current playback state.

Parameters
`state`	`int`: The current playback state, one of the following values: `PLAYSTATE_STOPPED`, `PLAYSTATE_PAUSED`, `PLAYSTATE_PLAYING`, `PLAYSTATE_FAST_FORWARDING`, `PLAYSTATE_REWINDING`, `PLAYSTATE_SKIPPING_FORWARDS`, `PLAYSTATE_SKIPPING_BACKWARDS`, `PLAYSTATE_BUFFERING`, `PLAYSTATE_ERROR`.

setTransportControlFlags

Added in API level 14

public void setTransportControlFlags (int transportControlFlags)

Sets the flags for the media transport control buttons that this client supports.

Parameters
`transportControlFlags`	`int`: A combination of the following flags: `FLAG_KEY_MEDIA_PREVIOUS`, `FLAG_KEY_MEDIA_REWIND`, `FLAG_KEY_MEDIA_PLAY`, `FLAG_KEY_MEDIA_PLAY_PAUSE`, `FLAG_KEY_MEDIA_PAUSE`, `FLAG_KEY_MEDIA_STOP`, `FLAG_KEY_MEDIA_FAST_FORWARD`, `FLAG_KEY_MEDIA_NEXT`, `FLAG_KEY_MEDIA_POSITION_UPDATE`, `FLAG_KEY_MEDIA_RATING`.

RemoteControlClient

Summary

Nested classes

Constants

Public constructors

Public methods

Inherited methods

Constants

FLAG_KEY_MEDIA_FAST_FORWARD

FLAG_KEY_MEDIA_NEXT

FLAG_KEY_MEDIA_PAUSE

FLAG_KEY_MEDIA_PLAY

FLAG_KEY_MEDIA_PLAY_PAUSE

FLAG_KEY_MEDIA_POSITION_UPDATE

FLAG_KEY_MEDIA_PREVIOUS

FLAG_KEY_MEDIA_RATING

FLAG_KEY_MEDIA_REWIND

FLAG_KEY_MEDIA_STOP

PLAYSTATE_BUFFERING

PLAYSTATE_ERROR

PLAYSTATE_FAST_FORWARDING

PLAYSTATE_PAUSED

PLAYSTATE_PLAYING

PLAYSTATE_REWINDING

PLAYSTATE_SKIPPING_BACKWARDS

PLAYSTATE_SKIPPING_FORWARDS

PLAYSTATE_STOPPED

Public constructors

RemoteControlClient

RemoteControlClient

Public methods

editMetadata

getMediaSession

setMetadataUpdateListener

setOnGetPlaybackPositionListener

setPlaybackPositionUpdateListener

setPlaybackState

setPlaybackState

setTransportControlFlags