/
Android Studio Sign in

MediaLibraryService

abstract class MediaLibraryService : MediaSessionService

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

Superclass to be extended by services hosting media library sessions.

It enables applications to browse media content provided by an application, ask the application to start playback, and control the playback.

To extend this class, declare the intent filter in your AndroidManifest.xml. 

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

You may also declare android.media.browse.MediaBrowserService for compatibility with android.support.v4.media.MediaBrowserCompat so that this service can handle the case.

See also
MediaSessionService

Summary

Nested types

Parameters for the interaction between MediaBrowser and MediaLibrarySession.

A builder for LibraryParams.

An extended MediaSession for the MediaLibraryService.

A builder for MediaLibrarySession.

An extended MediaSession.Callback for the MediaLibrarySession.

Constants
const String!
SERVICE_INTERFACE = "androidx.media3.session.MediaLibraryService"

The action for Intent filter that must be declared by the service.

Public constructors

Public functions
IBinder?
onBind(intent: Intent?)

Called when a component is about to bind to the service.
abstract MediaLibraryService.MediaLibrarySession?

Called when a is created with this service's .

Inherited Constants
From android.content.ComponentCallbacks2
const Int
const Int

This property is deprecated.
const Int

This property is deprecated.
const Int

This property is deprecated.
const Int

This property is deprecated.
const Int

This property is deprecated.
const Int
From android.content.Context
const String!
ACCESSIBILITY_SERVICE = "accessibility"
const String!
ACCOUNT_SERVICE = "account"
const String!
ACTIVITY_SERVICE = "activity"
const String!
ADVANCED_PROTECTION_SERVICE = "advanced_protection"
const String!
ALARM_SERVICE = "alarm"
const String!
APPWIDGET_SERVICE = "appwidget"
const String!
APP_FUNCTION_SERVICE = "app_function"
const String!
APP_OPS_SERVICE = "appops"
const String!
APP_SEARCH_SERVICE = "app_search"
const String!
AUDIO_SERVICE = "audio"
const String!
BATTERY_SERVICE = "batterymanager"
const Int
const Int
const Int
const Int
const Int
const Int
const Int
BIND_EXTERNAL_SERVICE = -2147483648
const Long
BIND_EXTERNAL_SERVICE_LONG = 4611686018427387904
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const String!
BIOMETRIC_SERVICE = "biometric"
const String!
BLOB_STORE_SERVICE = "blob_store"
const String!
BLUETOOTH_SERVICE = "bluetooth"
const String!
BUGREPORT_SERVICE = "bugreport"
const String!
CAMERA_SERVICE = "camera"
const String!
CAPTIONING_SERVICE = "captioning"
const String!
CARRIER_CONFIG_SERVICE = "carrier_config"
const String!
CLIPBOARD_SERVICE = "clipboard"
const String!
COMPANION_DEVICE_SERVICE = "companiondevice"
const String!
CONNECTIVITY_DIAGNOSTICS_SERVICE = "connectivity_diagnostics"
const String!
CONNECTIVITY_SERVICE = "connectivity"
const String!
CONSUMER_IR_SERVICE = "consumer_ir"
const String!
CONTACT_KEYS_SERVICE = "contact_keys"
const Int
const Int
const Int
const String!
CREDENTIAL_SERVICE = "credential"
const String!
CROSS_PROFILE_APPS_SERVICE = "crossprofileapps"
const Int
const Int
const String!
DEVICE_LOCK_SERVICE = "device_lock"
const String!
DEVICE_POLICY_SERVICE = "device_policy"
const String!
DISPLAY_HASH_SERVICE = "display_hash"
const String!
DISPLAY_SERVICE = "display"
const String!
DOMAIN_VERIFICATION_SERVICE = "domain_verification"
const String!
DOWNLOAD_SERVICE = "download"
const String!
DROPBOX_SERVICE = "dropbox"
const String!
EUICC_SERVICE = "euicc"
const String!
FILE_INTEGRITY_SERVICE = "file_integrity"
const String!
FINGERPRINT_SERVICE = "fingerprint"
const String!
GAME_SERVICE = "game"
const String!
GRAMMATICAL_INFLECTION_SERVICE = "grammatical_inflection"
const String!
HARDWARE_PROPERTIES_SERVICE = "hardware_properties"
const String!
HEALTHCONNECT_SERVICE = "healthconnect"
const String!
INPUT_METHOD_SERVICE = "input_method"
const String!
INPUT_SERVICE = "input"
const String!
IPSEC_SERVICE = "ipsec"
const String!
JOB_SCHEDULER_SERVICE = "jobscheduler"
const String!
KEYGUARD_SERVICE = "keyguard"
const String!
KEYSTORE_SERVICE = "keystore"
const String!
LAUNCHER_APPS_SERVICE = "launcherapps"
const String!
LAYOUT_INFLATER_SERVICE = "layout_inflater"
const String!
LOCALE_SERVICE = "locale"
const String!
LOCATION_SERVICE = "location"
const String!
MEDIA_COMMUNICATION_SERVICE = "media_communication"
const String!
MEDIA_METRICS_SERVICE = "media_metrics"
const String!
MEDIA_PROJECTION_SERVICE = "media_projection"
const String!
MEDIA_QUALITY_SERVICE = "media_quality"
const String!
MEDIA_ROUTER_SERVICE = "media_router"
const String!
MEDIA_SESSION_SERVICE = "media_session"
const String!
MIDI_SERVICE = "midi"
const Int
MODE_APPEND = 32768
const Int
const Int

