PlayerNotificationManager.Builder

Kotlin |Java

class PlayerNotificationManager.Builder

A builder for PlayerNotificationManager instances.

Summary

Public constructors
`Builder( context: Context!, notificationId: @IntRange(from = 1) Int, channelId: String! )` Creates an instance.
`Builder( context: Context!, notificationId: Int, channelId: String!, mediaDescriptionAdapter: PlayerNotificationManager.MediaDescriptionAdapter! )` This function is deprecated. Use `Builder` instead, then call `setMediaDescriptionAdapter`.

Public constructors

Builder(
    context: Context!,
    notificationId: @IntRange(from = 1) Int,
    channelId: String!
)

Creates an instance.

Builder(
    context: Context!,
    notificationId: Int,
    channelId: String!,
    mediaDescriptionAdapter: PlayerNotificationManager.MediaDescriptionAdapter!
)

This function is deprecated.

Use Builder instead, then call setMediaDescriptionAdapter.

Public functions
`PlayerNotificationManager!`	`build()` Builds the `PlayerNotificationManager`.
`PlayerNotificationManager.Builder!`	`setChannelDescriptionResourceId(channelDescriptionResourceId: Int)` The description of the channel.
`PlayerNotificationManager.Builder!`	`setChannelImportance(@NotificationUtil.Importance channelImportance: Int)` The importance of the channel.
`PlayerNotificationManager.Builder!`	`setChannelNameResourceId(channelNameResourceId: Int)` The name of the channel.
`PlayerNotificationManager.Builder!`	`setCustomActionReceiver( customActionReceiver: PlayerNotificationManager.CustomActionReceiver! )` The `CustomActionReceiver` to be used.
`PlayerNotificationManager.Builder!`	`setFastForwardActionIconResourceId( fastForwardActionIconResourceId: Int )` The resource id of the drawable to be used as the icon of action `ACTION_FAST_FORWARD`.
`PlayerNotificationManager.Builder!`	`setGroup(groupKey: String!)` The key of the group the media notification should belong to.
`PlayerNotificationManager.Builder!`	`setMediaDescriptionAdapter( mediaDescriptionAdapter: PlayerNotificationManager.MediaDescriptionAdapter! )` The `MediaDescriptionAdapter` to be queried for the notification contents.
`PlayerNotificationManager.Builder!`	`setNextActionIconResourceId(nextActionIconResourceId: Int)` The resource id of the drawable to be used as the icon of action `ACTION_NEXT`.
`PlayerNotificationManager.Builder!`	`setNotificationListener( notificationListener: PlayerNotificationManager.NotificationListener! )` The `NotificationListener` to be used.
`PlayerNotificationManager.Builder!`	`setPauseActionIconResourceId(pauseActionIconResourceId: Int)` The resource id of the drawable to be used as the icon of action `ACTION_PAUSE`.
`PlayerNotificationManager.Builder!`	`setPlayActionIconResourceId(playActionIconResourceId: Int)` The resource id of the drawable to be used as the icon of action `ACTION_PLAY`.
`PlayerNotificationManager.Builder!`	`setPreviousActionIconResourceId(previousActionIconResourceId: Int)` The resource id of the drawable to be used as the icon of action `ACTION_PREVIOUS`.
`PlayerNotificationManager.Builder!`	`setRewindActionIconResourceId(rewindActionIconResourceId: Int)` The resource id of the drawable to be used as the icon of action `ACTION_REWIND`.
`PlayerNotificationManager.Builder!`	`setSmallIconResourceId(smallIconResourceId: Int)` The resource id of the small icon of the notification shown in the status bar.
`PlayerNotificationManager.Builder!`	`setStopActionIconResourceId(stopActionIconResourceId: Int)` The resource id of the drawable to be used as the icon of action `ACTION_STOP`.

Protected properties
`Int`	`channelDescriptionResourceId`
`String!`	`channelId`
`Int`	`channelImportance`
`Int`	`channelNameResourceId`
`Context!`	`context`
`PlayerNotificationManager.CustomActionReceiver?`	`customActionReceiver`
`Int`	`fastForwardActionIconResourceId`
`String?`	`groupKey`
`PlayerNotificationManager.MediaDescriptionAdapter!`	`mediaDescriptionAdapter`
`Int`	`nextActionIconResourceId`
`Int`	`notificationId`
`PlayerNotificationManager.NotificationListener?`	`notificationListener`
`Int`	`pauseActionIconResourceId`
`Int`	`playActionIconResourceId`
`Int`	`previousActionIconResourceId`
`Int`	`rewindActionIconResourceId`
`Int`	`smallIconResourceId`
`Int`	`stopActionIconResourceId`

Public constructors

Builder

Builder(
    context: Context!,
    notificationId: @IntRange(from = 1) Int,
    channelId: String!
)

Creates an instance.

Parameters
`context: Context!`	The `Context`.
`notificationId: @IntRange(from = 1) Int`	The id of the notification to be posted. Must be greater than 0.
`channelId: String!`	The id of the notification channel of an existing notification channel or of the channel that should be automatically created. In the latter case, `setChannelNameResourceId` needs to be called as well.

Builder

Builder(
    context: Context!,
    notificationId: Int,
    channelId: String!,
    mediaDescriptionAdapter: PlayerNotificationManager.MediaDescriptionAdapter!
)

Public functions

build

fun build(): PlayerNotificationManager!

Builds the PlayerNotificationManager.

setChannelDescriptionResourceId

