pillarbox-player/ch.srgssr.pillarbox.player.session/PillarboxMediaSessionService

PillarboxMediaSessionService

abstract class PillarboxMediaSessionService : MediaSessionService

PillarboxMediaSessionService implementation of MediaSessionService. It is the recommended way to make background playback for Android.

It handles only one MediaSession with one PillarboxExoPlayer.

Usage: Add these permissions inside your manifest:

<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />

And add your PlaybackService to the application manifest as follow:

<service
    android:name=".service.DemoMediaSessionService"
    android:exported="true"
    android:foregroundServiceType="mediaPlayback">
    <intent-filter>
        <action android:name="androidx.media3.session.MediaSessionService" />
    </intent-filter>
</service>

Use PillarboxMediaController.Builder to connect this Service to a PillarboxMediaController:

coroutineScope.launch() {
    val mediaController: PillarboxPlayer = PillarboxMediaController.Builder(application, DemoMediaLibraryService::class.java)
    doSomethingWith(mediaController)
}
...
mediaController.release() // when the MediaController is no longer needed.

Constructors

PillarboxMediaSessionService

constructor()

Properties

releaseOnTaskRemoved

var releaseOnTaskRemoved: Boolean

Release on task removed

Functions

addSession

fun addSession(p0: MediaSession)

bindIsolatedService

open fun bindIsolatedService(p0: Intent, p1: Context.BindServiceFlags, p2: String, p3: Executor, p4: ServiceConnection): Boolean

open override fun bindIsolatedService(p0: Intent, p1: Int, p2: String, p3: Executor, p4: ServiceConnection): Boolean

bindService

open override fun bindService(p0: Intent, p1: ServiceConnection, p2: Context.BindServiceFlags): Boolean

open override fun bindService(p0: Intent, p1: ServiceConnection, p2: Int): Boolean

open override fun bindService(p0: Intent, p1: Context.BindServiceFlags, p2: Executor, p3: ServiceConnection): Boolean

open override fun bindService(p0: Intent, p1: Int, p2: Executor, p3: ServiceConnection): Boolean

bindServiceAsUser

open override fun bindServiceAsUser(p0: Intent, p1: ServiceConnection, p2: Context.BindServiceFlags, p3: UserHandle): Boolean

open override fun bindServiceAsUser(p0: Intent, p1: ServiceConnection, p2: Int, p3: UserHandle): Boolean

checkCallingOrSelfPermission

open override fun checkCallingOrSelfPermission(p0: String): Int

checkCallingOrSelfUriPermission

open override fun checkCallingOrSelfUriPermission(p0: Uri, p1: Int): Int

checkCallingOrSelfUriPermissions

open override fun checkCallingOrSelfUriPermissions(p0: MutableList<Uri>, p1: Int): IntArray

checkCallingPermission

open override fun checkCallingPermission(p0: String): Int

checkCallingUriPermission

open override fun checkCallingUriPermission(p0: Uri, p1: Int): Int

checkCallingUriPermissions

open override fun checkCallingUriPermissions(p0: MutableList<Uri>, p1: Int): IntArray

checkPermission

open override fun checkPermission(p0: String, p1: Int, p2: Int): Int

checkSelfPermission

open override fun checkSelfPermission(p0: String): Int

checkUriPermission

open override fun checkUriPermission(p0: Uri, p1: Int, p2: Int, p3: Int): Int

open override fun checkUriPermission(p0: Uri?, p1: String?, p2: String?, p3: Int, p4: Int, p5: Int): Int

checkUriPermissions

open override fun checkUriPermissions(p0: MutableList<Uri>, p1: Int, p2: Int, p3: Int): IntArray

clearListener

@UnstableApi

fun clearListener()

clearWallpaper

open override fun ~~clearWallpaper~~()

createAttributionContext

open override fun createAttributionContext(p0: String?): Context

createConfigurationContext

open override fun createConfigurationContext(p0: Configuration): Context

createContext

open override fun createContext(p0: ContextParams): Context

createContextForSplit

open override fun createContextForSplit(p0: String): Context

createDeviceContext

open override fun createDeviceContext(p0: Int): Context

