public
abstract
class
MediaBrowserService
extends Service
java.lang.Object | ||||
↳ | android.content.Context | |||
↳ | android.content.ContextWrapper | |||
↳ | android.app.Service | |||
↳ | android.service.media.MediaBrowserService |
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 MediaSession
.
SERVICE_INTERFACE
action.
For example:
<service android:name=".MyMediaBrowserService" android:label="@string/service_name" > <intent-filter> <action android:name="android.media.browse.MediaBrowserService" /> </intent-filter> </service>
Nested classes | |
---|---|
class |
MediaBrowserService.BrowserRoot
Contains information that the browser service needs to send to the client when first connected. |
class |
MediaBrowserService.Result<T>
Completion handler for asynchronous callback methods in |
Constants | |
---|---|
String |
SERVICE_INTERFACE
The |
Inherited constants |
---|
From
class
android.app.Service
|
From
class
android.content.Context
|
From
interface
android.content.ComponentCallbacks2
|
Public constructors | |
---|---|
MediaBrowserService()
|
Public methods | |
---|---|
void
|
dump(FileDescriptor fd, PrintWriter writer, String[] args)
Print the Service's state into the given stream. |
final
Bundle
|
getBrowserRootHints()
Gets the root hints sent from the currently connected |
MediaSession.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, Bundle options)
Notifies all connected media browsers that the children of the specified parent id have changed in some way. |
void
|
notifyChildrenChanged(String parentId)
Notifies all connected media browsers that the children of the specified parent id have changed in some way. |
IBinder
|
onBind(Intent intent)
Return the communication channel to the service. |
void
|
onCreate()
Called by the system when the service is first created. |
abstract
MediaBrowserService.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<MediaBrowser.MediaItem>> result)
Called to get information about the children of a media item. |
void
|
onLoadChildren(String parentId, Result<List<MediaBrowser.MediaItem>> result, Bundle options)
Called to get information about the children of a media item. |
void
|
onLoadItem(String itemId, Result<MediaBrowser.MediaItem> result)
Called to get information about a specific media item. |
void
|
setSessionToken(MediaSession.Token token)
Call to set the media session. |
Inherited methods | |
---|---|
From
class
android.app.Service
| |
From
class
android.content.ContextWrapper
| |
From
class
android.content.Context
| |
From
class
java.lang.Object
| |
From
interface
android.content.ComponentCallbacks2
| |
From
interface
android.content.ComponentCallbacks
|
String SERVICE_INTERFACE
The Intent
that must be declared as handled by the service.
Constant Value: "android.media.browse.MediaBrowserService"
void dump (FileDescriptor fd, PrintWriter writer, String[] args)
Print the Service's state into the given stream. This gets invoked if
you run "adb shell dumpsys activity service <yourservicename>"
(note that for this command to work, the service must be running, and
you must specify a fully-qualified service name).
This is distinct from "dumpsys <servicename>", which only works for
named system services and which invokes the dump(FileDescriptor, String[])
method
on the IBinder
interface registered with ServiceManager.
Parameters | |
---|---|
fd |
FileDescriptor :
The raw file descriptor that the dump is being sent to. |
writer |
PrintWriter :
The PrintWriter to which you should dump your state. This will be
closed for you after you return. |
args |
String :
additional arguments to the dump request.
|
Bundle getBrowserRootHints ()
Gets the root hints sent from the currently connected MediaBrowser
.
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.
Returns | |
---|---|
Bundle |
Throws | |
---|---|
IllegalStateException |
If this method is called outside of onLoadChildren(String, MediaBrowserService.Result
or onLoadItem(String, MediaBrowserService.Result |
See also:
MediaSession.Token getSessionToken ()
Gets the session token, or null if it has not yet been created or if it has been destroyed.
Returns | |
---|---|
MediaSession.Token |
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.
|
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.
|
IBinder onBind (Intent intent)
Return the communication channel to the service. May return null if
clients can not bind to the service. The returned
IBinder
is usually for a complex interface
that has been described using
aidl.
Note that unlike other application components, calls on to the IBinder interface returned here may not happen on the main thread of the process. More information about the main thread can be found in Processes and Threads.
Parameters | |
---|---|
intent |
Intent :
The Intent that was used to bind to this service,
as given to Context.bindService . Note that any extras that were included with
the Intent at that point will not be seen here. |
Returns | |
---|---|
IBinder |
Return an IBinder through which clients can call on to the service. |
void onCreate ()
Called by the system when the service is first created. Do not call this method directly.
MediaBrowserService.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 | |
---|---|
MediaBrowserService.BrowserRoot |
The MediaBrowserService.BrowserRoot for accessing this app's content or null. |
See also:
void onLoadChildren (String parentId, Result<List<MediaBrowser.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.
|
void onLoadChildren (String parentId, Result<List<MediaBrowser.MediaItem>> result, 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(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. |
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.
|
void onLoadItem (String itemId, Result<MediaBrowser.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
, which will
invoke onError(String)
.
The default implementation calls result.sendResult
with null
.
Parameters | |
---|---|
itemId |
String :
The id for the specific
MediaBrowser.MediaItem . |
result |
Result :
The Result to send the item to.
|
void setSessionToken (MediaSession.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 |
MediaSession.Token :
The token for the service's MediaSession .
|