This property is deprecated.
const Int
const Int
const Int

This property is deprecated.
const Int

This property is deprecated.
const String!
const String!
NFC_SERVICE = "nfc"
const String!
NOTIFICATION_SERVICE = "notification"
const String!
NSD_SERVICE = "servicediscovery"
const String!
OVERLAY_SERVICE = "overlay"
const String!
PEOPLE_SERVICE = "people"
const String!
PERFORMANCE_HINT_SERVICE = "performance_hint"
const String!
PERSISTENT_DATA_BLOCK_SERVICE = "persistent_data_block"
const String!
POWER_SERVICE = "power"
const String!
PRINT_SERVICE = "print"
const String!
PROFILING_SERVICE = "profiling"
const Int
const Int
const Int
const String!
RESTRICTIONS_SERVICE = "restrictions"
const String!
ROLE_SERVICE = "role"
const String!
SATELLITE_SERVICE = "satellite"
const String!
SEARCH_SERVICE = "search"
const String!
SECURITY_STATE_SERVICE = "security_state"
const String!
SENSOR_SERVICE = "sensor"
const String!
SHORTCUT_SERVICE = "shortcut"
const String!
STATUS_BAR_SERVICE = "statusbar"
const String!
STORAGE_SERVICE = "storage"
const String!
STORAGE_STATS_SERVICE = "storagestats"
const String!
SYSTEM_HEALTH_SERVICE = "systemhealth"
const String!
TELECOM_SERVICE = "telecom"
const String!
TELEPHONY_IMS_SERVICE = "telephony_ims"
const String!
const String!
TELEPHONY_SUBSCRIPTION_SERVICE = "telephony_subscription_service"
const String!
TETHERING_SERVICE = "tethering"
const String!
TEXT_CLASSIFICATION_SERVICE = "textclassification"
const String!
const String!
TV_AD_SERVICE = "tv_ad"
const String!
TV_INPUT_SERVICE = "tv_input"
const String!
TV_INTERACTIVE_APP_SERVICE = "tv_interactive_app"
const String!
UI_MODE_SERVICE = "uimode"
const String!
USAGE_STATS_SERVICE = "usagestats"
const String!
USB_SERVICE = "usb"
const String!
USER_SERVICE = "user"
const String!
VIBRATOR_MANAGER_SERVICE = "vibrator_manager"
const String!
VIBRATOR_SERVICE = "vibrator"