createDeviceProtectedStorageContext

open override fun createDeviceProtectedStorageContext(): Context

createDisplayContext

open override fun createDisplayContext(p0: Display): Context

createPackageContext

open override fun createPackageContext(p0: String, p1: Int): Context

createWindowContext

open override fun createWindowContext(p0: Int, p1: Bundle?): Context

open override fun createWindowContext(p0: Display, p1: Int, p2: Bundle?): Context

databaseList

open override fun databaseList(): Array<String>

deleteDatabase

open override fun deleteDatabase(p0: String): Boolean

deleteFile

open override fun deleteFile(p0: String): Boolean

deleteSharedPreferences

open override fun deleteSharedPreferences(p0: String): Boolean

enforceCallingOrSelfPermission

open override fun enforceCallingOrSelfPermission(p0: String, p1: String?)

enforceCallingOrSelfUriPermission

open override fun enforceCallingOrSelfUriPermission(p0: Uri, p1: Int, p2: String)

enforceCallingPermission

open override fun enforceCallingPermission(p0: String, p1: String?)

enforceCallingUriPermission

open override fun enforceCallingUriPermission(p0: Uri, p1: Int, p2: String)

enforcePermission

open override fun enforcePermission(p0: String, p1: Int, p2: Int, p3: String?)

enforceUriPermission

open override fun enforceUriPermission(p0: Uri, p1: Int, p2: Int, p3: Int, p4: String)

open override fun enforceUriPermission(p0: Uri?, p1: String?, p2: String?, p3: Int, p4: Int, p5: Int, p6: String?)

fileList

open override fun fileList(): Array<String>

getApplication

fun getApplication(): Application

getApplicationContext

open override fun getApplicationContext(): Context

getApplicationInfo

open override fun getApplicationInfo(): ApplicationInfo

getAssets

open override fun getAssets(): AssetManager

getAttributionSource

open override fun getAttributionSource(): AttributionSource

getAttributionTag

open override fun getAttributionTag(): String?

getBaseContext

open fun getBaseContext(): Context

getCacheDir

open override fun getCacheDir(): File

getClassLoader

open override fun getClassLoader(): ClassLoader

getCodeCacheDir

open override fun getCodeCacheDir(): File

getColor

fun getColor(p0: Int): Int

getColorStateList

fun getColorStateList(p0: Int): ColorStateList

getContentResolver

open override fun getContentResolver(): ContentResolver

getDatabasePath

open override fun getDatabasePath(p0: String): File

getDataDir

open override fun getDataDir(): File

getDeviceId

open override fun getDeviceId(): Int

getDir

open override fun getDir(p0: String, p1: Int): File

getDisplay

open override fun getDisplay(): Display?

getDrawable

fun getDrawable(p0: Int): Drawable?

getExternalCacheDir

open override fun getExternalCacheDir(): File?

getExternalCacheDirs

open override fun getExternalCacheDirs(): Array<File>

getExternalFilesDir

open override fun getExternalFilesDir(p0: String?): File?

getExternalFilesDirs

open override fun getExternalFilesDirs(p0: String): Array<File>

getExternalMediaDirs

open override fun getExternalMediaDirs(): Array<File>

getFilesDir

open override fun getFilesDir(): File

getFileStreamPath

open override fun getFileStreamPath(p0: String): File

getForegroundServiceType

fun getForegroundServiceType(): Int

getMainExecutor

open override fun getMainExecutor(): Executor

getMainLooper

open override fun getMainLooper(): Looper

getNoBackupFilesDir

open override fun getNoBackupFilesDir(): File

getObbDir

open override fun getObbDir(): File

getObbDirs

open override fun getObbDirs(): Array<File>

getOpPackageName

open override fun getOpPackageName(): String

getPackageCodePath

open override fun getPackageCodePath(): String

getPackageManager

open override fun getPackageManager(): PackageManager

getPackageName

open override fun getPackageName(): String

getPackageResourcePath

open override fun getPackageResourcePath(): String

getParams

open override fun getParams(): ContextParams?

getResources

open override fun getResources(): Resources

getSessions

fun getSessions(): MutableList<MediaSession>

getSharedPreferences

