Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/media/RemoteControlClient#nestedclasses) \| [Constants](https://developer.android.com/reference/android/media/RemoteControlClient#constants) \| [Ctors](https://developer.android.com/reference/android/media/RemoteControlClient#pubctors) \| [Methods](https://developer.android.com/reference/android/media/RemoteControlClient#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/RemoteControlClient#inhmethods)

# RemoteControlClient

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/media/RemoteControlClient "View this page in Kotlin") \|Java


`
public


class
RemoteControlClient
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.RemoteControlClient |

<br />

*** ** * ** ***


**This class was deprecated
in API level 21.**   

Use `https://developer.android.com/reference/android/media/session/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
`https://developer.android.com/reference/android/media/AudioManager#registerMediaButtonEventReceiver(android.content.ComponentName)` before the
RemoteControlClient can be registered through
`https://developer.android.com/reference/android/media/AudioManager#registerRemoteControlClient(android.media.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);
```

<br />

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor` *This class was deprecated in API level 21. Use `https://developer.android.com/reference/android/media/MediaMetadata` and `https://developer.android.com/reference/android/media/session/MediaSession` instead.* |
| ` interface` | `https://developer.android.com/reference/android/media/RemoteControlClient.OnGetPlaybackPositionListener` Interface definition for a callback to be invoked when the media playback position is queried. |
| ` interface` | `https://developer.android.com/reference/android/media/RemoteControlClient.OnMetadataUpdateListener` Interface definition for a callback to be invoked when one of the metadata values has been updated. |
| ` interface` | `https://developer.android.com/reference/android/media/RemoteControlClient.OnPlaybackPositionUpdateListener` Interface definition for a callback to be invoked when the media playback position is requested to be updated. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_FAST_FORWARD` Flag indicating a RemoteControlClient makes use of the "fast forward" media key. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_NEXT` Flag indicating a RemoteControlClient makes use of the "next" media key. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_PAUSE` Flag indicating a RemoteControlClient makes use of the "pause" media key. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_PLAY` Flag indicating a RemoteControlClient makes use of the "play" media key. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_PLAY_PAUSE` Flag indicating a RemoteControlClient makes use of the "play/pause" media key. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_POSITION_UPDATE` Flag indicating a RemoteControlClient can receive changes in the media playback position through the `https://developer.android.com/reference/android/media/RemoteControlClient.OnPlaybackPositionUpdateListener` interface. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_PREVIOUS` Flag indicating a RemoteControlClient makes use of the "previous" media key. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_RATING` Flag indicating a RemoteControlClient supports ratings. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_REWIND` Flag indicating a RemoteControlClient makes use of the "rewind" media key. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_STOP` Flag indicating a RemoteControlClient makes use of the "stop" media key. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_BUFFERING` Playback state of a RemoteControlClient which is buffering data to play before it can start or resume playback. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_ERROR` Playback state of a RemoteControlClient which cannot perform any playback related operation because of an internal error. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_FAST_FORWARDING` Playback state of a RemoteControlClient which is fast forwarding in the media it is currently playing. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_PAUSED` Playback state of a RemoteControlClient which is paused. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_PLAYING` Playback state of a RemoteControlClient which is playing media. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_REWINDING` Playback state of a RemoteControlClient which is fast rewinding in the media it is currently playing. |
| `int` | `https://developer.android.com/reference/android/media/RemoteControlClient#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` | `https://developer.android.com/reference/android/media/RemoteControlClient#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` | `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_STOPPED` Playback state of a RemoteControlClient which is stopped. |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/media/RemoteControlClient#RemoteControlClient(android.app.PendingIntent)(https://developer.android.com/reference/android/app/PendingIntent mediaButtonIntent) ` Class constructor. |
| ` https://developer.android.com/reference/android/media/RemoteControlClient#RemoteControlClient(android.app.PendingIntent,%20android.os.Looper)(https://developer.android.com/reference/android/app/PendingIntent mediaButtonIntent, https://developer.android.com/reference/android/os/Looper looper) ` Class constructor for a remote control client whose internal event handling happens on a user-provided Looper. |

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

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_KEY_MEDIA_FAST_FORWARD
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`
- `https://developer.android.com/reference/android/view/KeyEvent#KEYCODE_MEDIA_FAST_FORWARD`

Constant Value:

64
(0x00000040)


### FLAG_KEY_MEDIA_NEXT

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_KEY_MEDIA_NEXT
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`
- `https://developer.android.com/reference/android/view/KeyEvent#KEYCODE_MEDIA_NEXT`

Constant Value:

128
(0x00000080)


