MediaSessionService

Kotlin |Java

public abstract class MediaSessionService
extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	androidx.media2.session.MediaSessionService

Known direct subclasses

MediaLibraryService

MediaLibraryService Base class for media library services, which is the service containing MediaLibraryService.MediaLibrarySession.

Base class for media session services, which is the service containing MediaSession.

It's highly recommended for an app to use this if it wants to keep media playback in the background.

Here are the benefits of using MediaSessionService.

Another app can know that your app supports MediaSession even when your app isn't running.
Another app can start playback of your app even when your app isn't running.

For example, user's voice command can start playback of your app even when it's not running.

To extend this class, adding followings directly to your AndroidManifest.xml.

 <service android:name="component_name_of_your_implementation" >
   <intent-filter>
     <action android:name="androidx.media2.session.MediaSessionService" />
   </intent-filter>
 </service>

You may also declare

android.media.browse.MediaBrowserService

for compatibility with MediaBrowserCompat. This service can handle it automatically.

It's recommended for an app to have a single MediaSessionService declared in the manifest. Otherwise, your app might be shown twice in the list of the Auto/Wearable, or another app fails to pick the right session service when it wants to start the playback of this app. If you want to provide multiple sessions here, take a look at Supporting Multiple Sessions.

Topics covered here:

Service Lifecycle
Permissions
Supporting Multiple Sessions

Service Lifecycle

Session service is a bound service. When a MediaController is created for the session service, the controller binds to the session service. onGetSession(ControllerInfo) would be called inside of the onBind(Intent).

After the binding, session's MediaSession.SessionCallback.onConnect(MediaSession, MediaSession.ControllerInfo) will be called to accept or reject connection request from a controller. If the connection is rejected, the controller will unbind. If it's accepted, the controller will be available to use and keep binding.

When playback is started for this session service, onUpdateNotification(MediaSession) is called for the playback's session and service would become a foreground service. It's needed to keep playback after the controller is destroyed. The session service becomes background service when all playbacks are stopped. Apps targeting API Build.VERSION_CODES.P or later must request the permission Manifest.permission.FOREGROUND_SERVICE in order to make the service foreground.

The service is destroyed when the all sessions are closed, or no media controller is binding to the session while the service is not running as a foreground service.

Permissions

Any app can bind to the session service with controller, but the controller can be used only if the session service accepted the connection request through MediaSession.SessionCallback.onConnect(MediaSession, MediaSession.ControllerInfo).

Supporting Multiple Sessions

Generally speaking, multiple sessions aren't necessary for most media apps. One exception is if your app can play multiple media content at the same time, but only for the playback of video-only media or remote playback, since audio focus policy recommends not playing multiple audio content at the same time. Also keep in mind that multiple media sessions would make Android Auto and Bluetooth device with display to show your apps multiple times, because they list up media sessions, not media apps.

However, if you're capable of handling multiple playback and want to keep their sessions while the app is in the background, create multiple sessions and add to this service with addSession(MediaSession).

Note that MediaController can be created with SessionToken for connecting any session in this service. In that case, onGetSession(ControllerInfo) will be called to know which session to handle incoming connection request. Pick the best session among added sessions, or create new one and return from the onGetSession(ControllerInfo).

Summary

Nested classes
`class`	`MediaSessionService.MediaNotification` Returned by `MediaSessionService.onUpdateNotification(MediaSession)` for making session service foreground service to keep playback running in the background.

Constants
`String`	`SERVICE_INTERFACE` The `Intent` that must be declared as handled by the service.

Inherited constants

From class android.app.Service

`int`	`START_CONTINUATION_MASK`
`int`	`START_FLAG_REDELIVERY`
`int`	`START_FLAG_RETRY`
`int`	`START_NOT_STICKY`
`int`	`START_REDELIVER_INTENT`
`int`	`START_STICKY`
`int`	`START_STICKY_COMPATIBILITY`
`int`	`STOP_FOREGROUND_DETACH`
`int`	`STOP_FOREGROUND_REMOVE`

From class android.content.Context

