Most visited

Recently visited

Results for

Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

MediaControllerCompat

public final class MediaControllerCompat
extends Object

java.lang.Object
↳	android.support.v4.media.session.MediaControllerCompat

Allows an app to interact with an ongoing media session. Media buttons and other commands can be sent to the session. A callback may be registered to receive updates from the session, such as metadata and play state changes.

A MediaController can be created if you have a MediaSessionCompat.Token from the session owner.

MediaController objects are thread-safe.

This is a helper for accessing features in MediaSession introduced after API level 4 in a backwards compatible fashion.

Summary

Nested classes
`class`	`MediaControllerCompat.Callback` Callback for receiving updates on from the session.
`class`	`MediaControllerCompat.PlaybackInfo` Holds information about the way volume is handled for this session.
`class`	`MediaControllerCompat.TransportControls` Interface for controlling media playback on a session.

Public constructors
`MediaControllerCompat(Context context, MediaSessionCompat session)` Creates a media controller from a session.
`MediaControllerCompat(Context context, MediaSessionCompat.Token sessionToken)` Creates a media controller from a session token which may have been obtained from another process.

Public methods
`void`	`adjustVolume(int direction, int flags)` Adjust the volume of the output this session is playing on.
`boolean`	`dispatchMediaButtonEvent(KeyEvent keyEvent)` Send the specified media button event to the session.
`Bundle`	`getExtras()` Get the extras for this session.
`long`	`getFlags()` Get the flags for this session.
`Object`	`getMediaController()` Gets the underlying framework `MediaController` object.
`MediaMetadataCompat`	`getMetadata()` Get the current metadata for this session.
`String`	`getPackageName()` Get the session owner's package name.
`MediaControllerCompat.PlaybackInfo`	`getPlaybackInfo()` Get the current playback info for this session.
`PlaybackStateCompat`	`getPlaybackState()` Get the current playback state for this session.
`List<MediaSessionCompat.QueueItem>`	`getQueue()` Get the current play queue for this session if one is set.
`CharSequence`	`getQueueTitle()` Get the queue title for this session.
`int`	`getRatingType()` Get the rating type supported by the session.
`PendingIntent`	`getSessionActivity()` Get an intent for launching UI associated with this session if one exists.
`MediaSessionCompat.Token`	`getSessionToken()` Get the token for the session this controller is connected to.
`MediaControllerCompat.TransportControls`	`getTransportControls()` Get a `MediaControllerCompat.TransportControls` instance for this session.
`void`	`registerCallback(MediaControllerCompat.Callback callback, Handler handler)` Adds a callback to receive updates from the session.
`void`	`registerCallback(MediaControllerCompat.Callback callback)` Adds a callback to receive updates from the Session.
`void`	`sendCommand(String command, Bundle params, ResultReceiver cb)` Sends a generic command to the session.
`void`	`setVolumeTo(int value, int flags)` Set the volume of the output this session is playing on.
`void`	`unregisterCallback(MediaControllerCompat.Callback callback)` Stop receiving updates on the specified callback.

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 millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

MediaControllerCompat

MediaControllerCompat (Context context, 
                MediaSessionCompat session)

Creates a media controller from a session.

Parameters
`context`	`Context`
`session`	`MediaSessionCompat`: The session to be controlled.

MediaControllerCompat

MediaControllerCompat (Context context, 
                MediaSessionCompat.Token sessionToken)

Creates a media controller from a session token which may have been obtained from another process.

Parameters
`context`	`Context`
`sessionToken`	`MediaSessionCompat.Token`: The token of the session to be controlled.

Throws
`RemoteException`	if the session is not accessible.

Public methods

adjustVolume

void adjustVolume (int direction, 
                int flags)

Adjust the volume of the output this session is playing on. The direction must be one of ADJUST_LOWER, ADJUST_RAISE, or ADJUST_SAME. The command will be ignored if the session does not support VOLUME_CONTROL_RELATIVE or VOLUME_CONTROL_ABSOLUTE. The flags in AudioManager may be used to affect the handling.

Parameters
`direction`	`int`: The direction to adjust the volume in.
`flags`	`int`: Any flags to pass with the command.

See also:

getPlaybackInfo()

dispatchMediaButtonEvent

boolean dispatchMediaButtonEvent (KeyEvent keyEvent)

Send the specified media button event to the session. Only media keys can be sent by this method, other keys will be ignored.

Parameters
`keyEvent`	`KeyEvent`: The media button event to dispatch.

