Added in API level 19
Deprecated in API level 21

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

RemoteController

---

Kotlin |Java

public final class RemoteController
extends Object

java.lang.Object
↳	android.media.RemoteController

---

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

The RemoteController class is used to control media playback, display and update media metadata and playback status, published by applications using the RemoteControlClient class.

A RemoteController shall be registered through AudioManager#registerRemoteController(RemoteController) in order for the system to send media event updates to the OnClientUpdateListener listener set in the class constructor. Implement the methods of the interface to receive the information published by the active RemoteControlClient instances.
By default an OnClientUpdateListener implementation will not receive bitmaps for album art. Use setArtworkConfiguration(int, int) to receive images as well.

Registration requires the OnClientUpdateListener listener to be one of the enabled notification listeners (see NotificationListenerService).

Summary

Nested classes
class	RemoteController.MetadataEditor A class to read the metadata published by a RemoteControlClient, or send a RemoteControlClient new values for keys that can be edited.
interface	RemoteController.OnClientUpdateListener Interface definition for the callbacks to be invoked whenever media events, metadata and playback status are available.

Constants
int	POSITION_SYNCHRONIZATION_CHECK The playback position synchronization mode where the RemoteControlClient instances which expose their playback position to the framework, will be regularly polled to check whether any drift has been noticed between their estimated position and the one they report.
int	POSITION_SYNCHRONIZATION_NONE Default playback position synchronization mode where the RemoteControlClient is not asked regularly for its playback position to see if it has drifted from the estimated position.

Public constructors
RemoteController(Context context, RemoteController.OnClientUpdateListener updateListener) Class constructor.
RemoteController(Context context, RemoteController.OnClientUpdateListener updateListener, Looper looper) Class constructor.

Public methods
boolean	clearArtworkConfiguration() Prevents this RemoteController from receiving artwork images.
RemoteController.MetadataEditor	editMetadata() Creates a MetadataEditor for updating metadata values of the editable keys of the current RemoteControlClient.
long	getEstimatedMediaPosition() Return the estimated playback position of the current media track or a negative value if not available.
boolean	seekTo(long timeMs) Sets the new playback position.
boolean	sendMediaKeyEvent(KeyEvent keyEvent) Send a simulated key event for a media button to be received by the current client.
boolean	setArtworkConfiguration(int width, int height) Set the maximum artwork image dimensions to be received in the metadata.
boolean	setSynchronizationMode(int sync) Set the playback position synchronization mode.

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

POSITION_SYNCHRONIZATION_CHECK

Added in API level 19

public static final int POSITION_SYNCHRONIZATION_CHECK

The playback position synchronization mode where the RemoteControlClient instances which expose their playback position to the framework, will be regularly polled to check whether any drift has been noticed between their estimated position and the one they report. Note that this mode should only ever be used when needing to display very accurate playback position, as regularly polling a RemoteControlClient for its position may have an impact on battery life (if applicable) when this query will trigger network transactions in the case of remote playback.

Constant Value: 1 (0x00000001)

POSITION_SYNCHRONIZATION_NONE

Added in API level 19

public static final int POSITION_SYNCHRONIZATION_NONE

Default playback position synchronization mode where the RemoteControlClient is not asked regularly for its playback position to see if it has drifted from the estimated position.

Constant Value: 0 (0x00000000)

Public constructors

RemoteController

Added in API level 19

public RemoteController (Context context, 
                RemoteController.OnClientUpdateListener updateListener)

Class constructor.

Parameters
context	Context: the Context, must be non-null.
updateListener	RemoteController.OnClientUpdateListener: the listener to be called whenever new client information is available, must be non-null.

Throws
	java.lang.IllegalArgumentException
IllegalArgumentException

RemoteController

Added in API level 19

public RemoteController (Context context, 
                RemoteController.OnClientUpdateListener updateListener, 
                Looper looper)

Class constructor.

Parameters
context	Context: the Context, must be non-null.
updateListener	RemoteController.OnClientUpdateListener: the listener to be called whenever new client information is available, must be non-null.
looper	Looper: the Looper on which to run the event loop, or null to use the current thread's looper.

Throws
	java.lang.IllegalArgumentException
IllegalArgumentException

Public methods

clearArtworkConfiguration

Added in API level 19

public boolean clearArtworkConfiguration ()

Prevents this RemoteController from receiving artwork images.

Returns
boolean	true if receiving artwork images was successfully disabled.

editMetadata

Added in API level 19

public RemoteController.MetadataEditor editMetadata ()

Creates a MetadataEditor for updating metadata values of the editable keys of the current RemoteControlClient. This method can only be called on a registered RemoteController.

Returns
RemoteController.MetadataEditor	a new MetadataEditor instance.

getEstimatedMediaPosition

Added in API level 19

public long getEstimatedMediaPosition ()

Return the estimated playback position of the current media track or a negative value if not available.

The value returned is estimated by the current process and may not be perfect. The time returned by this method is calculated from the last state change time based on the current play position at that time and the last known playback speed. An application may call setSynchronizationMode(int) to apply a synchronization policy that will periodically re-sync the estimated position with the RemoteControlClient.

Returns
long	the current estimated playback position in milliseconds or a negative value if not available

See also:

• RemoteController.OnClientUpdateListener.onClientPlaybackStateUpdate(int, long, long, float)

seekTo

Added in API level 19

public boolean seekTo (long timeMs)

Sets the new playback position. This method can only be called on a registered RemoteController.

Parameters
timeMs	long: a 0 or positive value for the new playback position, expressed in ms.

Returns
boolean	true if the command to set the playback position was successfully sent.

Throws
	java.lang.IllegalArgumentException
IllegalArgumentException

sendMediaKeyEvent

Added in API level 19

public boolean sendMediaKeyEvent (KeyEvent keyEvent)

Send a simulated key event for a media button to be received by the current client. To simulate a key press, you must first send a KeyEvent built with a KeyEvent.ACTION_DOWN action, then another event with the KeyEvent#ACTION_UP action.

The key event will be sent to the registered receiver (see AudioManager.registerMediaButtonEventReceiver(PendingIntent)) whose associated RemoteControlClient's metadata and playback state is published (there may be none under some circumstances).

Parameters
keyEvent	KeyEvent: a media session KeyEvent, as defined by KeyEvent.isMediaSessionKey(int).

Returns
boolean	true if the event was successfully sent, false otherwise.

Throws
IllegalArgumentException	If the provided KeyEvent is not a media session key, as defined by KeyEvent#isMediaSessionKey.

setArtworkConfiguration

Added in API level 19

public boolean setArtworkConfiguration (int width, 
                int height)

Set the maximum artwork image dimensions to be received in the metadata. No bitmaps will be received unless this has been specified.

Parameters
width	int: the maximum width in pixels
height	int: the maximum height in pixels

Returns
boolean	true if the artwork dimension was successfully set.

Throws
	java.lang.IllegalArgumentException
IllegalArgumentException

setSynchronizationMode

Added in API level 19

public boolean setSynchronizationMode (int sync)

Set the playback position synchronization mode. Must be called on a registered RemoteController.

Parameters
sync	int: POSITION_SYNCHRONIZATION_NONE or POSITION_SYNCHRONIZATION_CHECK

Returns
boolean	true if the synchronization mode was successfully set.

Throws
	java.lang.IllegalArgumentException
IllegalArgumentException