MediaSession Class

Definition

Allows interaction with media controllers, volume keys, media buttons, and transport controls.

[Android.Runtime.Register("android/media/session/MediaSession", DoNotGenerateAcw=true)]
public sealed class MediaSession : Java.Lang.Object
[<Android.Runtime.Register("android/media/session/MediaSession", DoNotGenerateAcw=true)>]
type MediaSession = class
    inherit Object
Inheritance
MediaSession
Attributes

Remarks

Allows interaction with media controllers, volume keys, media buttons, and transport controls.

A MediaSession should be created when an app wants to publish media playback information or handle media keys. In general an app only needs one session for all playback, though multiple sessions can be created to provide finer grain controls of media.

Once a session is created the owner of the session may pass its #getSessionToken() session token to other processes to allow them to create a MediaController to interact with the session.

To receive commands, media keys, and other events a Callback must be set with #setCallback(Callback) and #setActive(boolean) setActive(true) must be called.

When an app is finished performing playback it must call #release() to clean up the session and notify any controllers.

MediaSession objects are thread safe.

Java documentation for android.media.session.MediaSession.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

MediaSession(Context, String)

Creates a new session.

MediaSession(Context, String, Bundle)

Creates a new session.

Fields

FlagHandlesMediaButtons

Set this flag on the session to indicate that it can handle media button events.

FlagHandlesTransportControls

Set this flag on the session to indicate that it handles transport control commands through its Callback.

Properties

Active

Get the current active state of this session. -or- Set if this session is currently active and ready to receive commands.

Class

Returns the runtime class of this Object.

(Inherited from Object)
Controller

Get a controller for this session.

CurrentControllerInfo

Gets the controller information who sent the current request.

Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode (Inherited from Object)
JniPeerMembers
PeerReference (Inherited from Object)
SessionToken

Retrieve a token object that can be used by apps to create a MediaController for interacting with this session.

ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

(Inherited from Object)
ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

(Inherited from Object)

Methods

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Dispose() (Inherited from Object)
Dispose(Boolean) (Inherited from Object)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
Release()

This must be called when an app has finished performing playback.

SendSessionEvent(String, Bundle)

Send a proprietary event to all MediaControllers listening to this Session.

SetCallback(MediaSession+Callback)

Set the callback to receive updates for the MediaSession.

SetCallback(MediaSession+Callback, Handler)

Set the callback to receive updates for the MediaSession.

SetExtras(Bundle)

Set some extras that can be associated with the MediaSession.

SetFlags(MediaSessionFlags)

Set any flags for the session.

SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetMediaButtonBroadcastReceiver(ComponentName)

Set the component name of the manifest-declared android.content.BroadcastReceiver class that should receive media buttons.

SetMediaButtonReceiver(PendingIntent)

Set a pending intent for your media button receiver to allow restarting playback after the session has been stopped.

SetMetadata(MediaMetadata)

Update the current metadata.

SetPlaybackState(PlaybackState)

Update the current playback state.

SetPlaybackToLocal(AudioAttributes)

Set the attributes for this session's audio.

SetPlaybackToRemote(VolumeProvider)

Configure this session to use remote volume handling.

SetQueue(IList<MediaSession.QueueItem>)

Update the list of items in the play queue.

SetQueueTitle(ICharSequence)

Set the title of the play queue.

SetQueueTitle(String)

Set the title of the play queue.

SetRatingType(RatingStyle)

Set the style of rating used by this session.

SetSessionActivity(PendingIntent)

Set an intent for launching UI for this Session.

ToArray<T>() (Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime() (Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed() (Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced() (Inherited from Object)
IJavaPeerable.Finalized() (Inherited from Object)
IJavaPeerable.JniManagedPeerState (Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32) (Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) (Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference) (Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to