This property is deprecated.
const String!
VIRTUAL_DEVICE_SERVICE = "virtualdevice"
const String!
VPN_MANAGEMENT_SERVICE = "vpn_management"
const String!
WALLPAPER_SERVICE = "wallpaper"
const String!
WIFI_AWARE_SERVICE = "wifiaware"
const String!
WIFI_P2P_SERVICE = "wifip2p"
const String!
const String!
WIFI_SERVICE = "wifi"
const String!
WINDOW_SERVICE = "window"
From androidx.media3.session.MediaSessionService
const Long

The default timeout for a session to stay in a foreground service state after it paused, stopped, failed or ended.
const String!
SERVICE_INTERFACE = "androidx.media3.session.MediaSessionService"

The action for Intent filter that must be declared by the service.
const Int

Shows a notification when the Player is in STATE_IDLE due to stop or an error, has media, and the notification wasn't explicitly dismissed.
const Int

Always show a notification when the Player is in STATE_IDLE, has media, and the notification wasn't explicitly dismissed.
const Int

Never show a notification when the Player is in STATE_IDLE.
From android.app.Service
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int

This property is deprecated.
const Int

Inherited functions
From android.content.Context
Int
ColorStateList!
Drawable!
String!
getString(resId: Int)
T!
<T> getSystemService(serviceClass: Class<T!>!)
CharSequence!
getText(resId: Int)
TypedArray!
Unit
Unit
sendBroadcastWithMultiplePermissions(
    intent: Intent!,
    receiverPermissions: Array<String!>!
)
From android.content.ContextWrapper
Boolean
bindIsolatedService(
    service: Intent!,
    flags: Int,
    instanceName: String!,
    executor: Executor!,
    conn: ServiceConnection!
)
Boolean
bindService(
    service: Intent!,
    flags: Context.BindServiceFlags!,
    executor: Executor!,
    conn: ServiceConnection!
)
Boolean
bindServiceAsUser(
    service: Intent!,
    conn: ServiceConnection!,
    flags: Context.BindServiceFlags!,
    user: UserHandle!
)
Int
Int
IntArray<Int>!
checkCallingOrSelfUriPermissions(
    uris: (Mutable)List<Uri!>!,
    modeFlags: Int
)
Int
Int
checkCallingUriPermission(uri: Uri!, modeFlags: Int)
IntArray<Int>!
checkCallingUriPermissions(uris: (Mutable)List<Uri!>!, modeFlags: Int)
Int
checkContentUriPermissionFull(uri: Uri!, pid: Int, uid: Int, modeFlags: Int)
Int
checkPermission(permission: String!, pid: Int, uid: Int)
Int
Int
checkUriPermission(uri: Uri!, pid: Int, uid: Int, modeFlags: Int)
IntArray<Int>!
checkUriPermissions(
    uris: (Mutable)List<Uri!>!,
    pid: Int,
    uid: Int,
    modeFlags: Int
)
Unit

This function is deprecated.
Context!
createAttributionContext(attributionTag: String!)
Context!
createConfigurationContext(overrideConfiguration: Configuration!)
Context!
createContext(contextParams: ContextParams!)
Context!
Context!
Context!
Context!
Context!
createPackageContext(packageName: String!, flags: Int)
Context!
createWindowContext(display: Display!, type: Int, options: Bundle!)
Array<String!>!
Boolean
Boolean
Boolean
Unit
enforceCallingOrSelfPermission(permission: String!, message: String!)
Unit
enforceCallingOrSelfUriPermission(
    uri: Uri!,
    modeFlags: Int,
    message: String!
)
Unit
enforceCallingPermission(permission: String!, message: String!)
Unit
enforceCallingUriPermission(uri: Uri!, modeFlags: Int, message: String!)
Unit
enforcePermission(permission: String!, pid: Int, uid: Int, message: String!)
Unit
enforceUriPermission(
    uri: Uri!,
    pid: Int,
    uid: Int,
    modeFlags: Int,
    message: String!
)
Array<String!>!
Context!
ApplicationInfo!
AssetManager!
AttributionSource!
String!
Context!
File!
ClassLoader!
File!
ContentResolver!
File!
File!
Int
File!
getDir(name: String!, mode: Int)
Display!
File!
Array<File!>!
File!
Array<File!>!
Array<File!>!