### FLAG_KEY_MEDIA_PAUSE

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_KEY_MEDIA_PAUSE
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`
- `https://developer.android.com/reference/android/view/KeyEvent#KEYCODE_MEDIA_PAUSE`

Constant Value:

16
(0x00000010)


### FLAG_KEY_MEDIA_PLAY

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_KEY_MEDIA_PLAY
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`
- `https://developer.android.com/reference/android/view/KeyEvent#KEYCODE_MEDIA_PLAY`

Constant Value:

4
(0x00000004)


### FLAG_KEY_MEDIA_PLAY_PAUSE

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_KEY_MEDIA_PLAY_PAUSE
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`
- `https://developer.android.com/reference/android/view/KeyEvent#KEYCODE_MEDIA_PLAY_PAUSE`

Constant Value:

8
(0x00000008)


### FLAG_KEY_MEDIA_POSITION_UPDATE

Added in [API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_KEY_MEDIA_POSITION_UPDATE
```

Flag indicating a RemoteControlClient can receive changes in the media playback position
through the `https://developer.android.com/reference/android/media/RemoteControlClient.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.

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`
- `https://developer.android.com/reference/android/media/RemoteControlClient#setOnGetPlaybackPositionListener(android.media.RemoteControlClient.OnGetPlaybackPositionListener)`
- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackPositionUpdateListener(android.media.RemoteControlClient.OnPlaybackPositionUpdateListener)`

Constant Value:

256
(0x00000100)


### FLAG_KEY_MEDIA_PREVIOUS

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_KEY_MEDIA_PREVIOUS
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`
- `https://developer.android.com/reference/android/view/KeyEvent#KEYCODE_MEDIA_PREVIOUS`

Constant Value:

1
(0x00000001)


### FLAG_KEY_MEDIA_RATING

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/media/MediaMetadataEditor#addEditableKey(int)` with the
`https://developer.android.com/reference/android/media/MediaMetadataEditor#RATING_KEY_BY_USER` key), it will enable the user to rate
the media, with values being received through the interface set with
`https://developer.android.com/reference/android/media/RemoteControlClient#setMetadataUpdateListener(android.media.RemoteControlClient.OnMetadataUpdateListener)`.

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`

Constant Value:

512
(0x00000200)


### FLAG_KEY_MEDIA_REWIND

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_KEY_MEDIA_REWIND
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`
- `https://developer.android.com/reference/android/view/KeyEvent#KEYCODE_MEDIA_REWIND`

Constant Value:

2
(0x00000002)


### FLAG_KEY_MEDIA_STOP

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int FLAG_KEY_MEDIA_STOP
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setTransportControlFlags(int)`
- `https://developer.android.com/reference/android/view/KeyEvent#KEYCODE_MEDIA_STOP`

Constant Value:

32
(0x00000020)


### PLAYSTATE_BUFFERING

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int PLAYSTATE_BUFFERING
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackState(int)`

Constant Value:

8
(0x00000008)


### PLAYSTATE_ERROR

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackState(int)`

Constant Value:

9
(0x00000009)


### PLAYSTATE_FAST_FORWARDING

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int PLAYSTATE_FAST_FORWARDING
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackState(int)`

Constant Value:

4
(0x00000004)


### PLAYSTATE_PAUSED

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int PLAYSTATE_PAUSED
```

Playback state of a RemoteControlClient which is paused.

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackState(int)`

Constant Value:

2
(0x00000002)


### PLAYSTATE_PLAYING

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int PLAYSTATE_PLAYING
```

Playback state of a RemoteControlClient which is playing media.

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackState(int)`

Constant Value:

3
(0x00000003)


### PLAYSTATE_REWINDING

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int PLAYSTATE_REWINDING
```

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackState(int)`

Constant Value:

5
(0x00000005)


### PLAYSTATE_SKIPPING_BACKWARDS

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackState(int)`

Constant Value:

7
(0x00000007)


### PLAYSTATE_SKIPPING_FORWARDS

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackState(int)`

Constant Value:

6
(0x00000006)


### PLAYSTATE_STOPPED

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int PLAYSTATE_STOPPED
```

Playback state of a RemoteControlClient which is stopped.

<br />

**See also:**

- `https://developer.android.com/reference/android/media/RemoteControlClient#setPlaybackState(int)`

Constant Value:

1
(0x00000001)


## Public constructors