`String`	`ACCESSIBILITY_SERVICE`
`String`	`ACCOUNT_SERVICE`
`String`	`ACTIVITY_SERVICE`
`String`	`ALARM_SERVICE`
`String`	`APPWIDGET_SERVICE`
`String`	`APP_OPS_SERVICE`
`String`	`AUDIO_SERVICE`
`String`	`BATTERY_SERVICE`
`int`	`BIND_ABOVE_CLIENT`
`int`	`BIND_ADJUST_WITH_ACTIVITY`
`int`	`BIND_ALLOW_OOM_MANAGEMENT`
`int`	`BIND_AUTO_CREATE`
`int`	`BIND_DEBUG_UNBIND`
`int`	`BIND_EXTERNAL_SERVICE`
`int`	`BIND_IMPORTANT`
`int`	`BIND_INCLUDE_CAPABILITIES`
`int`	`BIND_NOT_FOREGROUND`
`int`	`BIND_NOT_PERCEPTIBLE`
`int`	`BIND_WAIVE_PRIORITY`
`String`	`BIOMETRIC_SERVICE`
`String`	`BLOB_STORE_SERVICE`
`String`	`BLUETOOTH_SERVICE`
`String`	`CAMERA_SERVICE`
`String`	`CAPTIONING_SERVICE`
`String`	`CARRIER_CONFIG_SERVICE`
`String`	`CLIPBOARD_SERVICE`
`String`	`COMPANION_DEVICE_SERVICE`
`String`	`CONNECTIVITY_DIAGNOSTICS_SERVICE`
`String`	`CONNECTIVITY_SERVICE`
`String`	`CONSUMER_IR_SERVICE`
`int`	`CONTEXT_IGNORE_SECURITY`
`int`	`CONTEXT_INCLUDE_CODE`
`int`	`CONTEXT_RESTRICTED`
`String`	`CROSS_PROFILE_APPS_SERVICE`
`String`	`DEVICE_POLICY_SERVICE`
`String`	`DISPLAY_SERVICE`
`String`	`DOWNLOAD_SERVICE`
`String`	`DROPBOX_SERVICE`
`String`	`EUICC_SERVICE`
`String`	`FILE_INTEGRITY_SERVICE`
`String`	`FINGERPRINT_SERVICE`
`String`	`HARDWARE_PROPERTIES_SERVICE`
`String`	`INPUT_METHOD_SERVICE`
`String`	`INPUT_SERVICE`
`String`	`IPSEC_SERVICE`
`String`	`JOB_SCHEDULER_SERVICE`
`String`	`KEYGUARD_SERVICE`
`String`	`LAUNCHER_APPS_SERVICE`
`String`	`LAYOUT_INFLATER_SERVICE`
`String`	`LOCATION_SERVICE`
`String`	`MEDIA_PROJECTION_SERVICE`
`String`	`MEDIA_ROUTER_SERVICE`
`String`	`MEDIA_SESSION_SERVICE`
`String`	`MIDI_SERVICE`
`int`	`MODE_APPEND`
`int`	`MODE_ENABLE_WRITE_AHEAD_LOGGING`
`int`	`MODE_MULTI_PROCESS`
`int`	`MODE_NO_LOCALIZED_COLLATORS`
`int`	`MODE_PRIVATE`
`int`	`MODE_WORLD_READABLE`
`int`	`MODE_WORLD_WRITEABLE`
`String`	`NETWORK_STATS_SERVICE`
`String`	`NFC_SERVICE`
`String`	`NOTIFICATION_SERVICE`
`String`	`NSD_SERVICE`
`String`	`POWER_SERVICE`
`String`	`PRINT_SERVICE`
`int`	`RECEIVER_VISIBLE_TO_INSTANT_APPS`
`String`	`RESTRICTIONS_SERVICE`
`String`	`ROLE_SERVICE`
`String`	`SEARCH_SERVICE`
`String`	`SENSOR_SERVICE`
`String`	`SHORTCUT_SERVICE`
`String`	`STORAGE_SERVICE`
`String`	`STORAGE_STATS_SERVICE`
`String`	`SYSTEM_HEALTH_SERVICE`
`String`	`TELECOM_SERVICE`
`String`	`TELEPHONY_IMS_SERVICE`
`String`	`TELEPHONY_SERVICE`
`String`	`TELEPHONY_SUBSCRIPTION_SERVICE`
`String`	`TEXT_CLASSIFICATION_SERVICE`
`String`	`TEXT_SERVICES_MANAGER_SERVICE`
`String`	`TV_INPUT_SERVICE`
`String`	`UI_MODE_SERVICE`
`String`	`USAGE_STATS_SERVICE`
`String`	`USB_SERVICE`
`String`	`USER_SERVICE`
`String`	`VIBRATOR_SERVICE`
`String`	`VPN_MANAGEMENT_SERVICE`
`String`	`WALLPAPER_SERVICE`
`String`	`WIFI_AWARE_SERVICE`
`String`	`WIFI_P2P_SERVICE`
`String`	`WIFI_RTT_RANGING_SERVICE`
`String`	`WIFI_SERVICE`
`String`	`WINDOW_SERVICE`