fun setChannelDescriptionResourceId(channelDescriptionResourceId: Int): PlayerNotificationManager.Builder!

The description of the channel. Ignored if setChannelNameResourceId is not called with a value other than 0. If the application has already created the notification channel, then this method should not be called.

The default is 0.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setChannelImportance

fun setChannelImportance(@NotificationUtil.Importance channelImportance: Int): PlayerNotificationManager.Builder!

The importance of the channel. Ignored if setChannelNameResourceId is not called with a value other than 0. If the application has already created the notification channel, then this method should not be called.

The default is IMPORTANCE_LOW.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setChannelNameResourceId

fun setChannelNameResourceId(channelNameResourceId: Int): PlayerNotificationManager.Builder!

The name of the channel. If set to a value other than 0, the channel is automatically created when build is called. If the application has already created the notification channel, then this method should not be called.

The default is 0.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setCustomActionReceiver

fun setCustomActionReceiver(
    customActionReceiver: PlayerNotificationManager.CustomActionReceiver!
): PlayerNotificationManager.Builder!

The CustomActionReceiver to be used.

The default is null.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setFastForwardActionIconResourceId

fun setFastForwardActionIconResourceId(
    fastForwardActionIconResourceId: Int
): PlayerNotificationManager.Builder!

The resource id of the drawable to be used as the icon of action ACTION_FAST_FORWARD.

The default is R.drawable#exo_notification_fastforward.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setGroup

fun setGroup(groupKey: String!): PlayerNotificationManager.Builder!

The key of the group the media notification should belong to.

The default is null

Returns
`PlayerNotificationManager.Builder!`	This builder.

setMediaDescriptionAdapter

fun setMediaDescriptionAdapter(
    mediaDescriptionAdapter: PlayerNotificationManager.MediaDescriptionAdapter!
): PlayerNotificationManager.Builder!

The MediaDescriptionAdapter to be queried for the notification contents.

The default is DefaultMediaDescriptionAdapter with no PendingIntent

Returns
`PlayerNotificationManager.Builder!`	This builder.

setNextActionIconResourceId

fun setNextActionIconResourceId(nextActionIconResourceId: Int): PlayerNotificationManager.Builder!

The resource id of the drawable to be used as the icon of action ACTION_NEXT.

The default is R.drawable#exo_notification_next.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setNotificationListener

fun setNotificationListener(
    notificationListener: PlayerNotificationManager.NotificationListener!
): PlayerNotificationManager.Builder!

The NotificationListener to be used.

The default is null.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setPauseActionIconResourceId

fun setPauseActionIconResourceId(pauseActionIconResourceId: Int): PlayerNotificationManager.Builder!

The resource id of the drawable to be used as the icon of action ACTION_PAUSE.

The default is R.drawable#exo_notification_pause.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setPlayActionIconResourceId

fun setPlayActionIconResourceId(playActionIconResourceId: Int): PlayerNotificationManager.Builder!

The resource id of the drawable to be used as the icon of action ACTION_PLAY.

The default is R.drawable#exo_notification_play.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setPreviousActionIconResourceId

fun setPreviousActionIconResourceId(previousActionIconResourceId: Int): PlayerNotificationManager.Builder!

The resource id of the drawable to be used as the icon of action ACTION_PREVIOUS.

The default is R.drawable#exo_notification_previous.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setRewindActionIconResourceId

fun setRewindActionIconResourceId(rewindActionIconResourceId: Int): PlayerNotificationManager.Builder!

The resource id of the drawable to be used as the icon of action ACTION_REWIND.

The default is R.drawable#exo_notification_rewind.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setSmallIconResourceId

fun setSmallIconResourceId(smallIconResourceId: Int): PlayerNotificationManager.Builder!

The resource id of the small icon of the notification shown in the status bar. See setSmallIcon.

The default is R.drawable#exo_notification_small_icon.

Returns
`PlayerNotificationManager.Builder!`	This builder.

setStopActionIconResourceId

fun setStopActionIconResourceId(stopActionIconResourceId: Int): PlayerNotificationManager.Builder!

The resource id of the drawable to be used as the icon of action ACTION_STOP.

The default is R.drawable#exo_notification_stop.

Returns
`PlayerNotificationManager.Builder!`	This builder.

Protected properties

channelDescriptionResourceId

protected val channelDescriptionResourceId: Int

channelId

protected val channelId: String!

channelImportance

protected val channelImportance: Int

channelNameResourceId

protected val channelNameResourceId: Int

context

protected val context: Context!

customActionReceiver

protected val customActionReceiver: PlayerNotificationManager.CustomActionReceiver?

fastForwardActionIconResourceId

protected val fastForwardActionIconResourceId: Int

groupKey

protected val groupKey: String?

mediaDescriptionAdapter

protected val mediaDescriptionAdapter: PlayerNotificationManager.MediaDescriptionAdapter!

nextActionIconResourceId

protected val nextActionIconResourceId: Int

notificationId

protected val notificationId: Int

notificationListener

protected val notificationListener: PlayerNotificationManager.NotificationListener?

pauseActionIconResourceId

protected val pauseActionIconResourceId: Int

playActionIconResourceId

protected val playActionIconResourceId: Int

previousActionIconResourceId

protected val previousActionIconResourceId: Int

rewindActionIconResourceId

protected val rewindActionIconResourceId: Int

smallIconResourceId

protected val smallIconResourceId: Int

stopActionIconResourceId

protected val stopActionIconResourceId: Int