sdk/com.brightcove.player.playback/PlaybackNotificationConfig

PlaybackNotificationConfig

open class PlaybackNotificationConfig

Constructors

constructor(context: Context)

Create a new instance of the config.

Properties

adapter

open var adapter: PlaybackNotification.MediaDescriptionAdapter

channelId

open var channelId: String

channelImportance

open var channelImportance: Int

channelNameResourceId

open var channelNameResourceId: Int

color

open var color: Int

colorized

open var colorized: Boolean

context

val context: Context

notificationId

open var notificationId: Int

notificationListener

open var notificationListener: BrightcoveNotificationListener

priority

open var priority: Int

smallIconResourceId

open var smallIconResourceId: Int

types

open var types: Array<PlaybackNotification.StreamType>

useFastForwardAction

open var useFastForwardAction: Boolean

useFastForwardActionInCompactView

open var useFastForwardActionInCompactView: Boolean

useNextAction

open var useNextAction: Boolean

useNextActionInCompactView

open var useNextActionInCompactView: Boolean

usePlayPauseActions

open var usePlayPauseActions: Boolean

usePreviousAction

open var usePreviousAction: Boolean

usePreviousActionInCompactView

open var usePreviousActionInCompactView: Boolean

useRewindAction

open var useRewindAction: Boolean

useRewindActionInCompactView

open var useRewindActionInCompactView: Boolean

visibility

open var visibility: Int

Functions

setAdapter

open fun setAdapter(adapter: PlaybackNotification.MediaDescriptionAdapter): PlaybackNotificationConfig

The PlaybackNotification.MediaDescriptionAdapter to be queried for the notification contents.

setChannelId

open fun setChannelId(channelId: String): PlaybackNotificationConfig

The id of the notification channel.

setChannelImportance

open fun setChannelImportance(channelImportance: Int): PlaybackNotificationConfig

The importance of the channel.

setChannelNameResourceId

open fun setChannelNameResourceId(channelNameResourceId: Int): PlaybackNotificationConfig

The name of the channel.

setColor

fun setColor(color: Int): PlaybackNotificationConfig

Sets the accent color of the notification.

setColorized

fun setColorized(colorized: Boolean): PlaybackNotificationConfig

Sets whether the notification should be colorized.

setNotificationId

open fun setNotificationId(notificationId: Int): PlaybackNotificationConfig

The id of the notification to be posted.

setNotificationListener

open fun setNotificationListener(notificationListener: BrightcoveNotificationListener): PlaybackNotificationConfig

The BrightcoveNotificationListener to be used.

setPriority

fun setPriority(priority: Int): PlaybackNotificationConfig

Sets the priority of the notification required for API 25 and lower.

setSmallIcon

fun setSmallIcon(smallIconResourceId: Int): PlaybackNotificationConfig

Sets the small icon of the notification which is also shown in the system status bar.

setStreamTypes

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

Set the types of media to show the playback notification on.

setUseFastForwardAction

fun setUseFastForwardAction(useFastForwardAction: Boolean): PlaybackNotificationConfig

Sets whether the fast forward action should be used.

setUseFastForwardActionInCompactView

fun setUseFastForwardActionInCompactView(useFastForwardActionInCompactView: Boolean): PlaybackNotificationConfig

Sets whether the fast forward action should also be used in compact view.

setUseNextAction

fun setUseNextAction(useNextAction: Boolean): PlaybackNotificationConfig

Sets whether the next action should be used.

setUseNextActionInCompactView

fun setUseNextActionInCompactView(useNextActionInCompactView: Boolean): PlaybackNotificationConfig

If useNextAction is true, sets whether the next action should also be used in compact view.

setUsePlayPauseActions

fun setUsePlayPauseActions(usePlayPauseActions: Boolean): PlaybackNotificationConfig

Sets whether the play and pause actions should be used.

setUsePreviousAction

fun setUsePreviousAction(usePreviousAction: Boolean): PlaybackNotificationConfig

Sets whether the previous action should be used.

setUsePreviousActionInCompactView

fun setUsePreviousActionInCompactView(usePreviousActionInCompactView: Boolean): PlaybackNotificationConfig

If usePreviousAction is true, sets whether the previous action should also be used in compact view.

setUseRewindAction

fun setUseRewindAction(useRewindAction: Boolean): PlaybackNotificationConfig

Sets whether the rewind action should be used.

setUseRewindActionInCompactView

fun setUseRewindActionInCompactView(useRewindActionInCompactView: Boolean): PlaybackNotificationConfig

Sets whether the rewind action should also be used in compact view.

setVisibility

fun setVisibility(visibility: Int): PlaybackNotificationConfig

Sets the visibility of the notification which determines whether and how the notification is shown when the device is in lock screen mode.