bv-playback-service/com.blendvision.player.playback.service.presentation/BVPlaybackService

BVPlaybackService

abstract class BVPlaybackService : MediaBrowserServiceCompat

Abstract base class for background playback services.

Providing PlayerConfig (choose one)

Option A (recommended): via ServicePlayerConnector.connect The config is passed in the startService Intent and used during initialization.

Option B: override onCreatePlayerConfig as a fallback Called when the Intent carries no config (e.g. on START_STICKY restart after system kill). Returns an empty PlayerConfig by default.

Required Manifest declaration

<service
    android:name=".YourPlaybackService"
    android:exported="true"
    android:foregroundServiceType="mediaPlayback">
    <intent-filter>
        <action android:name="android.media.browse.MediaBrowserService" />
    </intent-filter>
</service>

Constructors

BVPlaybackService

constructor()

Types

Companion

object Companion

PlaybackServiceBinder

inner class PlaybackServiceBinder : Binder

Functions

enterForeground

fun enterForeground()

Called when the app goes to background (from Activity.onStop, before disconnect).

exitForeground

fun exitForeground()

Called when the app returns to the foreground (after connect succeeds in Activity.onStart).

getNotificationSmallIconRes

@DrawableRes

abstract fun getNotificationSmallIconRes(): Int

Returns the small icon resource ID for the notification. Must be a monochrome white vector drawable.

loadMedia

fun loadMedia(mediaConfig: MediaConfig)

loadOfflineMedia

fun loadOfflineMedia(offlineMediaConfig: OfflineMediaConfig)

onBind

open override fun onBind(intent: Intent?): IBinder?

Supports dual binding:

onCreateAnalyticsConfig

open fun onCreateAnalyticsConfig(): AnalyticsConfig?

Fallback called when the Intent carries no AnalyticsConfig. Not required if the config is always provided via ServicePlayerConnector.connect.

onCreateContentIntent

open fun onCreateContentIntent(): PendingIntent?

Returns the PendingIntent to launch when the notification is tapped. Defaults to the app's launcher Activity; override to target a specific screen.

onCreatePlayerConfig

open fun onCreatePlayerConfig(): PlayerConfig

Fallback called when the Intent carries no PlayerConfig (e.g. after a system kill + START_STICKY restart). Not required if the config is always provided via ServicePlayerConnector.connect.

onDestroy

open override fun onDestroy()

onGetRoot

open override fun onGetRoot(clientPackageName: String, clientUid: Int, rootHints: Bundle?): MediaBrowserServiceCompat.BrowserRoot?

Restricts MediaBrowser connections to clients within the same package by default. Override to allow external browsers (e.g. Android Auto).

onLoadChildren

open override fun onLoadChildren(parentId: String, result: MediaBrowserServiceCompat.Result<MutableList<MediaBrowserCompat.MediaItem>>)

onStartCommand

open override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int

onTaskRemoved

open override fun onTaskRemoved(rootIntent: Intent?)

updateMediaInfo

fun updateMediaInfo(title: String, artist: String = "", artwork: ArtworkSource = ArtworkSource.None)

Updates what the notification and the media session show for the current media.