MediaLibraryService

Kotlin |Java

abstract class MediaLibraryService : MediaSessionService

kotlin.Any
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	androidx.media2.session.MediaSessionService
				↳	androidx.media2.session.MediaLibraryService

Base class for media library services, which is the service containing MediaLibrarySession.

Media library 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.

When extending this class, also add the following to your AndroidManifest.xml.

<service android:name="component_name_of_your_implementation" >
    <intent-filter>
      <action android:name="androidx.media2.session.MediaLibraryService" />
    </intent-filter>
  </service>

You may also declare

android.media.browse.MediaBrowserService

for compatibility with android.support.v4.media.MediaBrowserCompat. This service can handle it automatically.

Summary

Nested classes
	`LibraryParams` Contains information that the library service needs to send to the client.
	`MediaLibrarySession` Session for the `MediaLibraryService`.

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

Public constructors
`<init>()` Base class for media library services, which is the service containing `MediaLibrarySession`.

Public methods
open IBinder?	`onBind(@NonNull intent: Intent)`
abstract MediaLibraryService.MediaLibrarySession?	`onGetSession(@NonNull controllerInfo: MediaSession.ControllerInfo)`

Inherited functions

From class MediaSessionService

`Unit`	`addSession(@NonNull session: MediaSession)` Adds a session to this service. This is not necessary for most media apps. See Supporting Multiple Sessions for detail. Added session will be removed automatically when it's closed, or removed when `removeSession` is called.
`MutableList<MediaSession!>`	`getSessions()` Gets the list of `MediaSession`s that you've added to this service via `addSession` or `onGetSession(ControllerInfo)`.
`Unit`	`onCreate()` Called by the system when the service is first created. Do not call this method directly. Override this method if you need your own initialization. Derived classes MUST call through to the super class's implementation of this method.
`Unit`	`onDestroy()` Called by the system to notify that it is no longer used and is being removed. Do not call this method directly. Override this method if you need your own clean up. Derived classes MUST call through to the super class's implementation of this method.
`Int`	`onStartCommand(intent: Intent!, flags: Int, startId: Int)`
`MediaSessionService.MediaNotification?`	`onUpdateNotification(@NonNull session: MediaSession)` Called when notification UI needs update. Override this method to show or cancel your own notification UI. This would be called on `MediaSession`'s callback executor when player state is changed. With the notification returned here, the service becomes foreground service when the playback is started. Apps targeting API `android.os.Build.VERSION_CODES#P` or later must request the permission `android.Manifest.permission#FOREGROUND_SERVICE` in order to use this API. It becomes background service after the playback is stopped.
`Unit`	`removeSession(@NonNull session: MediaSession)` Removes a session from this service. This is not necessary for most media apps. See Supporting Multiple Sessions for detail.

Constants

SERVICE_INTERFACE

static val SERVICE_INTERFACE: String

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

Value: "androidx.media2.session.MediaLibraryService"

Public constructors

<init>

MediaLibraryService()

Base class for media library services, which is the service containing MediaLibrarySession.

When extending this class, also add the following to your AndroidManifest.xml.

<service android:name="component_name_of_your_implementation" >
    <intent-filter>
      <action android:name="androidx.media2.session.MediaLibraryService" />
    </intent-filter>
  </service>

You may also declare

android.media.browse.MediaBrowserService

for compatibility with android.support.v4.media.MediaBrowserCompat. This service can handle it automatically.

See Also

MediaSessionService

Public methods

onBind

open fun onBind(@NonNull intent: Intent): IBinder?

onGetSession

@Nullable abstract fun onGetSession(@NonNull controllerInfo: MediaSession.ControllerInfo): MediaLibraryService.MediaLibrarySession?