From interface android.content.ComponentCallbacks2

`int`	`TRIM_MEMORY_BACKGROUND`
`int`	`TRIM_MEMORY_COMPLETE`
`int`	`TRIM_MEMORY_MODERATE`
`int`	`TRIM_MEMORY_RUNNING_CRITICAL`
`int`	`TRIM_MEMORY_RUNNING_LOW`
`int`	`TRIM_MEMORY_RUNNING_MODERATE`
`int`	`TRIM_MEMORY_UI_HIDDEN`

Public constructors
`MediaSessionService()`

Public methods
`final void`	`addSession(MediaSession session)` Adds a session to this service.
`final List<MediaSession>`	`getSessions()` Gets the list of `MediaSession`s that you've added to this service via `addSession(MediaSession)` or `onGetSession(ControllerInfo)`.
`IBinder`	`onBind(Intent intent)` Default implementation for `MediaSessionService` to handle incoming binding request.
`void`	`onCreate()` Called by the system when the service is first created.
`void`	`onDestroy()` Called by the system to notify that it is no longer used and is being removed.
`abstract MediaSession`	`onGetSession(MediaSession.ControllerInfo controllerInfo)` Called when a `MediaController` is created with the this service's `SessionToken`.
`int`	`onStartCommand(Intent intent, int flags, int startId)`
`MediaSessionService.MediaNotification`	`onUpdateNotification(MediaSession session)` Called when notification UI needs update.
`final void`	`removeSession(MediaSession session)` Removes a session from this service.

Inherited methods

From class


        
          android.app.Service

`void`	`attachBaseContext(Context arg0)`
`void`	`dump(FileDescriptor arg0, PrintWriter arg1, String[] arg2)`
`final Application`	`getApplication()`
`final int`	`getForegroundServiceType()`
`abstract IBinder`	`onBind(Intent arg0)`
`void`	`onConfigurationChanged(Configuration arg0)`
`void`	`onCreate()`
`void`	`onDestroy()`
`void`	`onLowMemory()`
`void`	`onRebind(Intent arg0)`
`void`	`onStart(Intent arg0, int arg1)`
`int`	`onStartCommand(Intent arg0, int arg1, int arg2)`
`void`	`onTaskRemoved(Intent arg0)`
`void`	`onTrimMemory(int arg0)`
`boolean`	`onUnbind(Intent arg0)`
`final void`	`startForeground(int arg0, Notification arg1)`
`final void`	`startForeground(int arg0, Notification arg1, int arg2)`
`final void`	`stopForeground(int arg0)`
`final void`	`stopForeground(boolean arg0)`
`final void`	`stopSelf()`
`final void`	`stopSelf(int arg0)`
`final boolean`	`stopSelfResult(int arg0)`

From class


        
          android.content.ContextWrapper

`void`	`attachBaseContext(Context arg0)`
`boolean`	`bindIsolatedService(Intent arg0, int arg1, String arg2, Executor arg3, ServiceConnection arg4)`
`boolean`	`bindService(Intent arg0, int arg1, Executor arg2, ServiceConnection arg3)`
`boolean`	`bindService(Intent arg0, ServiceConnection arg1, int arg2)`
`boolean`	`bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3)`
`int`	`checkCallingOrSelfPermission(String arg0)`
`int`	`checkCallingOrSelfUriPermission(Uri arg0, int arg1)`
`int`	`checkCallingPermission(String arg0)`
`int`	`checkCallingUriPermission(Uri arg0, int arg1)`
`int`	`checkPermission(String arg0, int arg1, int arg2)`
`int`	`checkSelfPermission(String arg0)`
`int`	`checkUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5)`
`int`	`checkUriPermission(Uri arg0, int arg1, int arg2, int arg3)`
`void`	`clearWallpaper()`
`Context`	`createAttributionContext(String arg0)`
`Context`	`createConfigurationContext(Configuration arg0)`
`Context`	`createContextForSplit(String arg0)`
`Context`	`createDeviceProtectedStorageContext()`
`Context`	`createDisplayContext(Display arg0)`
`Context`	`createPackageContext(String arg0, int arg1)`
`Context`	`createWindowContext(int arg0, Bundle arg1)`
`String[]`	`databaseList()`
`boolean`	`deleteDatabase(String arg0)`
`boolean`	`deleteFile(String arg0)`
`boolean`	`deleteSharedPreferences(String arg0)`
`void`	`enforceCallingOrSelfPermission(String arg0, String arg1)`
`void`	`enforceCallingOrSelfUriPermission(Uri arg0, int arg1, String arg2)`
`void`	`enforceCallingPermission(String arg0, String arg1)`
`void`	`enforceCallingUriPermission(Uri arg0, int arg1, String arg2)`
`void`	`enforcePermission(String arg0, int arg1, int arg2, String arg3)`
`void`	`enforceUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5, String arg6)`
`void`	`enforceUriPermission(Uri arg0, int arg1, int arg2, int arg3, String arg4)`
`String[]`	`fileList()`
`Context`	`getApplicationContext()`
`ApplicationInfo`	`getApplicationInfo()`
`AssetManager`	`getAssets()`
`String`	`getAttributionTag()`
`Context`	`getBaseContext()`
`File`	`getCacheDir()`
`ClassLoader`	`getClassLoader()`
`File`	`getCodeCacheDir()`
`ContentResolver`	`getContentResolver()`
`File`	`getDataDir()`
`File`	`getDatabasePath(String arg0)`
`File`	`getDir(String arg0, int arg1)`
`Display`	`getDisplay()`
`File`	`getExternalCacheDir()`
`File[]`	`getExternalCacheDirs()`
`File`	`getExternalFilesDir(String arg0)`
`File[]`	`getExternalFilesDirs(String arg0)`
`File[]`	`getExternalMediaDirs()`
`File`	`getFileStreamPath(String arg0)`
`File`	`getFilesDir()`
`Executor`	`getMainExecutor()`
`Looper`	`getMainLooper()`
`File`	`getNoBackupFilesDir()`
`File`	`getObbDir()`
`File[]`	`getObbDirs()`
`String`	`getOpPackageName()`
`String`	`getPackageCodePath()`
`PackageManager`	`getPackageManager()`
`String`	`getPackageName()`
`String`	`getPackageResourcePath()`
`Resources`	`getResources()`
`SharedPreferences`	`getSharedPreferences(String arg0, int arg1)`
`Object`	`getSystemService(String arg0)`
`String`	`getSystemServiceName(Class<?> arg0)`
`Resources.Theme`	`getTheme()`
`Drawable`	`getWallpaper()`
`int`	`getWallpaperDesiredMinimumHeight()`
`int`	`getWallpaperDesiredMinimumWidth()`
`void`	`grantUriPermission(String arg0, Uri arg1, int arg2)`
`boolean`	`isDeviceProtectedStorage()`
`boolean`	`isRestricted()`
`boolean`	`moveDatabaseFrom(Context arg0, String arg1)`
`boolean`	`moveSharedPreferencesFrom(Context arg0, String arg1)`
`FileInputStream`	`openFileInput(String arg0)`
`FileOutputStream`	`openFileOutput(String arg0, int arg1)`
`SQLiteDatabase`	`openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2, DatabaseErrorHandler arg3)`
`SQLiteDatabase`	`openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2)`
`Drawable`	`peekWallpaper()`
`Intent`	`registerReceiver(BroadcastReceiver arg0, IntentFilter arg1)`
`Intent`	`registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, int arg2)`
`Intent`	`registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3, int arg4)`
`Intent`	`registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3)`
`void`	`removeStickyBroadcast(Intent arg0)`
`void`	`removeStickyBroadcastAsUser(Intent arg0, UserHandle arg1)`
`void`	`revokeUriPermission(Uri arg0, int arg1)`
`void`	`revokeUriPermission(String arg0, Uri arg1, int arg2)`
`void`	`sendBroadcast(Intent arg0, String arg1)`
`void`	`sendBroadcast(Intent arg0)`
`void`	`sendBroadcastAsUser(Intent arg0, UserHandle arg1)`
`void`	`sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2)`
`void`	`sendOrderedBroadcast(Intent arg0, String arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)`
`void`	`sendOrderedBroadcast(Intent arg0, int arg1, String arg2, String arg3, BroadcastReceiver arg4, Handler arg5, String arg6, Bundle arg7, Bundle arg8)`
`void`	`sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6)`
`void`	`sendOrderedBroadcast(Intent arg0, String arg1)`
`void`	`sendOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)`
`void`	`sendStickyBroadcast(Intent arg0)`
`void`	`sendStickyBroadcastAsUser(Intent arg0, UserHandle arg1)`
`void`	`sendStickyOrderedBroadcast(Intent arg0, BroadcastReceiver arg1, Handler arg2, int arg3, String arg4, Bundle arg5)`
`void`	`sendStickyOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6)`
`void`	`setTheme(int arg0)`
`void`	`setWallpaper(Bitmap arg0)`
`void`	`setWallpaper(InputStream arg0)`
`void`	`startActivities(Intent[] arg0, Bundle arg1)`
`void`	`startActivities(Intent[] arg0)`
`void`	`startActivity(Intent arg0)`
`void`	`startActivity(Intent arg0, Bundle arg1)`
`ComponentName`	`startForegroundService(Intent arg0)`
`boolean`	`startInstrumentation(ComponentName arg0, String arg1, Bundle arg2)`
`void`	`startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4)`
`void`	`startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5)`
`ComponentName`	`startService(Intent arg0)`
`boolean`	`stopService(Intent arg0)`
`void`	`unbindService(ServiceConnection arg0)`
`void`	`unregisterReceiver(BroadcastReceiver arg0)`
`void`	`updateServiceGroup(ServiceConnection arg0, int arg1, int arg2)`

From class


        
          android.content.Context

`boolean`	`bindIsolatedService(Intent arg0, int arg1, String arg2, Executor arg3, ServiceConnection arg4)`
`boolean`	`bindService(Intent arg0, int arg1, Executor arg2, ServiceConnection arg3)`
`abstract boolean`	`bindService(Intent arg0, ServiceConnection arg1, int arg2)`
`boolean`	`bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3)`
`abstract int`	`checkCallingOrSelfPermission(String arg0)`
`abstract int`	`checkCallingOrSelfUriPermission(Uri arg0, int arg1)`
`abstract int`	`checkCallingPermission(String arg0)`
`abstract int`	`checkCallingUriPermission(Uri arg0, int arg1)`
`abstract int`	`checkPermission(String arg0, int arg1, int arg2)`
`abstract int`	`checkSelfPermission(String arg0)`
`abstract int`	`checkUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5)`
`abstract int`	`checkUriPermission(Uri arg0, int arg1, int arg2, int arg3)`
`abstract void`	`clearWallpaper()`
`Context`	`createAttributionContext(String arg0)`
`abstract Context`	`createConfigurationContext(Configuration arg0)`
`abstract Context`	`createContextForSplit(String arg0)`
`abstract Context`	`createDeviceProtectedStorageContext()`
`abstract Context`	`createDisplayContext(Display arg0)`
`abstract Context`	`createPackageContext(String arg0, int arg1)`
`Context`	`createWindowContext(int arg0, Bundle arg1)`
`abstract String[]`	`databaseList()`
`abstract boolean`	`deleteDatabase(String arg0)`
`abstract boolean`	`deleteFile(String arg0)`
`abstract boolean`	`deleteSharedPreferences(String arg0)`
`abstract void`	`enforceCallingOrSelfPermission(String arg0, String arg1)`
`abstract void`	`enforceCallingOrSelfUriPermission(Uri arg0, int arg1, String arg2)`
`abstract void`	`enforceCallingPermission(String arg0, String arg1)`
`abstract void`	`enforceCallingUriPermission(Uri arg0, int arg1, String arg2)`
`abstract void`	`enforcePermission(String arg0, int arg1, int arg2, String arg3)`
`abstract void`	`enforceUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5, String arg6)`
`abstract void`	`enforceUriPermission(Uri arg0, int arg1, int arg2, int arg3, String arg4)`
`abstract String[]`	`fileList()`
`abstract Context`	`getApplicationContext()`
`abstract ApplicationInfo`	`getApplicationInfo()`
`abstract AssetManager`	`getAssets()`
`String`	`getAttributionTag()`
`abstract File`	`getCacheDir()`
`abstract ClassLoader`	`getClassLoader()`
`abstract File`	`getCodeCacheDir()`
`final int`	`getColor(int arg0)`
`final ColorStateList`	`getColorStateList(int arg0)`
`abstract ContentResolver`	`getContentResolver()`
`abstract File`	`getDataDir()`
`abstract File`	`getDatabasePath(String arg0)`
`abstract File`	`getDir(String arg0, int arg1)`
`Display`	`getDisplay()`
`final Drawable`	`getDrawable(int arg0)`
`abstract File`	`getExternalCacheDir()`
`abstract File[]`	`getExternalCacheDirs()`
`abstract File`	`getExternalFilesDir(String arg0)`
`abstract File[]`	`getExternalFilesDirs(String arg0)`
`abstract File[]`	`getExternalMediaDirs()`
`abstract File`	`getFileStreamPath(String arg0)`
`abstract File`	`getFilesDir()`
`Executor`	`getMainExecutor()`
`abstract Looper`	`getMainLooper()`
`abstract File`	`getNoBackupFilesDir()`
`abstract File`	`getObbDir()`
`abstract File[]`	`getObbDirs()`
`String`	`getOpPackageName()`
`abstract String`	`getPackageCodePath()`
`abstract PackageManager`	`getPackageManager()`
`abstract String`	`getPackageName()`
`abstract String`	`getPackageResourcePath()`
`abstract Resources`	`getResources()`
`abstract SharedPreferences`	`getSharedPreferences(String arg0, int arg1)`
`final String`	`getString(int arg0, Object... arg1)`
`final String`	`getString(int arg0)`
`final <T> T`	`getSystemService(Class<T> arg0)`
`abstract Object`	`getSystemService(String arg0)`
`abstract String`	`getSystemServiceName(Class<?> arg0)`
`final CharSequence`	`getText(int arg0)`
`abstract Resources.Theme`	`getTheme()`
`abstract Drawable`	`getWallpaper()`
`abstract int`	`getWallpaperDesiredMinimumHeight()`
`abstract int`	`getWallpaperDesiredMinimumWidth()`
`abstract void`	`grantUriPermission(String arg0, Uri arg1, int arg2)`
`abstract boolean`	`isDeviceProtectedStorage()`
`boolean`	`isRestricted()`
`abstract boolean`	`moveDatabaseFrom(Context arg0, String arg1)`
`abstract boolean`	`moveSharedPreferencesFrom(Context arg0, String arg1)`
`final TypedArray`	`obtainStyledAttributes(AttributeSet arg0, int[] arg1)`
`final TypedArray`	`obtainStyledAttributes(AttributeSet arg0, int[] arg1, int arg2, int arg3)`
`final TypedArray`	`obtainStyledAttributes(int arg0, int[] arg1)`
`final TypedArray`	`obtainStyledAttributes(int[] arg0)`
`abstract FileInputStream`	`openFileInput(String arg0)`
`abstract FileOutputStream`	`openFileOutput(String arg0, int arg1)`
`abstract SQLiteDatabase`	`openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2, DatabaseErrorHandler arg3)`
`abstract SQLiteDatabase`	`openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2)`
`abstract Drawable`	`peekWallpaper()`
`void`	`registerComponentCallbacks(ComponentCallbacks arg0)`
`abstract Intent`	`registerReceiver(BroadcastReceiver arg0, IntentFilter arg1)`
`abstract Intent`	`registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, int arg2)`
`abstract Intent`	`registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3, int arg4)`
`abstract Intent`	`registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3)`
`abstract void`	`removeStickyBroadcast(Intent arg0)`
`abstract void`	`removeStickyBroadcastAsUser(Intent arg0, UserHandle arg1)`
`abstract void`	`revokeUriPermission(Uri arg0, int arg1)`
`abstract void`	`revokeUriPermission(String arg0, Uri arg1, int arg2)`
`abstract void`	`sendBroadcast(Intent arg0, String arg1)`
`abstract void`	`sendBroadcast(Intent arg0)`
`abstract void`	`sendBroadcastAsUser(Intent arg0, UserHandle arg1)`
`abstract void`	`sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2)`
`void`	`sendBroadcastWithMultiplePermissions(Intent arg0, String[] arg1)`
`void`	`sendOrderedBroadcast(Intent arg0, String arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)`
`abstract void`	`sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6)`
`abstract void`	`sendOrderedBroadcast(Intent arg0, String arg1)`
`abstract void`	`sendOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7)`
`abstract void`	`sendStickyBroadcast(Intent arg0)`
`abstract void`	`sendStickyBroadcastAsUser(Intent arg0, UserHandle arg1)`
`abstract void`	`sendStickyOrderedBroadcast(Intent arg0, BroadcastReceiver arg1, Handler arg2, int arg3, String arg4, Bundle arg5)`
`abstract void`	`sendStickyOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6)`
`abstract void`	`setTheme(int arg0)`
`abstract void`	`setWallpaper(Bitmap arg0)`
`abstract void`	`setWallpaper(InputStream arg0)`
`abstract void`	`startActivities(Intent[] arg0, Bundle arg1)`
`abstract void`	`startActivities(Intent[] arg0)`
`abstract void`	`startActivity(Intent arg0)`
`abstract void`	`startActivity(Intent arg0, Bundle arg1)`
`abstract ComponentName`	`startForegroundService(Intent arg0)`
`abstract boolean`	`startInstrumentation(ComponentName arg0, String arg1, Bundle arg2)`
`abstract void`	`startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4)`
`abstract void`	`startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5)`
`abstract ComponentName`	`startService(Intent arg0)`
`abstract boolean`	`stopService(Intent arg0)`
`abstract void`	`unbindService(ServiceConnection arg0)`
`void`	`unregisterComponentCallbacks(ComponentCallbacks arg0)`
`abstract void`	`unregisterReceiver(BroadcastReceiver arg0)`
`void`	`updateServiceGroup(ServiceConnection arg0, int arg1, int arg2)`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          android.content.ComponentCallbacks2

abstract void onTrimMemory(int arg0)

From interface


        
          android.content.ComponentCallbacks

`abstract void`	`onConfigurationChanged(Configuration arg0)`
`abstract void`	`onLowMemory()`

Constants

SERVICE_INTERFACE

public static final String SERVICE_INTERFACE

The Intent that must be declared as handled by the service.

Constant Value: "androidx.media2.session.MediaSessionService"

Public constructors

MediaSessionService

public MediaSessionService ()

Public methods

addSession

public final void addSession (MediaSession session)

Adds a session to this service. This is not necessary for most media apps. See Supporting Multiple Sessions for detail.

Added session will be removed automatically when it's closed, or removed when removeSession(MediaSession) is called.

Parameters
`session`	`MediaSession`: a session to be added.

See also:

removeSession(MediaSession)

getSessions

public final List<MediaSession> getSessions ()

Gets the list of MediaSessions that you've added to this service via addSession(MediaSession) or onGetSession(ControllerInfo).

Returns
`List<MediaSession>`	sessions

onBind

public IBinder onBind (Intent intent)

Default implementation for MediaSessionService to handle incoming binding request. If the request is for getting the session, the intent will have action SERVICE_INTERFACE.

Override this method if this service also needs to handle binder requests other than SERVICE_INTERFACE. Derived classes MUST call through to the super class's implementation of this method.

