Package com.brightcove.player.playback

Class BrightcoveNotification

java.lang.Object

com.brightcove.player.playback.PlaybackNotification

com.brightcove.player.playback.BrightcoveNotification

public class BrightcoveNotification
extends PlaybackNotification

Manages the notification displayed with a MediaPlayback.

Nested Class Summary

Nested classes/interfaces inherited from class com.brightcove.player.playback.PlaybackNotification

PlaybackNotification.Config, PlaybackNotification.Extras, PlaybackNotification.MediaDescriptionAdapter, PlaybackNotification.NotificationImageLoader, PlaybackNotification.OnRestorePlaybackHandler, PlaybackNotification.StreamType

Field Summary

Fields inherited from class com.brightcove.player.playback.PlaybackNotification

DEFAULT_NOTIFICATION_ID

Method Summary

Modifier and Type	Method	Description
protected final void	cancel()	Cancels the notification by setting the player to null.
static BrightcoveNotification	getInstance(android.content.Context context)
MediaPlayback<com.google.android.exoplayer2.ExoPlayer>	getPlayback()
final boolean	isVisible()	Check is the notification is showing.
final void	setConfig(PlaybackNotification.Config config)	Configure and customize the notification shown for playback.
protected void	setMediaSessionToken(android.support.v4.media.session.MediaSessionCompat.Token token)	Sets the MediaSessionCompat.Token.
void	setPlayback(MediaPlayback<com.google.android.exoplayer2.ExoPlayer> playback)
protected final 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 com.brightcove.player.playback.PlaybackNotification

getStreamTypes, setStreamTypes

Methods inherited from class java.lang.Object

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

Method Details

setPlayback

public void setPlayback(MediaPlayback<com.google.android.exoplayer2.ExoPlayer> playback)

getPlayback

public MediaPlayback<com.google.android.exoplayer2.ExoPlayer> getPlayback()

setConfig

public final void setConfig(PlaybackNotification.Config config)

Description copied from class: PlaybackNotification

Configure and customize the notification shown for playback.

Specified by:

setConfig in class PlaybackNotification

Parameters:

config - The configuration to build the notification.

show

protected final boolean show()

Description copied from class: PlaybackNotification

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()}

Specified by:

show in class PlaybackNotification

Returns:

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

cancel

protected final void cancel()

Cancels the notification by setting the player to null.

This should be called when the player is released.

Specified by:

cancel in class PlaybackNotification

isVisible

public final boolean isVisible()

Description copied from class: PlaybackNotification

Check is the notification is showing.

Specified by:

isVisible in class PlaybackNotification

Returns:

True if the notification is visible and on-going.

setMediaSessionToken

protected void setMediaSessionToken(android.support.v4.media.session.MediaSessionCompat.Token token)

Sets the MediaSessionCompat.Token.

Parameters:

token - The MediaSessionCompat.Token.

getInstance

public static BrightcoveNotification getInstance(android.content.Context context)