added in version 24.1.0
belongs to Maven artifact com.android.support:support-media-compat:28.0.0-alpha1

MediaBrowserServiceCompat

public abstract class MediaBrowserServiceCompat
extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	android.support.v4.media.MediaBrowserServiceCompat

Base class for media browse services.

Media browse services enable applications to browse media content provided by an application and ask the application to start playing it. They may also be used to control content that is already playing by way of a MediaSessionCompat.

To extend this class, you must declare the service in your manifest file with an intent filter with the SERVICE_INTERFACE action. For example:

 <service android:name=".MyMediaBrowserServiceCompat"
          android:label="@string/service_name" >
     <intent-filter>
         <action android:name="android.media.browse.MediaBrowserService" />
     </intent-filter>
 </service>

Developer Guides

For information about building your media application, read the Media Apps developer guide.

Summary

Nested classes
`class`	`MediaBrowserServiceCompat.BrowserRoot` Contains information that the browser service needs to send to the client when first connected.
`class`	`MediaBrowserServiceCompat.Result<T>` Completion handler for asynchronous callback methods in `MediaBrowserServiceCompat`.

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

Inherited constants

From class


    android.app.Service

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_NOT_FOREGROUND`
`int`	`BIND_WAIVE_PRIORITY`
`String`	`BLUETOOTH_SERVICE`
`String`	`CAMERA_SERVICE`
`String`	`CAPTIONING_SERVICE`
`String`	`CARRIER_CONFIG_SERVICE`
`String`	`CLIPBOARD_SERVICE`
`String`	`COMPANION_DEVICE_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`	`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`	`SEARCH_SERVICE`
`String`	`SENSOR_SERVICE`
`String`	`SHORTCUT_SERVICE`
`String`	`STORAGE_SERVICE`
`String`	`STORAGE_STATS_SERVICE`
`String`	`SYSTEM_HEALTH_SERVICE`
`String`	`TELECOM_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`	`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

Public constructors
`MediaBrowserServiceCompat()`

Public methods
`void`	`dump(FileDescriptor fd, PrintWriter writer, String[] args)`
`final Bundle`	`getBrowserRootHints()` Gets the root hints sent from the currently connected `MediaBrowserCompat`.
`MediaSessionCompat.Token`	`getSessionToken()` Gets the session token, or null if it has not yet been created or if it has been destroyed.
`void`	`notifyChildrenChanged(String parentId)` Notifies all connected media browsers that the children of the specified parent id have changed in some way.
`void`	`notifyChildrenChanged(String parentId, Bundle options)` Notifies all connected media browsers that the children of the specified parent id have changed in some way.
`IBinder`	`onBind(Intent intent)`
`void`	`onCreate()`
`void`	`onCustomAction(String action, Bundle extras, Result<Bundle> result)` Called to request a custom action to this service.
`abstract MediaBrowserServiceCompat.BrowserRoot`	`onGetRoot(String clientPackageName, int clientUid, Bundle rootHints)` Called to get the root information for browsing by a particular client.
`abstract void`	`onLoadChildren(String parentId, Result<List<MediaBrowserCompat.MediaItem>> result)` Called to get information about the children of a media item.
`void`	`onLoadChildren(String parentId, Result<List<MediaBrowserCompat.MediaItem>> result, Bundle options)` Called to get information about the children of a media item.
`void`	`onLoadItem(String itemId, Result<MediaBrowserCompat.MediaItem> result)` Called to get information about a specific media item.
`void`	`onSearch(String query, Bundle extras, Result<List<MediaBrowserCompat.MediaItem>> result)` Called to get the search result.
`void`	`setSessionToken(MediaSessionCompat.Token token)` Call to set the media session.

Inherited methods

From class



    android.app.Service

From class



    android.content.ContextWrapper