open override fun getSharedPreferences(p0: String, p1: Int): SharedPreferences

getString

fun getString(p0: Int): String

fun getString(p0: Int, vararg p1: Any): String

getSystemService

fun <T : Any> getSystemService(p0: Class<T>): T

open override fun getSystemService(p0: String): Any

getSystemServiceName

open override fun getSystemServiceName(p0: Class<*>): String?

getText

fun getText(p0: Int): CharSequence

getTheme

open override fun getTheme(): Resources.Theme

getWallpaper

open override fun ~~getWallpaper~~(): Drawable

getWallpaperDesiredMinimumHeight

open override fun ~~getWallpaperDesiredMinimumHeight~~(): Int

getWallpaperDesiredMinimumWidth

open override fun ~~getWallpaperDesiredMinimumWidth~~(): Int

grantUriPermission

open override fun grantUriPermission(p0: String, p1: Uri, p2: Int)

isDeviceProtectedStorage

open override fun isDeviceProtectedStorage(): Boolean

isPlaybackOngoing

@UnstableApi

open fun isPlaybackOngoing(): Boolean

isRestricted

open override fun isRestricted(): Boolean

isSessionAdded

fun isSessionAdded(p0: MediaSession): Boolean

isUiContext

open override fun isUiContext(): Boolean

moveDatabaseFrom

open override fun moveDatabaseFrom(p0: Context, p1: String): Boolean

moveSharedPreferencesFrom

open override fun moveSharedPreferencesFrom(p0: Context, p1: String): Boolean

obtainStyledAttributes

fun obtainStyledAttributes(p0: IntArray): TypedArray

fun obtainStyledAttributes(p0: AttributeSet?, p1: IntArray): TypedArray

fun obtainStyledAttributes(p0: Int, p1: IntArray): TypedArray

fun obtainStyledAttributes(p0: AttributeSet?, p1: IntArray, p2: Int, p3: Int): TypedArray

onBind

@CallSuper

@Nullable

open override fun onBind(@Nullable p0: Intent?): IBinder?

onConfigurationChanged

open override fun onConfigurationChanged(p0: Configuration)

onCreate

@CallSuper

open override fun onCreate()

onDestroy

open override fun onDestroy()

onGetSession

open override fun onGetSession(controllerInfo: MediaSession.ControllerInfo): MediaSession?

onLowMemory

open override fun onLowMemory()

onRebind

open fun onRebind(p0: Intent)

onStart

open fun ~~onStart~~(p0: Intent, p1: Int)

onStartCommand

@CallSuper

open override fun onStartCommand(@Nullable p0: Intent?, p1: Int, p2: Int): Int

onTaskRemoved

open override fun onTaskRemoved(rootIntent: Intent?)

We choose to stop playback when user remove application from the tasks

onTimeout

open fun onTimeout(p0: Int)

onTrimMemory

open override fun onTrimMemory(p0: Int)

onUnbind

open fun onUnbind(p0: Intent): Boolean

onUpdateNotification

open fun ~~onUpdateNotification~~(p0: MediaSession)

open fun onUpdateNotification(p0: MediaSession, p1: Boolean)

openFileInput

open override fun openFileInput(p0: String): FileInputStream

openFileOutput

open override fun openFileOutput(p0: String, p1: Int): FileOutputStream

openOrCreateDatabase

open override fun openOrCreateDatabase(p0: String, p1: Int, p2: SQLiteDatabase.CursorFactory): SQLiteDatabase

open override fun openOrCreateDatabase(p0: String, p1: Int, p2: SQLiteDatabase.CursorFactory, p3: DatabaseErrorHandler?): SQLiteDatabase

pauseAllPlayersAndStopSelf

@UnstableApi

open fun pauseAllPlayersAndStopSelf()

peekWallpaper

open override fun ~~peekWallpaper~~(): Drawable

registerComponentCallbacks

open override fun registerComponentCallbacks(p0: ComponentCallbacks)

registerDeviceIdChangeListener

open override fun registerDeviceIdChangeListener(p0: Executor, p1: IntConsumer)

registerReceiver

open override fun registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter): Intent?

open override fun registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter, p2: Int): Intent?