This function is deprecated.
File!
File!
Executor!
Looper!
File!
File!
Array<File!>!
String!
String!
PackageManager!
String!
String!
ContextParams!
Resources!
SharedPreferences!
getSharedPreferences(name: String!, mode: Int)
Any!
String!
getSystemServiceName(serviceClass: Class<Any!>!)
Resources.Theme!
Drawable!

This function is deprecated.
Int

This function is deprecated.
Int

This function is deprecated.
Unit
grantUriPermission(toPackage: String!, uri: Uri!, modeFlags: Int)
Boolean
Boolean
Boolean
Boolean
moveDatabaseFrom(sourceContext: Context!, name: String!)
Boolean
moveSharedPreferencesFrom(sourceContext: Context!, name: String!)
FileInputStream!
FileOutputStream!
openFileOutput(name: String!, mode: Int)
SQLiteDatabase!
openOrCreateDatabase(
    name: String!,
    mode: Int,
    factory: SQLiteDatabase.CursorFactory!
)
Drawable!

This function is deprecated.
Unit
Unit
Intent!
Unit

This function is deprecated.
Unit

This function is deprecated.
Unit
Unit
revokeUriPermission(uri: Uri!, modeFlags: Int)
Unit
Unit
Unit
sendOrderedBroadcast(
    intent: Intent!,
    initialCode: Int,
    receiverPermission: String!,
    receiverAppOp: String!,
    resultReceiver: BroadcastReceiver!,
    scheduler: Handler!,
    initialData: String!,
    initialExtras: Bundle!,
    options: Bundle!
)
Unit
sendOrderedBroadcastAsUser(
    intent: Intent!,
    user: UserHandle!,
    receiverPermission: String!,
    resultReceiver: BroadcastReceiver!,
    scheduler: Handler!,
    initialCode: Int,
    initialData: String!,
    initialExtras: Bundle!
)
Unit

This function is deprecated.
Unit

This function is deprecated.
Unit
sendStickyOrderedBroadcast(
    intent: Intent!,
    resultReceiver: BroadcastReceiver!,
    scheduler: Handler!,
    initialCode: Int,
    initialData: String!,
    initialExtras: Bundle!
)

This function is deprecated.
Unit
sendStickyOrderedBroadcastAsUser(
    intent: Intent!,
    user: UserHandle!,
    resultReceiver: BroadcastReceiver!,
    scheduler: Handler!,
    initialCode: Int,
    initialData: String!,
    initialExtras: Bundle!
)

This function is deprecated.
Unit
setTheme(resid: Int)
Unit
setWallpaper(bitmap: Bitmap!)

This function is deprecated.
Unit
Unit
ComponentName!
Boolean
startInstrumentation(
    className: ComponentName!,
    profileFile: String!,
    arguments: Bundle!
)
Unit
startIntentSender(
    intent: IntentSender!,
    fillInIntent: Intent!,
    flagsMask: Int,
    flagsValues: Int,
    extraFlags: Int
)
ComponentName!
startService(service: Intent!)
Boolean
Unit
Unit
Unit
Unit
Unit
updateServiceGroup(conn: ServiceConnection!, group: Int, importance: Int)
From androidx.media3.session.MediaSessionService
Unit

Adds a MediaSession to this service.
Unit

Clears the listener.
(Mutable)List<MediaSession!>!

Returns the list of sessions that you've added to this service via addSession or onGetSession.
Boolean

