public final class MediaBrowserCompat
extends Object
java.lang.Object | |
↳ | android.support.v4.media.MediaBrowserCompat |
浏览 MediaBrowserServiceCompat
提供的媒体内容。
该对象不是线程安全的。 所有调用都应该在构建浏览器的线程上进行。
Nested classes |
|
---|---|
class |
MediaBrowserCompat.ConnectionCallback 与连接相关的事件的回调。 |
class |
MediaBrowserCompat.ItemCallback |
class |
MediaBrowserCompat.MediaItem 一个包含单个媒体项目信息的类,用于浏览媒体。 |
class |
MediaBrowserCompat.SubscriptionCallback 订阅相关事件的回调。 |
Constants |
|
---|---|
String |
EXTRA_PAGE 用作int外部字段来表示要订阅的页码。 |
String |
EXTRA_PAGE_SIZE 用作int外部字段来表示页面中媒体项目的数量。 |
Public constructors |
|
---|---|
MediaBrowserCompat(Context context, ComponentName serviceComponent, MediaBrowserCompat.ConnectionCallback callback, Bundle rootHints) 为指定的媒体浏览服务创建媒体浏览器。 |
Public methods |
|
---|---|
void |
connect() 连接到媒体浏览服务。 |
void |
disconnect() 断开与媒体浏览服务的连接。 |
Bundle |
getExtras() 获取媒体服务的任何附加内容。 |
void |
getItem(String mediaId, MediaBrowserCompat.ItemCallback cb) 从连接的服务中检索特定的 |
String |
getRoot() 获取根ID。 |
ComponentName |
getServiceComponent() 获取媒体浏览器连接到的服务组件。 |
MediaSessionCompat.Token |
getSessionToken() 获取与媒体浏览器关联的媒体会话令牌。 |
boolean |
isConnected() 返回浏览器是否连接到服务。 |
void |
subscribe(String parentId, Bundle options, MediaBrowserCompat.SubscriptionCallback callback) 查询具有特定于服务的参数以获取有关指定标识中包含的媒体项目的信息,并订阅它们在更改时接收更新。 |
void |
subscribe(String parentId, MediaBrowserCompat.SubscriptionCallback callback) 查询有关指定ID中包含的媒体项目的信息,并订阅它们在更改时接收更新。 |
void |
unsubscribe(String parentId) 取消订阅指定媒体ID的子项更改。 |
void |
unsubscribe(String parentId, MediaBrowserCompat.SubscriptionCallback callback) 取消订阅指定媒体ID的子项更改。 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
String EXTRA_PAGE
用作int外部字段来表示要订阅的页码。 EXTRA_PAGE
的值应该大于或等于1。
常量值:“android.media.browse.extra.PAGE”
String EXTRA_PAGE_SIZE
用作int外部字段来表示页面中媒体项目的数量。 EXTRA_PAGE_SIZE
的值应该大于或等于1。
常量值:“android.media.browse.extra.PAGE_SIZE”
MediaBrowserCompat (Context context, ComponentName serviceComponent, MediaBrowserCompat.ConnectionCallback callback, Bundle rootHints)
为指定的媒体浏览服务创建媒体浏览器。
Parameters | |
---|---|
context |
Context : The context. |
serviceComponent |
ComponentName : The component name of the media browse service. |
callback |
MediaBrowserCompat.ConnectionCallback : The connection callback. |
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. |
void connect ()
连接到媒体浏览服务。
连接完成或失败时,构造函数中指定的连接回调将被调用。
void disconnect ()
断开与媒体浏览服务的连接。 在此之后,将不会收到更多回调。
Bundle getExtras ()
获取媒体服务的任何附加内容。
Returns | |
---|---|
Bundle |
Throws | |
---|---|
IllegalStateException |
if not connected. |
void getItem (String mediaId, MediaBrowserCompat.ItemCallback cb)
从连接的服务中检索特定的MediaBrowserCompat.MediaItem
。 并非所有的服务都可以支持这一点,所以当不可用时应该使用订阅父母的ID。
Parameters | |
---|---|
mediaId |
String : The id of the item to retrieve. |
cb |
MediaBrowserCompat.ItemCallback : The callback to receive the result on. |
String getRoot ()
获取根ID。
请注意,当浏览器断开连接时,root ID可能会失效或发生更改。
Returns | |
---|---|
String |
Throws | |
---|---|
IllegalStateException |
if not connected. |
MediaSessionCompat.Token getSessionToken ()
获取与媒体浏览器关联的媒体会话令牌。
请注意,当浏览器断开连接时,会话令牌可能会失效或发生更改。
Returns | |
---|---|
MediaSessionCompat.Token |
The session token for the browser, never null. |
Throws | |
---|---|
IllegalStateException |
if not connected. |
boolean isConnected ()
返回浏览器是否连接到服务。
Returns | |
---|---|
boolean |
void subscribe (String parentId, Bundle options, MediaBrowserCompat.SubscriptionCallback callback)
查询具有特定于服务的参数以获取有关指定标识中包含的媒体项目的信息,并订阅它们在更改时接收更新。
即使未连接,订阅列表也会保留,并在重新连接后恢复。 在没有连接的情况下订阅是可以的,但直到连接完成后才会返回结果。
如果id已经订阅了不同的回调,那么新的回调将替换前一个回调,并且子数据将被重新加载。
Parameters | |
---|---|
parentId |
String : The id of the parent media item whose list of children will be subscribed. |
options |
Bundle : A bundle of service-specific arguments to send to the media browse service. The contents of this bundle may affect the information returned when browsing. |
callback |
MediaBrowserCompat.SubscriptionCallback : The callback to receive the list of children. |
void subscribe (String parentId, MediaBrowserCompat.SubscriptionCallback callback)
查询有关指定ID中包含的媒体项目的信息,并订阅它们在更改时接收更新。
即使未连接,订阅列表也会保留,并在重新连接后恢复。 在没有连接的情况下订阅是可以的,但直到连接完成后才会返回结果。
如果id已经订阅了不同的回调,那么新的回调将替换前一个回调,并且子数据将被重新加载。
Parameters | |
---|---|
parentId |
String : The id of the parent media item whose list of children will be subscribed. |
callback |
MediaBrowserCompat.SubscriptionCallback : The callback to receive the list of children. |
void unsubscribe (String parentId)
取消订阅指定媒体ID的子项更改。
一旦此方法返回,查询回调将不再为与此ID相关联的结果调用。
Parameters | |
---|---|
parentId |
String : The id of the parent media item whose list of children will be unsubscribed. |
void unsubscribe (String parentId, MediaBrowserCompat.SubscriptionCallback callback)
取消订阅指定媒体ID的子项更改。
一旦此方法返回,查询回调将不再为与此ID相关联的结果调用。
Parameters | |
---|---|
parentId |
String : The id of the parent media item whose list of children will be unsubscribed. |
callback |
MediaBrowserCompat.SubscriptionCallback : A callback sent to the media browse service to subscribe. |