MediaBrowserServiceCompat
public abstract class MediaBrowserServiceCompat extends Service
| java.lang.Object | ||||
| ↳ | android.content.Context | |||
| ↳ | android.content.ContextWrapper | |||
| ↳ | android.app.Service | |||
| ↳ | androidx.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>
Summary
Nested types |
|---|
public final class MediaBrowserServiceCompat.BrowserRootThis class is deprecated. androidx.media is deprecated. |
public class MediaBrowserServiceCompat.Result<T>This class is deprecated. androidx.media is deprecated. |
Constants |
|
|---|---|
static final String |
SERVICE_INTERFACE = "android.media.browse.MediaBrowserService"This field is deprecated. Deprecated in Java |
Public constructors |
|---|
|
This method is deprecated. Deprecated in Java |
Public methods |
|
|---|---|
void |
This method is deprecated. Deprecated in Java |
final Bundle |
This method is deprecated. Deprecated in Java |
final @NonNull MediaSessionManager.RemoteUserInfo |
This method is deprecated. Deprecated in Java |
@Nullable MediaSessionCompat.Token |
This method is deprecated. Deprecated in Java |
void |
This method is deprecated. Deprecated in Java |
void |
This method is deprecated. Deprecated in Java |
IBinder |
This method is deprecated. Deprecated in Java |
void |
This method is deprecated. Deprecated in Java |
void |
This method is deprecated. Deprecated in Java |
void |
This method is deprecated. Deprecated in Java |
abstract @Nullable MediaBrowserServiceCompat.BrowserRoot |
This method is deprecated. Deprecated in Java |
abstract void |
This method is deprecated. Deprecated in Java |
void |
This method is deprecated. Deprecated in Java |
void |
This method is deprecated. Deprecated in Java |
void |
This method is deprecated. Deprecated in Java |
void |
This method is deprecated. Deprecated in Java |
Inherited Constants |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Inherited methods |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Constants
public static final String SERVICE_INTERFACE = "android.media.browse.MediaBrowserService"
The Intent that must be declared as handled by the service.
Public constructors
Public methods
public final BundlegetBrowserRootHints()
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 android.media.browse.MediaBrowser and running on API 23 or lower.
| Throws | |
|---|---|
java.lang.IllegalStateException |
If this method is called outside of |
| See also | |
|---|---|
EXTRA_RECENT |
|
EXTRA_OFFLINE |
|
EXTRA_SUGGESTED |
public final @NonNull MediaSessionManager.RemoteUserInfogetCurrentBrowserInfo()
Gets the browser information who sent the current request.
| Throws | |
|---|---|
java.lang.IllegalStateException |
If this method is called outside of |
| See also | |
|---|---|
isTrustedForMediaControl |
public @Nullable MediaSessionCompat.TokengetSessionToken()
Gets the session token, or null if it has not yet been created or if it has been destroyed.
public voidnotifyChildrenChanged(@NonNull 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.
public voidnotifyChildrenChanged(@NonNull String parentId, @NonNull 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.
public voidonCustomAction(
@NonNull String action,
Bundle extras,
@NonNull MediaBrowserServiceCompat.Result<Bundle> result
)
Called to request a custom action to this service.
Implementations must call either sendResult or sendError. 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 to send an interim update to the requester.
If the requested custom action is not supported by this service, call sendError. The default implementation will invoke sendError.
public abstract @Nullable MediaBrowserServiceCompat.BrowserRootonGetRoot(
@NonNull String clientPackageName,
int clientUid,
@Nullable 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 | |
|---|---|
@NonNull String clientPackageName |
The package name of the application which is requesting access to browse media. |
int clientUid |
The uid of the application which is requesting access to browse media. |
@Nullable Bundle rootHints |
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 | |
|---|---|
@Nullable MediaBrowserServiceCompat.BrowserRoot |
The |
| See also | |
|---|---|
EXTRA_RECENT |
|
EXTRA_OFFLINE |
|
EXTRA_SUGGESTED |
public abstract voidonLoadChildren(
@NonNull String parentId,
@NonNull MediaBrowserServiceCompat.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 with an empty list. When the given parentId is invalid, implementations must call result.sendResult with null, which will invoke onError.
| Parameters | |
|---|---|
@NonNull String parentId |
The id of the parent media item whose children are to be queried. |
@NonNull MediaBrowserServiceCompat.Result<List<MediaBrowserCompat.MediaItem>> result |
The Result to send the list of children to. |
public voidonLoadChildren(
@NonNull String parentId,
@NonNull MediaBrowserServiceCompat.Result<List<MediaBrowserCompat.MediaItem>> result,
@NonNull Bundle options
)
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 with an empty list. When the given parentId is invalid, implementations must call result.sendResult with null, which will invoke onError.
| Parameters | |
|---|---|
@NonNull String parentId |
The id of the parent media item whose children are to be queried. |
@NonNull MediaBrowserServiceCompat.Result<List<MediaBrowserCompat.MediaItem>> result |
The Result to send the list of children to. |
@NonNull Bundle options |
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. |
public voidonLoadItem(
String itemId,
@NonNull MediaBrowserServiceCompat.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.
| Parameters | |
|---|---|
String itemId |
The id for the specific |
@NonNull MediaBrowserServiceCompat.Result<MediaBrowserCompat.MediaItem> result |
The Result to send the item to, or null if the id is invalid. |
public voidonSearch(
@NonNull String query,
Bundle extras,
@NonNull MediaBrowserServiceCompat.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.
The default implementation will invoke onError.
| Parameters | |
|---|---|
@NonNull String query |
The search query sent from the media browser. It contains keywords separated by space. |
Bundle extras |
The bundle of service-specific arguments sent from the media browser. |
@NonNull MediaBrowserServiceCompat.Result<List<MediaBrowserCompat.MediaItem>> result |
The |
public voidsetSessionToken(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 | |
|---|---|
MediaSessionCompat.Token token |
The token for the service's |