Returns whether there is a session with ongoing user-engaged playback that is run in a foreground service.
Boolean

Returns whether session has been added to this service via addSession or onGetSession.
Unit

Called when the service is created.
Unit

Called when the service is no longer used and is being removed.
Int
@CallSuper
onStartCommand(intent: Intent?, flags: Int, startId: Int)

Called when a component calls startService.
Unit
onTaskRemoved(rootIntent: Intent?)

This method can be overridden to customize the behavior of when the app is dismissed from the recent apps.
Unit

This function is deprecated.

Use onUpdateNotification instead.
Unit
onUpdateNotification(
    session: MediaSession!,
    startInForegroundRequired: Boolean
)

Called when a notification needs to be updated.
Unit

Pauses the player of each session managed by the service, ensures the foreground service is stopped, and calls stopSelf.
Unit

Removes a MediaSession from this service.
Unit
@UnstableApi
setForegroundServiceTimeoutMs(foregroundServiceTimeoutMs: Long)

Sets the timeout for a session to stay in a foreground service state after it paused, stopped, failed or ended.
Unit

Sets the listener.
Unit

Sets the MediaNotification.Provider to customize notifications.
Unit

Sets whether and when a notification for a Player in STATE_IDLE should be shown.
Unit

Manually trigger a notification update.
From android.app.Service
Unit
Unit
dump(fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>!)
Application!
Int
abstract IBinder!
Unit
Unit
Unit
Unit

This function is deprecated.
Unit
onRebind(intent: Intent!)
Unit
onStart(intent: Intent!, startId: Int)

This function is deprecated.
Int
onStartCommand(intent: Intent!, flags: Int, startId: Int)
Unit
onTaskRemoved(rootIntent: Intent!)
Unit
onTimeout(startId: Int)
Unit
onTrimMemory(level: Int)
Boolean
onUnbind(intent: Intent!)
Unit
startForeground(id: Int, notification: Notification!)
Unit
stopForeground(removeNotification: Boolean)

This function is deprecated.
Unit
Boolean
stopSelfResult(startId: Int)

Constants

SERVICE_INTERFACE

const val SERVICE_INTERFACE = "androidx.media3.session.MediaLibraryService": String!

The action for Intent filter that must be declared by the service.

Public constructors

MediaLibraryService

MediaLibraryService()

Public functions

onBind

fun onBind(intent: Intent?): IBinder?

Called when a component is about to bind to the service.

The default implementation handles the incoming requests from controllers. In this case, the intent will have the action SERVICE_INTERFACE. Override this method if this service also needs to handle actions other than SERVICE_INTERFACE.

This method will be called on the main thread.

onGetSession

abstract fun onGetSession(controllerInfo: MediaSession.ControllerInfo!): MediaLibraryService.MediaLibrarySession?

Called when a is created with this service's . Return a that the controller will connect to, or null} to reject the connection request.

Note: This method must not be called directly by app code.

The service automatically maintains the returned sessions. In other words, a session returned by this method will be added to the service, and removed from the service when the session is closed. You don't need to manually call #addSession(MediaSession) nor * #removeSession(MediaSession).

There are two special cases where the ControllerInfo#getPackageName() returns a non-existent package name:

  • When the service is started by a media button event, the package name will be * Intent#ACTION_MEDIA_BUTTON. If you want to allow the service to be started by media button events, do not return null}.
  • When a legacy or a *android.support.v4.media.MediaBrowserCompat tries to connect, the package name will be android.service.media.MediaBrowserService#SERVICE_INTERFACE. If you want to allow the service to be bound by the legacy media browsers, do not return null}.

For those special cases, the values returned by ControllerInfo#getUid() and * ControllerInfo#getConnectionHints() have no meaning.

This method will be called on the main thread.

It must return a MediaLibrarySession which is a subclass of MediaSession.
Morty Proxy This is a proxified and sanitized view of the page, visit original site.