Returns
`IBinder`	Binder

onCreate

public void onCreate ()

Called by the system when the service is first created. Do not call this method directly.

Override this method if you need your own initialization. Derived classes MUST call through to the super class's implementation of this method.

onDestroy

public void onDestroy ()

Called by the system to notify that it is no longer used and is being removed. Do not call this method directly.

Override this method if you need your own clean up. Derived classes MUST call through to the super class's implementation of this method.

onGetSession

public abstract MediaSession onGetSession (MediaSession.ControllerInfo controllerInfo)

Called when a MediaController is created with the this service's SessionToken. Return the session for telling the controller which session to connect. Return null to reject the connection from this controller.

Session service automatically maintains the returned session. In other words, session returned here will be added here and removed when the session is closed. You don't need to manually call addSession(MediaSession) nor removeSession(MediaSession).

There are two special cases where the MediaSession.ControllerInfo.getPackageName() returns non-existent package name:

When the service is being started through the media button intent, the method will return Intent.ACTION_MEDIA_BUTTON. If you want to allow the service being started by the media button events, do not return null.
When the legacy MediaBrowser or MediaBrowserCompat tries to connect, the method will return MediaBrowserServiceCompat.SERVICE_INTERFACE. If you want to allow the service being bound by the legacy media browsers, do not return null.

