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

application

val application: Application?

applicationContext

open val applicationContext: Context?

applicationInfo

open val applicationInfo: ApplicationInfo?

assets

open val assets: AssetManager?

attributionSource

open val attributionSource: AttributionSource

attributionTag

open val attributionTag: String?

baseContext

open val baseContext: Context?

cacheDir

open val cacheDir: File?

classLoader

open val classLoader: ClassLoader?

codeCacheDir

open val codeCacheDir: File?

contentResolver

open val contentResolver: ContentResolver?

dataDir

open val dataDir: File?

deviceId

open val deviceId: Int

display

open val display: Display?

externalCacheDir

open val externalCacheDir: File?

externalCacheDirs

open val externalCacheDirs: Array<out File?>?

externalMediaDirs

open val externalMediaDirs: Array<out File?>?

filesDir

open val filesDir: File?

foregroundServiceType

val foregroundServiceType: Int

isDeviceProtectedStorage

open val isDeviceProtectedStorage: Boolean

isPlaybackOngoing

@get:UnstableApi

open val isPlaybackOngoing: Boolean

isRestricted

open val isRestricted: Boolean

isUiContext

open val isUiContext: Boolean

mainExecutor

open val mainExecutor: Executor?

mainLooper

open val mainLooper: Looper?

noBackupFilesDir

open val noBackupFilesDir: File?

obbDir

open val obbDir: File?

obbDirs

open val obbDirs: Array<out File?>?

opPackageName

open val opPackageName: String

packageCodePath

open val packageCodePath: String?

packageManager

open val packageManager: PackageManager?

packageName

open val packageName: String?

packageResourcePath

open val packageResourcePath: String?

params

open val params: ContextParams?

releaseOnTaskRemoved

var releaseOnTaskRemoved: Boolean

Release on task removed

resources

open val resources: Resources?

sessions

val sessions: List<MediaSession>

theme

open val theme: Resources.Theme?

wallpaper

open val wallpaper: Drawable?

wallpaperDesiredMinimumHeight

open val wallpaperDesiredMinimumHeight: Int

wallpaperDesiredMinimumWidth

open val wallpaperDesiredMinimumWidth: Int

Functions

addSession

fun addSession(p0: MediaSession)

bindIsolatedService

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

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

bindService

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

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

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

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

bindServiceAsUser

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

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

checkCallingOrSelfPermission

open fun checkCallingOrSelfPermission(p0: String): Int

checkCallingOrSelfUriPermission

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

checkCallingOrSelfUriPermissions

open fun checkCallingOrSelfUriPermissions(p0: List<Uri?>, p1: Int): IntArray

checkCallingPermission

open fun checkCallingPermission(p0: String): Int

checkCallingUriPermission

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

checkCallingUriPermissions

open fun checkCallingUriPermissions(p0: List<Uri?>, p1: Int): IntArray

checkContentUriPermissionFull

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

checkPermission

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

checkSelfPermission

open fun checkSelfPermission(p0: String): Int

checkUriPermission

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

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

checkUriPermissions

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

clearListener

@UnstableApi

fun clearListener()

clearWallpaper

open fun ~~clearWallpaper~~()

createAttributionContext

open fun createAttributionContext(p0: String?): Context

createConfigurationContext

open fun createConfigurationContext(p0: Configuration): Context?

createContext

open fun createContext(p0: ContextParams): Context

createContextForSplit

open fun createContextForSplit(p0: String?): Context?

createDeviceContext

open fun createDeviceContext(p0: Int): Context

createDeviceProtectedStorageContext

open fun createDeviceProtectedStorageContext(): Context?

createDisplayContext

open fun createDisplayContext(p0: Display): Context?

createPackageContext

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

createWindowContext

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

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

databaseList

open fun databaseList(): Array<out String?>?

deleteDatabase

open fun deleteDatabase(p0: String?): Boolean

deleteFile

open fun deleteFile(p0: String?): Boolean

deleteSharedPreferences

open fun deleteSharedPreferences(p0: String?): Boolean

enforceCallingOrSelfPermission

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

enforceCallingOrSelfUriPermission

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

enforceCallingPermission

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

enforceCallingUriPermission

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

enforcePermission

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

enforceUriPermission

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

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

fileList

open fun fileList(): Array<out String?>?

getColor

fun getColor(p0: Int): Int

getColorStateList

fun getColorStateList(p0: Int): ColorStateList

getDatabasePath

open fun getDatabasePath(p0: String?): File?

getDir

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

getDrawable

fun getDrawable(p0: Int): Drawable?

getExternalFilesDir

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

getExternalFilesDirs

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

getFileStreamPath

open fun getFileStreamPath(p0: String?): File?

getSharedPreferences

open 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 fun getSystemService(p0: String): Any?

getSystemServiceName

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

getText

fun getText(p0: Int): CharSequence

grantUriPermission

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

isSessionAdded

fun isSessionAdded(p0: MediaSession): Boolean

moveDatabaseFrom

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

moveSharedPreferencesFrom

open 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 fun onBind(@Nullable p0: Intent?): IBinder?

onConfigurationChanged

open fun onConfigurationChanged(p0: Configuration)

onCreate

@CallSuper

open fun onCreate()

onDestroy

open override fun onDestroy()

onGetSession

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

onLowMemory

open fun onLowMemory()

onRebind

open fun onRebind(p0: Intent?)

onStart

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

onStartCommand

@CallSuper

open 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)

open fun onTimeout(p0: Int, p1: Int)

onTrimMemory

open 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 fun openFileInput(p0: String?): FileInputStream?

openFileOutput

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

openOrCreateDatabase

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

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

pauseAllPlayersAndStopSelf

@UnstableApi

open fun pauseAllPlayersAndStopSelf()

peekWallpaper

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

registerComponentCallbacks

open fun registerComponentCallbacks(p0: ComponentCallbacks?)

registerDeviceIdChangeListener

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

registerReceiver

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

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

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

open 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 fun ~~removeStickyBroadcast~~(p0: Intent?)

removeStickyBroadcastAsUser

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

revokeSelfPermissionOnKill

open fun revokeSelfPermissionOnKill(p0: String)

revokeSelfPermissionsOnKill

open fun revokeSelfPermissionsOnKill(p0: Collection<String?>)

revokeUriPermission

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

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

sendBroadcast

open fun sendBroadcast(p0: Intent?)

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

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

sendBroadcastAsUser

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

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

sendBroadcastWithMultiplePermissions

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

sendOrderedBroadcast

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

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

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

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

open 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 fun sendOrderedBroadcastAsUser(p0: Intent?, p1: UserHandle?, p2: String?, p3: BroadcastReceiver?, p4: Handler?, p5: Int, p6: String?, p7: Bundle?)

sendStickyBroadcast

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

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

sendStickyBroadcastAsUser

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

sendStickyOrderedBroadcast

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

sendStickyOrderedBroadcastAsUser

open 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

open fun setTheme(p0: Int)

setWallpaper