Package com.brightcove.player.playback

Class PlaybackNotification

java.lang.Object

com.brightcove.player.playback.PlaybackNotification

Direct Known Subclasses:

BrightcoveNotification

public abstract class PlaybackNotification
extends java.lang.Object

Base class for creating and updating a media-style notification.

Action customization

Playback actions can be included or omitted as follows:

• usePlayPauseActions - Sets whether the play and pause actions are used.
  • Corresponding setter: PlaybackNotification.Config.setUsePlayPauseActions(boolean)
  • Default: true
• useRewindAction - Sets whether the rewind action is used.
  • Corresponding setter: PlaybackNotification.Config.setUseRewindAction(boolean)
  • Default: true
• useRewindActionInCompactView - If useRewindAction is true, sets whether the rewind action is also used in compact view (including the lock screen notification). Else does nothing.
  • Corresponding setter: PlaybackNotification.Config.setUseRewindActionInCompactView(boolean)
  • Default: false
• useFastForwardAction - Sets whether the fast forward action is used.
  • Corresponding setter: PlaybackNotification.Config.setUseFastForwardAction(boolean)
  • Default: true
• useFastForwardActionInCompactView - If useFastForwardAction is true, sets whether the fast forward action is also used in compact view (including the lock screen notification). Else does nothing.
  • Corresponding setter: PlaybackNotification.Config.setUseFastForwardActionInCompactView(boolean)
  • Default: false
• usePreviousAction - Whether the previous action is used.
  • Corresponding setter: PlaybackNotification.Config.setUsePreviousAction(boolean)
  • Default: true
• usePreviousActionInCompactView - If usePreviousAction is true, sets whether the previous action is also used in compact view (including the lock screen notification). Else does nothing.
  • Corresponding setter: PlaybackNotification.Config.setUsePreviousActionInCompactView(boolean)
  • Default: false
• useNextAction - Whether the next action is used.
  • Corresponding setter: PlaybackNotification.Config.setUseNextAction(boolean)
  • Default: true
• useNextActionInCompactView - If useNextAction is true, sets whether the next action is also used in compact view (including the lock screen notification). Else does nothing.
  • Corresponding setter: PlaybackNotification.Config.setUseNextActionInCompactView(boolean)
  • Default: false

Overriding drawables

The action icons can be set programatically by using the PlaybackNotification.Config. The large icon (i.e. the icon passed to Notification.Builder.setLargeIcon(Bitmap) is obtained from the PlaybackNotification.MediaDescriptionAdapter passed to PlaybackNotification.Config.setAdapter(MediaDescriptionAdapter)

 notification.setConfig(new MediaPlaybackNotification.Config(this)
     .setSmallIcon(R.mipmap.ic_launcher)
     .setUseNextAction(false)
     .setPriority(NotificationCompat.PRIORITY_MAX)
     .setAdapter(new MediaPlaybackNotification.MediaDescriptionAdapter() {
         @Override
         public CharSequence getCurrentContentTitle(MediaPlayback playback) {
             return "Your custom title";
         }
         @Nullable
         @Override
         public Bitmap getCurrentLargeIcon(MediaPlayback playback, BitmapCallback callback) {
             // TODO: return your bitmap
         }
     })
 );
 

See Also:

PlaybackNotification.Config

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlaybackNotification.Config	The config used to create the on-going notification and update the notification content.
static class	PlaybackNotification.Extras	Extras set on the PendingIntent in the default implementation of the PlaybackNotification.MediaDescriptionAdapter.createCurrentContentIntent(com.brightcove.player.playback.MediaPlayback<?>).
static interface	PlaybackNotification.MediaDescriptionAdapter	An adapter to provide content assets of the media currently playing.
static class	PlaybackNotification.NotificationImageLoader
static interface	PlaybackNotification.OnRestorePlaybackHandler	Interface definition used to restore playback when re-creating an activity when the user clicks on the on-going notification.
static class	PlaybackNotification.StreamType	Types of media to display an ongoing notification for.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_NOTIFICATION_ID	The default notification ID for the MediaPlaybackService

Constructor Summary

Constructors

Constructor	Description
PlaybackNotification()

Method Summary

Modifier and Type	Method	Description
protected abstract void	cancel()	Cancels the notification by setting the player to null.
PlaybackNotification.StreamType[]	getStreamTypes()	Get the supported stream types for showing this notification.
abstract boolean	isVisible()	Check is the notification is showing.
abstract void	setConfig(PlaybackNotification.Config config)	Configure and customize the notification shown for playback.
void	setStreamTypes(PlaybackNotification.StreamType... types)	Set the stream types to show notifications for.
protected abstract boolean	show()	Starts a notification immediately unless the player is in an idle state, in which case the notification is started as soon as the player transitions away from being idle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_NOTIFICATION_ID

public static final int DEFAULT_NOTIFICATION_ID

The default notification ID for the MediaPlaybackService

See Also:

Constant Field Values

Constructor Detail

PlaybackNotification

public PlaybackNotification()

Method Detail

setConfig

public abstract void setConfig(PlaybackNotification.Config config)

Configure and customize the notification shown for playback.

Parameters:

config - The configuration to build the notification.

setStreamTypes

public void setStreamTypes(PlaybackNotification.StreamType... types)

Set the stream types to show notifications for.

Parameters:

types - The types of media for notification playback.

getStreamTypes

public PlaybackNotification.StreamType[] getStreamTypes()

Get the supported stream types for showing this notification.

Returns:

The stream types supported for playback from the notification.

isVisible

public abstract boolean isVisible()

Check is the notification is showing.

Returns:

True if the notification is visible and on-going.

show

protected abstract boolean show()

Starts a notification immediately unless the player is in an idle state, in which case the notification is started as soon as the player transitions away from being idle.

The notification shows if the currently playing PlaybackNotification.StreamType is one of {@link this#getStreamTypes()}

Returns:

True if the notification was created and showing on the device.

cancel

protected abstract void cancel()

Cancels the notification by setting the player to null.

This should be called when the player is released.