Returns
`boolean`	true if the event was sent to the session, false otherwise.

getExtras

Bundle getExtras ()

Get the extras for this session.

Returns
`Bundle`

getFlags

long getFlags ()

Get the flags for this session. Flags are defined in MediaSessionCompat.

Returns
`long`	The current set of flags for the session.

getMediaController

Object getMediaController ()

Gets the underlying framework MediaController object.

This method is only supported on API 21+.

Returns
`Object`	The underlying `MediaController` object, or null if none.

getMetadata

MediaMetadataCompat getMetadata ()

Get the current metadata for this session.

Returns
`MediaMetadataCompat`	The current MediaMetadata or null.

getPackageName

String getPackageName ()

Get the session owner's package name.

Returns
`String`	The package name of of the session owner.

getPlaybackInfo

MediaControllerCompat.PlaybackInfo getPlaybackInfo ()

Get the current playback info for this session.

Returns
`MediaControllerCompat.PlaybackInfo`	The current playback info or null.

getPlaybackState

PlaybackStateCompat getPlaybackState ()

Get the current playback state for this session.

Returns
`PlaybackStateCompat`	The current PlaybackState or null

getQueue

List<MediaSessionCompat.QueueItem> getQueue ()

Get the current play queue for this session if one is set. If you only care about the current item getMetadata() should be used.

Returns
`List<MediaSessionCompat.QueueItem>`	The current play queue or null.

getQueueTitle

CharSequence getQueueTitle ()

Get the queue title for this session.

Returns
`CharSequence`

getRatingType

int getRatingType ()

Get the rating type supported by the session. One of:

Returns
`int`	The supported rating type

getSessionActivity

PendingIntent getSessionActivity ()

Get an intent for launching UI associated with this session if one exists.

Returns
`PendingIntent`	A `PendingIntent` to launch UI or null.

getSessionToken

MediaSessionCompat.Token getSessionToken ()

Get the token for the session this controller is connected to.

Returns
`MediaSessionCompat.Token`	The session's token.

getTransportControls

MediaControllerCompat.TransportControls getTransportControls ()

Get a MediaControllerCompat.TransportControls instance for this session.

Returns
`MediaControllerCompat.TransportControls`	A controls instance

registerCallback

void registerCallback (MediaControllerCompat.Callback callback, 
                Handler handler)

Adds a callback to receive updates from the session. Updates will be posted on the specified handler's thread.

Parameters
`callback`	`MediaControllerCompat.Callback`: The callback object, must not be null.
`handler`	`Handler`: The handler to post updates on. If null the callers thread will be used.

registerCallback

void registerCallback (MediaControllerCompat.Callback callback)

Adds a callback to receive updates from the Session. Updates will be posted on the caller's thread.

Parameters
`callback`	`MediaControllerCompat.Callback`: The callback object, must not be null.

sendCommand

void sendCommand (String command, 
                Bundle params, 
                ResultReceiver cb)

Sends a generic command to the session. It is up to the session creator to decide what commands and parameters they will support. As such, commands should only be sent to sessions that the controller owns.

Parameters
`command`	`String`: The command to send
`params`	`Bundle`: Any parameters to include with the command
`cb`	`ResultReceiver`: The callback to receive the result on

setVolumeTo

void setVolumeTo (int value, 
                int flags)

Set the volume of the output this session is playing on. The command will be ignored if it does not support VOLUME_CONTROL_ABSOLUTE. The flags in AudioManager may be used to affect the handling.

Parameters
`value`	`int`: The value to set it to, between 0 and the reported max.
`flags`	`int`: Flags from `AudioManager` to include with the volume request.

See also:

getPlaybackInfo()

unregisterCallback

void unregisterCallback (MediaControllerCompat.Callback callback)

Stop receiving updates on the specified callback. If an update has already been posted you may still receive it after calling this method.

Parameters
`callback`	`MediaControllerCompat.Callback`: The callback to remove

Most visited

Recently visited

Results for

MediaControllerCompat

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

MediaControllerCompat

MediaControllerCompat

Public methods

adjustVolume

dispatchMediaButtonEvent

getExtras

getFlags

getMediaController

getMetadata

getPackageName

getPlaybackInfo

getPlaybackState

getQueue

getQueueTitle

getRatingType

getSessionActivity

getSessionToken

getTransportControls

registerCallback

registerCallback

sendCommand

setVolumeTo

unregisterCallback