MediaSession Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
- 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). To make the session discoverable by other apps, including system apps, #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
| Name | Description |
|---|---|
| MediaSession(Context, String, Bundle, String) |
Creates a new session with a different session owner from the calling app. |
| MediaSession(Context, String, Bundle) |
Creates a new session. |
| MediaSession(Context, String) |
Creates a new session. |
Fields
| Name | Description |
|---|---|
| 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 |
Properties
| Name | Description |
|---|---|
| Active |
Get the current active state of this session. |
| Class |
Returns the runtime class of this |
| 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 |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState |
Gets the state flags last assigned by the runtime. (Inherited from JavaObject) |
| JniPeerMembers |
Gets the JNI metadata used to access members of this Java binding. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| SessionToken |
Retrieve a token object that can be used by apps to create a
|
| 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
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() |
Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject) |
| Equals(Object) |
Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| GetBitmapSizeLimit(Context) |
Gets the media metadata bitmap size limit from a specified context |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| JavaFinalize() |
Obsolete.
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, Handler) |
Set the callback to receive updates for the MediaSession. |
| SetCallback(MediaSession+Callback) |
Set the callback to receive updates for the MediaSession. |
| SetExtras(Bundle) |
Set some extras that can be associated with the |
| 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 |
| 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. |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject) |
| 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>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (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, 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) |
| 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) |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Marks this peer as disposed and calls |
| IJavaPeerable.Finalized() |
Marks this peer as disposed and calls |
| IJavaPeerable.JniObjectReferenceControlBlock |
Gets the native control-block pointer used by this peer. (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Stores the identity hash code supplied by the runtime. (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Replaces the stored managed peer state flags. (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) |
Reuses a compatible managed peer or obtains a wrapper of the requested type. |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |