Notification.MediaStyle
public
static
class
Notification.MediaStyle
extends Notification.Style
Known Direct Subclasses
Notification.DecoratedMediaCustomViewStyle |
Notification style for media custom views that are decorated by the system
Instead of providing a media notification that is completely custom, a developer can set
this style and still obtain system decorations like the notification header with the expand
affordance and actions.
|
|
Notification style for media playback notifications.
In the expanded form, bigContentView
, up to 5
Notification.Action
s specified with
addAction
will be
shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to
setLargeIcon()
will be
treated as album artwork.
Unlike the other styles provided here, MediaStyle can also modify the standard-size
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
CATEGORY_TRANSPORT
unless you set a different
category using setCategory()
.
Finally, if you attach a MediaSession.Token
using
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).
To use this style with your Notification, feed it to
setStyle(android.app.Notification.Style)
like so:
Notification noti = new Notification.Builder()
.setSmallIcon(R.drawable.ic_stat_player)
.setContentTitle("Track title")
.setContentText("Artist - Album")
.setLargeIcon(albumArtBitmap))
.setStyle(new Notification.MediaStyle()
.setMediaSession(mySession))
.build();
Summary
Inherited methods |
From
class
android.app.Notification.Style
|
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
Notification.MediaStyle
Notification.MediaStyle ()
Notification.MediaStyle
Notification.MediaStyle (Notification.Builder builder)
This constructor was deprecated
in API level 24.
use MediaStyle()
.
Parameters |
builder |
Notification.Builder
|
Public methods
setShowActionsInCompactView
Notification.MediaStyle setShowActionsInCompactView (int... actions)
Request up to 3 actions (by index in the order of addition) to be shown in the compact
notification view.
Parameters |
actions |
int :
the indices of the actions to show in the compact notification view
|