sdk/com.brightcove.player.playback/PlaybackNotification

PlaybackNotification

interface PlaybackNotification

Manages the notification displayed with a MediaPlayback.

Types

open class Extras

Extras set on the PendingIntent in the default implementation of the createCurrentContentIntent.

MediaDescriptionAdapter

interface MediaDescriptionAdapter

An adapter to provide content assets of the media currently playing.

NotificationImageLoader

open class NotificationImageLoader

NotificationImageTask

open class NotificationImageTask

OnRestorePlaybackHandler

interface OnRestorePlaybackHandler

Interface definition used to restore playback when re-creating an activity when the user clicks on the on-going notification.

enum StreamType

Types of media to display an ongoing notification for.

Properties

DEFAULT_NOTIFICATION_ID

val DEFAULT_NOTIFICATION_ID: Int = 745815

Functions

abstract fun cancel()

Cancels the notification by setting the player to null.

getMediaSessionNotificationProvider

abstract fun getMediaSessionNotificationProvider(): Provider

abstract fun getPlayback(): MediaPlayback<out Any>

abstract fun getStreamTypes(): Array<PlaybackNotification.StreamType>

Get the supported stream types for showing this notification.

handleCustomCommand

abstract fun handleCustomCommand(mediaSession: MediaSession, controllerInfo: ControllerInfo, customCommand: SessionCommand, args: Bundle): Int

abstract fun isVisible(): Boolean

Check is the notification is showing.

abstract fun setConfig(config: PlaybackNotificationConfig)

Configure and customize the notification shown for playback.

setMediaSessionNotificationActions

abstract fun setMediaSessionNotificationActions(mediaSession: MediaSession, controller: ControllerInfo): ConnectionResult

abstract fun setPlayback(mediaPlayback: MediaPlayback<out Any>)

abstract fun setStreamTypes(types: Array<PlaybackNotification.StreamType>)

Set the stream types to show notifications for.

abstract fun show(): Boolean

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.