### RemoteControlClient

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public RemoteControlClient (PendingIntent mediaButtonIntent)
```

Class constructor.

<br />

| 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 `https://developer.android.com/reference/android/content/Intent#ACTION_MEDIA_BUTTON` action, and have a component that will handle the intent (set with `https://developer.android.com/reference/android/content/Intent#setComponent(android.content.ComponentName)`) registered with `https://developer.android.com/reference/android/media/AudioManager#registerMediaButtonEventReceiver(android.content.ComponentName)` before this new RemoteControlClient can itself be registered with `https://developer.android.com/reference/android/media/AudioManager#registerRemoteControlClient(android.media.RemoteControlClient)`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/media/AudioManager#registerMediaButtonEventReceiver(android.content.ComponentName)`
- `https://developer.android.com/reference/android/media/AudioManager#registerRemoteControlClient(android.media.RemoteControlClient)`

### RemoteControlClient

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public RemoteControlClient (PendingIntent mediaButtonIntent, 
                Looper looper)
```

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

<br />

| 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 `https://developer.android.com/reference/android/content/Intent#ACTION_MEDIA_BUTTON` action, and have a component that will handle the intent (set with `https://developer.android.com/reference/android/content/Intent#setComponent(android.content.ComponentName)`) registered with `https://developer.android.com/reference/android/media/AudioManager#registerMediaButtonEventReceiver(android.content.ComponentName)` before this new RemoteControlClient can itself be registered with `https://developer.android.com/reference/android/media/AudioManager#registerRemoteControlClient(android.media.RemoteControlClient)`. <br /> |
| `looper` | `Looper`: The Looper running the event loop. <br /> |

**See also:**

- `https://developer.android.com/reference/android/media/AudioManager#registerMediaButtonEventReceiver(android.content.ComponentName)`
- `https://developer.android.com/reference/android/media/AudioManager#registerRemoteControlClient(android.media.RemoteControlClient)`

## Public methods

### editMetadata

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public RemoteControlClient.MetadataEditor editMetadata (boolean startEmpty)
```

Creates a `https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor`.

<br />

| 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. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/RemoteControlClient.MetadataEditor` | a new MetadataEditor instance. <br /> |

### getMediaSession

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public MediaSession getMediaSession ()
```

Get a `https://developer.android.com/reference/android/media/session/MediaSession` associated with this RCC. It will only have a
session while it is registered with
`https://developer.android.com/reference/android/media/AudioManager#registerRemoteControlClient(android.media.RemoteControlClient)`. The session returned
should not be modified directly by the application but may be used with
other APIs that require a session.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/session/MediaSession` | A media session object or null. <br /> |

### setMetadataUpdateListener

Added in [API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `l` | `RemoteControlClient.OnMetadataUpdateListener`: the metadata update listener <br /> |

### setOnGetPlaybackPositionListener

Added in [API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `l` | `RemoteControlClient.OnGetPlaybackPositionListener`: the listener to be called to retrieve the playback position <br /> |

### setPlaybackPositionUpdateListener

Added in [API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Parameters ||
|---|---|
| `l` | `RemoteControlClient.OnPlaybackPositionUpdateListener`: the position update listener to be called <br /> |

### setPlaybackState

Added in [API level 18](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level
21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

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

<br />

| Parameters ||
|---|---|
| `state` | `int`: The current playback state, one of the following values: `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_STOPPED`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_PAUSED`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_PLAYING`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_FAST_FORWARDING`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_REWINDING`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_SKIPPING_FORWARDS`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_SKIPPING_BACKWARDS`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_BUFFERING`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_ERROR`. <br /> |
| `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 `https://developer.android.com/reference/android/media/MediaMetadataRetriever#METADATA_KEY_DURATION` in the `https://developer.android.com/reference/android/media/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 `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_BUFFERING` and nothing had played yet). <br /> |
| `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 `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_ERROR`). <br /> |

### setPlaybackState

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setPlaybackState (int state)
```

Sets the current playback state.

<br />

| Parameters ||
|---|---|
| `state` | `int`: The current playback state, one of the following values: `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_STOPPED`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_PAUSED`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_PLAYING`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_FAST_FORWARDING`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_REWINDING`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_SKIPPING_FORWARDS`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_SKIPPING_BACKWARDS`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_BUFFERING`, `https://developer.android.com/reference/android/media/RemoteControlClient#PLAYSTATE_ERROR`. <br /> |

### setTransportControlFlags

Added in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setTransportControlFlags (int transportControlFlags)
```

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

<br />

| Parameters ||
|---|---|
| `transportControlFlags` | `int`: A combination of the following flags: `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_PREVIOUS`, `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_REWIND`, `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_PLAY`, `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_PLAY_PAUSE`, `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_PAUSE`, `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_STOP`, `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_FAST_FORWARD`, `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_NEXT`, `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_POSITION_UPDATE`, `https://developer.android.com/reference/android/media/RemoteControlClient#FLAG_KEY_MEDIA_RATING`. <br /> |