open override fun registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter, p2: String?, p3: Handler?): Intent?

open override fun registerReceiver(p0: BroadcastReceiver?, p1: IntentFilter, p2: String?, p3: Handler?, p4: Int): Intent?

release

open fun release()

Release the player and the MediaSession. The mediaSession is set to null after this call

removeSession

fun removeSession(p0: MediaSession)

removeStickyBroadcast

open override fun ~~removeStickyBroadcast~~(p0: Intent)

removeStickyBroadcastAsUser

open override fun ~~removeStickyBroadcastAsUser~~(p0: Intent, p1: UserHandle)

revokeSelfPermissionOnKill

open fun revokeSelfPermissionOnKill(p0: String)

revokeSelfPermissionsOnKill

open override fun revokeSelfPermissionsOnKill(p0: MutableCollection<String>)

revokeUriPermission

open override fun revokeUriPermission(p0: Uri, p1: Int)

open override fun revokeUriPermission(p0: String, p1: Uri, p2: Int)

sendBroadcast

open override fun sendBroadcast(p0: Intent)

open override fun sendBroadcast(p0: Intent, p1: String?)

open override fun sendBroadcast(p0: Intent, p1: String?, p2: Bundle?)

sendBroadcastAsUser

open override fun sendBroadcastAsUser(p0: Intent, p1: UserHandle)

open override fun sendBroadcastAsUser(p0: Intent, p1: UserHandle, p2: String?)

sendBroadcastWithMultiplePermissions

open fun sendBroadcastWithMultiplePermissions(p0: Intent, p1: Array<String>)

sendOrderedBroadcast

open override fun sendOrderedBroadcast(p0: Intent, p1: String?)

open override fun sendOrderedBroadcast(p0: Intent, p1: String?, p2: Bundle?)

open override fun sendOrderedBroadcast(p0: Intent, p1: String?, p2: BroadcastReceiver?, p3: Handler?, p4: Int, p5: String?, p6: Bundle?)

open override fun sendOrderedBroadcast(p0: Intent, p1: String?, p2: Bundle?, p3: BroadcastReceiver?, p4: Handler?, p5: Int, p6: String?, p7: Bundle?)

open override fun sendOrderedBroadcast(p0: Intent, p1: String?, p2: String?, p3: BroadcastReceiver?, p4: Handler?, p5: Int, p6: String?, p7: Bundle?)

open fun sendOrderedBroadcast(p0: Intent, p1: Int, p2: String?, p3: String?, p4: BroadcastReceiver?, p5: Handler?, p6: String?, p7: Bundle?, p8: Bundle?)

sendOrderedBroadcastAsUser

open override fun sendOrderedBroadcastAsUser(p0: Intent, p1: UserHandle, p2: String?, p3: BroadcastReceiver?, p4: Handler?, p5: Int, p6: String?, p7: Bundle?)

sendStickyBroadcast

open override fun ~~sendStickyBroadcast~~(p0: Intent)

open override fun ~~sendStickyBroadcast~~(p0: Intent, p1: Bundle?)

sendStickyBroadcastAsUser

open override fun ~~sendStickyBroadcastAsUser~~(p0: Intent, p1: UserHandle)

sendStickyOrderedBroadcast

open override fun ~~sendStickyOrderedBroadcast~~(p0: Intent, p1: BroadcastReceiver?, p2: Handler?, p3: Int, p4: String?, p5: Bundle?)

sendStickyOrderedBroadcastAsUser

open override fun ~~sendStickyOrderedBroadcastAsUser~~(p0: Intent, p1: UserHandle, p2: BroadcastReceiver?, p3: Handler?, p4: Int, p5: String?, p6: Bundle?)

sessionActivity

open fun sessionActivity(): PendingIntent?

Session activity use with mediaSession called when setPlayer

setListener

@UnstableApi

fun setListener(p0: MediaSessionService.Listener)

setPlayer

fun setPlayer(player: PillarboxExoPlayer, mediaSessionCallback: PillarboxMediaSession.Callback = PillarboxMediaSession.Callback.Default, sessionId: String? = null)

Set player to use with this Service.

setTheme