public abstract class MediaBrowserServiceCompat
extends Service
java.lang.Object
↳ android.content.Context
↳ android.content.ContextWrapper
↳ android.app.Service
↳ |androidx.media.MediaBrowserServiceCompat
媒体浏览服务的基类。
媒体浏览服务使应用程序能够浏览应用程序提供的媒体内容,并要求应用程序开始播放它。它们也可以用来控制已经通过 MediaSessionCompat播放的内容。
要扩展这个类,您必须在清单文件中使用 SERVICE_INTERFACE 动作的意图过滤器声明该服务。例如:
<service android:name=".MyMediaBrowserServiceCompat"
android:label="@string/service_name" >
<intent-filter>
<action android:name="android.media.browse.MediaBrowserService" />
</intent-filter>
</service>
Public methods
dump
public void dump (FileDescriptor fd,
PrintWriter writer,
String[] args)
getBrowserRootHints
public final Bundle getBrowserRootHints ()
获取从当前连接的MediaBrowserCompat发送的根提示。根提示是服务特定的参数,包含在一个可选的bundle中,在连接和检索浏览的根id时发送给媒体浏览器服务,如果没有,则为空。此包的内容可能会影响浏览时返回的信息。
请注意,当连接到MediaBrowser并运行在API 23或更低的API时,将返回null。
如果这个方法在onLoadChildren(String, MediaBrowserServiceCompat.Result>), onLoadItem(String, MediaBrowserServiceCompat.Result)或onSearch(String, Bundle, MediaBrowserServiceCompat.Result>)之外被调用,将Throws IllegalStateException
getCurrentBrowserInfo
public final MediaSessionManager.RemoteUserInfo getCurrentBrowserInfo ()
获取发送当前请求的浏览器信息。
如果这个方法在onGetRoot(String, int, Bundle)或onLoadChildren(String, MediaBrowserServiceCompat.Result>)或onLoadItem(String, MediaBrowserServiceCompat.Result)之外被调用,将Throws IllegalStateException
getSessionToken
public MediaSessionCompat.Token getSessionToken ()
获取会话令牌,如果尚未创建或已销毁该令牌,则为空。
notifyChildrenChanged
public void notifyChildrenChanged (String parentId,Bundle options)
通知所有连接的媒体浏览器,指定的父id的子浏览器已以某种方式更改。这将导致浏览器再次获取订阅内容。
Parameters | Description |
---|---|
parentId | String:其子项已更改的父媒体项的id。 |
options | Bundle:发送到媒体浏览的特定于服务的参数包。这个bundle的内容可能包含关于更改的信息。 |
onCustomAction
public void onCustomAction (String action,
Bundle extras,
Result<Bundle> result)
调用该函数来请求此服务的自定义操作。
实现必须调用MediaBrowserServiceCompat.Result.sendResult(T)或MediaBrowserServiceCompat.Result.sendError(Bundle)。如果请求的自定义操作将是一个开销很大的操作,则可以在从这个函数返回之前调用MediaBrowserServiceCompat . Result .detach(),然后服务可以在自定义操作完成之后发送结果。实现还可以调用MediaBrowSerserviceCompatt. Result . sendprogressupdate (Bundle)向请求者发送一个临时更新。
如果请求的自定义操作不被该服务支持,则调用MediaBrowserServiceCompat . Result . senderror (Bundle)。默认实现将调用MediaBrowserServiceCompat . Result . senderror (Bundle)。
Parameters | Description |
---|---|
action | String:从媒体浏览器发送的自定义操作。 |
extras | Bundle:从媒体浏览器发送的特定于服务的参数包。 |
result | Result:The MediaBrowserServiceCompat.Result 发送所请求的自定义操作的结果。 |
参见:
MediaBrowserCompat.CUSTOM_ACTION_DOWNLOAD
MediaBrowserCompat.CUSTOM_ACTION_REMOVE_DOWNLOADED_FILE
onGetRoot
public abstractMediaBrowserServiceCompat.BrowserRoot onGetRoot (
String clientPackageName,
int clientUid,
Bundle rootHints)
调用该函数以获得用于特定客户机浏览的根信息。
在返回根id之前,实现应该验证客户端包有访问浏览媒体信息的权限;如果不允许客户端访问此信息,则返回null。
Parameters | Description |
---|---|
clientPackageName | String:请求访问浏览媒体的应用程序的包名。 |
clientUid | int:请求访问浏览媒体的应用程序的uid。 |
rootHints | Bundle:一个可选的服务特定参数包,在连接和获取浏览的根id时发送给媒体浏览服务,如果没有则为空。此包的内容可能会影响浏览时返回的信息。 |
参见:
MediaBrowserServiceCompat.BrowserRoot.EXTRA_RECENT
MediaBrowserServiceCompat.BrowserRoot.EXTRA_OFFLINE
MediaBrowserServiceCompat.BrowserRoot.EXTRA_SUGGESTED
onLoadChildren
public void onLoadChildren (
String parentId,
Result<List<MediaBrowserCompat.MediaItem>> result,
Bundle options)
调用该函数以获取有关媒体项的子项的信息。
实现必须调用result.sendResult的子列表。如果加载子函数是一个开销很大的操作,应该在另一个线程上执行,那么可以在从这个函数返回之前调用result.detach,加载完成时再调用resulut.sendResult。
如果媒体项没有任何子项,调用MediaBrowserServiceCompat.Result.sendresult (T)以一个空列表。当给定的parentId无效时,实现必须调用result.sendResult与null,这将调用MediaBrowserCompat.SubscriptionCallback.onError(String)。
Parameters | Description |
---|---|
parentId | String:要查询其子媒体项的父媒体项的id。 |
result | Result:发送查询的子集。 |
options | Bundle:从媒体浏览中发送的特定于服务的参数包。通过结果返回的信息应该受到这个bundle的内容的影响。 |
onLoadItem
public void onLoadItem (
String itemId,
Result<MediaBrowserCompat.MediaItem> result)
调用该函数以获取有关特定媒体项的信息。
实现必须调【result.sendResult。如果加载项将是一个开销很大的操作result.detach可能会在从这个函数返回之前被调用,当项目被加载时调用result.sendResult。
当给定的itemId无效时,实现必须调用result.sendResult null。
默认实现将调用MediaBrowserCompat.ItemCallback.onError(String)。
Parameters | Description |
---|---|
itemId | String:特定MediaBrowserCompart.MediaiIem的id。 |
result | Result:要将项目发送到的Result,如果id无效则为空。 |
onSearch
public void onSearch (
String query,
Bundle extras,
Result<List<MediaBrowserCompat.MediaItem>> result)
调用来获取搜索结果。
实现必须调用result.sendResult的子列表。如果加载子函数是一个开销很大的操作,应该在另一个线程上执行,那么可以在从这个函数返回之前调用result.detach,加载完成时再调用resulut.sendResult。
如果没有搜索结果,调用result.sendResult空列表的。如果有一些错误发生,调用结果。result.sendResult(null),这将调用MediaBrowserCompat.SearchCallback.onError()。
默认实现将调用MediaBrowserCompat.SearchCallback.onError()。
Parameters | Description |
---|---|
query | String:从媒体浏览器发送的搜索查询。它包含用空格分隔的关键字。 |
extras | Bundle:从媒体浏览器发送的特定于服务的参数包。 |
result | Result:MediaBrowserServiceCompat.Result发送搜索结果。 |
setSessionToken
public void setSessionToken (MediaSessionCompat.Token token)
设置媒体会话。
应该在服务启动期间尽快调用。它可能只被调用一次。
Parameters | Description |
---|---|
token | MediaSessionCompat.Token: 服务的MediaSessionCompat的令牌。 |