Notification.MediaStyle Class

Reference

Definition

Namespace:: Android.App

Assembly:: Mono.Android.dll

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.

Notification style for media playback notifications.

[Android.Runtime.Register("android/app/Notification$MediaStyle", DoNotGenerateAcw=true)]
public class Notification.MediaStyle : Android.App.Notification.Style

[<Android.Runtime.Register("android/app/Notification$MediaStyle", DoNotGenerateAcw=true)>]
type Notification.MediaStyle = class
    inherit Notification.Style

Inheritance: Object

Object

Notification.Style
Notification.MediaStyle

Derived: Android.App.Notification.DecoratedMediaCustomViewStyle

Attributes: RegisterAttribute

Remarks

Notification style for media playback notifications.

In the expanded form, Notification#bigContentView, up to 5 Notification.Actions specified with Notification.Builder#addAction(Action) addAction will be shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to Notification.Builder#setLargeIcon(android.graphics.Bitmap) setLargeIcon() will be treated as album artwork.

Unlike the other styles provided here, MediaStyle can also modify the standard-size Notification#contentView; by providing action indices to #setShowActionsInCompactView(int...) you can promote up to 3 actions to be displayed in the standard view alongside the usual content.

Notifications created with MediaStyle will have their category set to Notification#CATEGORY_TRANSPORT CATEGORY_TRANSPORT unless you set a different category using Notification.Builder#setCategory(String) setCategory().

Finally, if you attach a android.media.session.MediaSession.Token using android.app.Notification.MediaStyle#setMediaSession(MediaSession.Token), the System UI can identify this as a notification representing an active media session and respond accordingly (by showing album artwork in the lockscreen, for example).

Starting at android.os.Build.VERSION_CODES#O Android O any notification that has a media session attached with #setMediaSession(MediaSession.Token) will be colorized. You can opt-out of this behavior by using Notification.Builder#setColorized(boolean).

To use this style with your Notification, feed it to Notification.Builder#setStyle(android.app.Notification.Style) like so:

Notification noti = new Notification.Builder()
                .setSmallIcon(R.drawable.ic_stat_player)
                .setContentTitle(&quot;Track title&quot;)
                .setContentText(&quot;Artist - Album&quot;)
                .setLargeIcon(albumArtBitmap))
                .setStyle(<b>new Notification.MediaStyle()</b>
                    .setMediaSession(mySession))
                .build();

Java documentation for android.app.Notification.MediaStyle.

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

Notification.MediaStyle()	Construct a `MediaStyle` object.
Notification.MediaStyle(IntPtr, JniHandleOwnership)
Notification.MediaStyle(Notification+Builder)	Construct a `MediaStyle` object.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
MBuilder	(Inherited from Notification.Style)
PeerReference	(Inherited from Object)
ThresholdClass
ThresholdType

Methods

Build()	Calls `android.app.Notification.Builder#build()` on the Builder this Style is attached to. (Inherited from Notification.Style)
CheckBuilder()	(Inherited from Notification.Style)
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)
GetStandardView(Int32)	(Inherited from Notification.Style)
InternalSetBigContentTitle(ICharSequence)	Overrides ContentTitle in the big form of the template. (Inherited from Notification.Style)
InternalSetBigContentTitle(String)	Overrides ContentTitle in the big form of the template. (Inherited from Notification.Style)
InternalSetSummaryText(ICharSequence)	Set the first line of text after the detail section in the big form of the template. (Inherited from Notification.Style)
InternalSetSummaryText(String)	Set the first line of text after the detail section in the big form of the template. (Inherited from Notification.Style)
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)
SetBuilder(Notification+Builder)	Attaches a `Notification.Builder` object to this style. (Inherited from Notification.Style)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetMediaSession(MediaSession+Token)	Attach a MediaSession.Token to this Notification.
SetRemotePlaybackInfo(ICharSequence, Int32, PendingIntent)
SetRemotePlaybackInfo(String, Int32, PendingIntent)
SetShowActionsInCompactView(Int32[])	Request actions to be shown in the compact notification view.
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, 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

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

Share via