`void`	`attachBaseContext(Context arg0)`
`boolean`	`bindService(Intent arg0, ServiceConnection arg1, int arg2)`
`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`	`createConfigurationContext(Configuration arg0)`
`Context`	`createContextForSplit(String arg0)`
`Context`	`createDeviceProtectedStorageContext()`
`Context`	`createDisplayContext(Display arg0)`
`Context`	`createPackageContext(String arg0, int 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()`
`Context`	`getBaseContext()`
`File`	`getCacheDir()`
`ClassLoader`	`getClassLoader()`
`File`	`getCodeCacheDir()`
`ContentResolver`	`getContentResolver()`
`File`	`getDataDir()`
`File`	`getDatabasePath(String arg0)`
`File`	`getDir(String arg0, int arg1)`
`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`	`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, 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)`

From class



    android.content.Context

`abstract boolean`	`bindService(Intent arg0, ServiceConnection arg1, int arg2)`
`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()`
`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)`
`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()`
`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)`
`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()`
`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)`
`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)`

From class



    java.lang.Object

From interface



    android.content.ComponentCallbacks2

From interface



    android.content.ComponentCallbacks

Constants

SERVICE_INTERFACE

added in version 24.1.0

String SERVICE_INTERFACE

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

Constant Value: "android.media.browse.MediaBrowserService"

Public constructors

MediaBrowserServiceCompat

added in version 24.1.0

MediaBrowserServiceCompat ()

Public methods

dump

added in version 24.1.0

void dump (FileDescriptor fd,
                PrintWriter writer,
                String[] args)

Parameters
`fd`	`FileDescriptor`
`writer`	`PrintWriter`
`args`	`String`

getBrowserRootHints

added in version 24.1.0

Bundle getBrowserRootHints ()

Gets the root hints sent from the currently connected MediaBrowserCompat. The root hints are service-specific arguments included in an optional bundle sent to the media browser service when connecting and retrieving the root id for browsing, or null if none. The contents of this bundle may affect the information returned when browsing.

Note that this will return null when connected to MediaBrowser and running on API 23 or lower.

Returns
`Bundle`

Throws
`IllegalStateException`	If this method is called outside of `onLoadChildren(String, MediaBrowserServiceCompat.Result>)`, `onLoadItem(String, MediaBrowserServiceCompat.Result)` or `onSearch(String, Bundle, MediaBrowserServiceCompat.Result>)`.

See also:

getSessionToken

added in version 24.1.0

MediaSessionCompat.Token getSessionToken ()

Gets the session token, or null if it has not yet been created or if it has been destroyed.

Returns
`MediaSessionCompat.Token`

notifyChildrenChanged

added in version 24.1.0

void notifyChildrenChanged (String parentId)

Notifies all connected media browsers that the children of the specified parent id have changed in some way. This will cause browsers to fetch subscribed content again.

Parameters
`parentId`	`String`: The id of the parent media item whose children changed.

notifyChildrenChanged

added in version 24.1.0

void notifyChildrenChanged (String parentId,
                Bundle options)

Notifies all connected media browsers that the children of the specified parent id have changed in some way. This will cause browsers to fetch subscribed content again.

Parameters
`parentId`	`String`: The id of the parent media item whose children changed.
`options`	`Bundle`: A bundle of service-specific arguments to send to the media browse. The contents of this bundle may contain the information about the change.

onBind

added in version 24.1.0

IBinder onBind (Intent intent)

Parameters
`intent`	`Intent`

Returns
`IBinder`

onCreate

void onCreate ()

onCustomAction

added in version 25.4.0

void onCustomAction (String action,
                Bundle extras,
                Result<Bundle> result)

Called to request a custom action to this service.

Implementations must call either sendResult(T) or sendError(Bundle). If the requested custom action will be an expensive operation detach() may be called before returning from this function, and then the service can send the result later when the custom action is completed. Implementation can also call sendProgressUpdate(Bundle) to send an interim update to the requester.

If the requested custom action is not supported by this service, call sendError(Bundle). The default implementation will invoke sendError(Bundle).

Parameters
`action`	`String`: The custom action sent from the media browser.
`extras`	`Bundle`: The bundle of service-specific arguments sent from the media browser.
`result`	`Result`: The `MediaBrowserServiceCompat.Result` to send the result of the requested custom action.

See also:

onGetRoot

added in version 24.1.0