For those special cases, the values returned by MediaSession.ControllerInfo.getUid() and MediaSession.ControllerInfo.getConnectionHints() have no meaning.

This method is always called on the main thread.

Parameters
`controllerInfo`	`MediaSession.ControllerInfo`: information of the controller which is trying to connect

Returns
`MediaSession`	a `MediaSession` instance for the controller to connect to, or `null` to reject connection

See also:

onStartCommand

public int onStartCommand (Intent intent, 
                int flags, 
                int startId)

Parameters
`intent`	`Intent`
`flags`	`int`
`startId`	`int`

Returns
`int`

onUpdateNotification

public MediaSessionService.MediaNotification onUpdateNotification (MediaSession session)

Called when notification UI needs update. Override this method to show or cancel your own notification UI.

This would be called on MediaSession's callback executor when player state is changed, or when the current media item of the session is changed.

With the notification returned here, the service becomes foreground service when the playback is started. Apps targeting API Build.VERSION_CODES.P or later must request the permission Manifest.permission.FOREGROUND_SERVICE in order to use this API. It becomes background service after the playback is stopped.

Parameters
`session`	`MediaSession`: a session that needs notification update

Returns
`MediaSessionService.MediaNotification`	a `MediaSessionService.MediaNotification`. Can be `null`

removeSession

public final void removeSession (MediaSession session)

Removes a session from this service. This is not necessary for most media apps. See Supporting Multiple Sessions for detail.

Parameters
`session`	`MediaSession`: a session to be removed.

See also:

addSession(MediaSession)

MediaSessionService

Service Lifecycle

Permissions

Supporting Multiple Sessions

Summary

Nested classes

Constants

Inherited constants

Public constructors

Public methods

Inherited methods

Constants

SERVICE_INTERFACE

Public constructors

MediaSessionService

Public methods

addSession

getSessions

onBind

onCreate

onDestroy

onGetSession

onStartCommand

onUpdateNotification

removeSession