MediaBrowserServiceCompat.BrowserRoot onGetRoot (String clientPackageName,
                int clientUid,
                Bundle rootHints)

Called to get the root information for browsing by a particular client.

The implementation should verify that the client package has permission to access browse media information before returning the root id; it should return null if the client is not allowed to access this information.

Parameters
`clientPackageName`	`String`: The package name of the application which is requesting access to browse media.
`clientUid`	`int`: The uid of the application which is requesting access to browse media.
`rootHints`	`Bundle`: An optional bundle of service-specific arguments to send to the media browse service when connecting and retrieving the root id for browsing, or null if none. The contents of this bundle may affect the information returned when browsing.

Returns
`MediaBrowserServiceCompat.BrowserRoot`	The `MediaBrowserServiceCompat.BrowserRoot` for accessing this app's content or null.

See also:

onLoadChildren

added in version 24.1.0

void onLoadChildren (String parentId,
                Result<List<MediaBrowserCompat.MediaItem>> result)

Called to get information about the children of a media item.

Implementations must call result.sendResult with the list of children. If loading the children will be an expensive operation that should be performed on another thread, result.detach may be called before returning from this function, and then result.sendResult called when the loading is complete.

In case the media item does not have any children, call sendResult(T) with an empty list. When the given parentId is invalid, implementations must call result.sendResult with null, which will invoke onError(String).

Parameters
`parentId`	`String`: The id of the parent media item whose children are to be queried.
`result`	`Result`: The Result to send the list of children to.

onLoadChildren

added in version 24.1.0

void onLoadChildren (String parentId,
                Result<List<MediaBrowserCompat.MediaItem>> result,
                Bundle options)

Called to get information about the children of a media item.

Parameters
`parentId`	`String`: The id of the parent media item whose children are to be queried.
`result`	`Result`: The Result to send the list of children to.
`options`	`Bundle`: A bundle of service-specific arguments sent from the media browse. The information returned through the result should be affected by the contents of this bundle.

onLoadItem

added in version 24.1.0

void onLoadItem (String itemId,
                Result<MediaBrowserCompat.MediaItem> result)

Called to get information about a specific media item.

Implementations must call result.sendResult. If loading the item will be an expensive operation result.detach may be called before returning from this function, and then result.sendResult called when the item has been loaded.

When the given itemId is invalid, implementations must call result.sendResult with null.

The default implementation will invoke onError(String).

Parameters
`itemId`	`String`: The id for the specific `MediaBrowserCompat.MediaItem`.
`result`	`Result`: The Result to send the item to, or null if the id is invalid.

onSearch

added in version 25.4.0

void onSearch (String query,
                Bundle extras,
                Result<List<MediaBrowserCompat.MediaItem>> result)

Called to get the search result.

Implementations must call result.sendResult. If the search will be an expensive operation result.detach may be called before returning from this function, and then result.sendResult called when the search has been completed.

In case there are no search results, call result.sendResult with an empty list. In case there are some errors happened, call result.sendResult with null, which will invoke onError(String, Bundle).

The default implementation will invoke onError(String, Bundle).

Parameters
`query`	`String`: The search query sent from the media browser. It contains keywords separated by space.
`extras`	`Bundle`: The bundle of service-specific arguments sent from the media browser.
`result`	`Result`: The `MediaBrowserServiceCompat.Result` to send the search result.

setSessionToken

added in version 24.1.0

void setSessionToken (MediaSessionCompat.Token token)

Call to set the media session.

This should be called as soon as possible during the service's startup. It may only be called once.

Parameters
`token`	`MediaSessionCompat.Token`: The token for the service's `MediaSessionCompat`.

Classes

MediaBrowserServiceCompat

Developer Guides

Summary

Nested classes

Constants

Inherited constants

Public constructors

Public methods

Inherited methods

Constants

SERVICE_INTERFACE

Public constructors

MediaBrowserServiceCompat

Public methods

dump

getBrowserRootHints

getSessionToken

notifyChildrenChanged

notifyChildrenChanged

onBind

onCreate

onCustomAction

onGetRoot

onLoadChildren

onLoadChildren

onLoadItem

onSearch

setSessionToken

Classes