AVBrowserService

java.lang.Object
- ohos.app.AbilityContext
- - ohos.aafwk.ability.Ability
  - - ohos.media.sessioncore.AVBrowserService

所有已实现的接口:

ILifecycle, Context
```
public abstract class AVBrowserService
extends Ability
```
Base class used to access the media browser service.
The media browser service enables your application to browse and play media items from another application.
To extend this class, you need to configure the config.json for your project with "actions" in the "skills" attribute set to SERVICE_ACTION.
Example code:
```
 {
   "name": ".MyAVBrowserService",
   "skills": [
     {
       "actions": [
         "action.media.browse.AVBrowserService"
       ]
     }
   ],
   "type": "service",
 }
 
```
从以下版本开始:

3

SystemCapability

SystemCapability.Multimedia#MEDIA

嵌套类概要
- 从类继承的嵌套类/接口 ohos.aafwk.ability.Ability
  Ability.LayoutParamsHelper, Ability.WindowAttributeHelper

字段概要

字段
限定符和类型字段说明

static String SERVICE_ACTION
Indicates the action name of the media browser service.
- 从类继承的字段 ohos.aafwk.ability.Ability
  FORM_INVISIBLE, FORM_VISIBLE
- 从接口继承的字段 ohos.app.Context
  CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESOUCE_ONLY, CONTEXT_RESTRICTED, MODE_APPEND, MODE_PRIVATE

字段
限定符和类型	字段	说明
`static String`	`SERVICE_ACTION`	Indicates the action name of the media browser service.

构造器概要

构造器
构造器说明

AVBrowserService()

构造器
构造器	说明
`AVBrowserService()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法	说明
`AVToken`	`getAVToken()`	Obtains the token for the session between the `AVBrowser` and this `AVBrowserService`.
`PacMap`	`getBrowserOptions()`	Obtains the media browser service parameters set when the `AVBrowser` connects to this `AVBrowserService`.
`AVCallerUserInfo`	`getCallerUserInfo()`	Obtains information about the remote user who sends the current request.
`void`	`notifyAVElementListUpdated(String parentMediaId)`	Notifies all connected `AVBrowser` instances that the child media items of the current parent media item have changed.
`void`	`notifyAVElementListUpdated(String parentMediaId, PacMap options)`	Notifies all connected `AVBrowser` instances that the child media items of the current parent media item have changed, with media browser service parameters set.
`abstract AVBrowserRoot`	`onGetRoot(String callerPackageName, int clientUid, PacMap options)`	Called after the `AVBrowser#connect()` method to return the information about the root item.
`abstract void`	`onLoadAVElement(String mediaId, AVBrowserResult result)`	Called after `AVBrowser#getAVElement` to obtain the `AVBrowserResult` instance of the `AVElement` specified by the media item ID.
`abstract void`	`onLoadAVElementList(String parentMediaId, AVBrowserResult result)`	Called after `AVBrowser#subscribeByParentMediaId` or `notifyAVElementListUpdated(java.lang.String)` to return the requested `AVBrowserResult` instance, including a list of `AVElement` instances for child media items.
`abstract void`	`onLoadAVElementList(String parentMediaId, AVBrowserResult result, PacMap options)`	Called after `AVBrowser#subscribeByParentMediaId` or `notifyAVElementListUpdated(java.lang.String)` to return the requested `AVBrowserResult` instance and media browser service parameters.
`protected void`	`onStart(Intent intent)`	Called back when an ability is started for initialization (it can be called only once in the entire lifecycle of an ability).
`void`	`setAVToken(AVToken token)`	Sets the token for the session between the `AVBrowser` and this `AVBrowserService`.

从类继承的方法 ohos.aafwk.ability.Ability
addActionRoute, batchInsert, call, cancelBackgroundRunning, connectAbility, continueAbility, continueAbility, continueAbilityReversibly, continueAbilityReversibly, createPipeFile, delete, denormalizeUri, disconnectAbility, dispatchAccessibilityEventInfo, executeBatch, executeOperation, findComponentById, getAbilityName, getAbilityPackage, getAdmissionTransitionConcurEnabled, getAdmissionTransitionObject, getAVController, getBackTransitionConcurEnabled, getBackTransitionObject, getContinuationRegisterManager, getContinuationState, getCurrentFocus, getFileTypes, getIntent, getLayoutParams, getLifecycle, getOriginalDeviceId, getQuitTransitionObject, getReadmissionTransitionObject, getSharedItemAdmissionTransitionObject, getSharedItemBackTransitionObject, getSharedItemQuitTransitionObject, getSharedItemReadmissionTransitionObject, getState, getType, getVolumeTypeAdjustedByKey, getWindow, hasWindowFocus, insert, isTemporary, isTerminating, keepBackgroundRunning, normalizeUri, onAbilityResult, onAcquireFormState, onActive, onBackground, onBackPressed, onCastTempForm, onCommand, onCommand, onConfigurationUpdated, onConnect, onCreateForm, onCreateForm, onDeleteForm, onDeleteForm, onDisconnect, onEventDispatch, onEventNotify, onForeground, onHotkeyTriggered, onInactive, onInitialized, onKeyDown, onKeyPressAndHold, onKeyUp, onLeaveForeground, onMemoryLevel, onMissionDeleted, onNewDescription, onNewIntent, onOrientationChanged, onPostActive, onPostStart, onReconnect, onRequestPermissionsFromUserResult, onRestoreAbilityState, onSaveAbilityState, onSetCaller, onStop, onStoreDataWhenConfigChange, onTopActiveAbilityChanged, onTouchEvent, onTriggerFormEvent, onTriggerFormEvent, onUnloadForm, onUpdateForm, onUpdateForm, onWindowFocusChanged, openFile, openRawFile, parsePredictionArgsReference, parseValuesBucketReference, postTask, query, reload, reverseContinueAbility, setAbilitySliceAnimator, setAdmissionTransitionConcurEnabled, setAdmissionTransitionObject, setAVController, setBackTransitionConcurEnabled, setBackTransitionObject, setFormNextRefreshTime, setIntent, setIsAmbientMode, setLayoutParams, setMainRoute, setQuitTransitionObject, setReadmissionTransitionObject, setResult, setSharedItemAdmissionTransitionObject, setSharedItemBackTransitionObject, setSharedItemQuitTransitionObject, setSharedItemReadmissionTransitionObject, setSwipeToDismiss, setUIContent, setUIContent, setVolumeTypeAdjustedByKey, setWindowBackgroundColor, shutdown, startAbility, startAbility, startAbility, startAbility, startAbilityForResult, startAbilityForResult, startAssistAbility, stopAbility, stopAssistAbility, supportHighPerformanceUI, terminateAbility, update, updateForm, updateForm, updateForm, updateForm

从类继承的方法 ohos.app.AbilityContext
attachBaseContext, canRequestPermission, compelVerifyCallerPermission, compelVerifyCallerUriPermission, compelVerifyPermission, compelVerifyPermission, compelVerifyUriPermission, compelVerifyUriPermission, compelVerifyUriPermission, createBundleContext, createParallelTaskDispatcher, createSerialTaskDispatcher, deleteFile, displayUnlockMissionMessage, getAbilityInfo, getAbilityManager, getAbilityPackageContext, getApplicationContext, getApplicationInfo, getAppType, getBundleCodePath, getBundleManager, getBundleName, getBundleResourcePath, getCacheDir, getCaller, getCallingAbility, getCallingBundle, getClassloader, getCodeCacheDir, getColor, getColorMode, getContext, getDatabaseDir, getDataDir, getDir, getDisplayOrientation, getDistributedDir, getElementName, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getGlobalTaskDispatcher, getHapModuleInfo, getIntArray, getLastStoredDataWhenConfigChanged, getLocalClassName, getMainTaskDispatcher, getNoBackupFilesDir, getPattern, getPreferencesDir, getProcessInfo, getProcessName, getResourceManager, getResourceManager, getString, getString, getStringArray, getTheme, getThemeId, getUITaskDispatcher, init, isCredentialEncryptedStorage, isDeviceEncryptedStorage, isUpdatingConfigurations, lockMission, printDrawnCompleted, requestPermissionsFromUser, restart, setColorMode, setDisplayOrientation, setPattern, setShowOnLockScreen, setTheme, setTransitionAnimation, setWakeUpScreen, startAbilities, startAbility, startAbility, startAbility, switchToCredentialEncryptedStorageContext, switchToDeviceEncryptedStorageContext, terminateAbility, terminateAbilityResult, unlockMission, verifyCallingOrSelfPermission, verifyCallingPermission, verifyPermission, verifySelfPermission

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - SERVICE_ACTION
```
public static final String SERVICE_ACTION
```
    Indicates the action name of the media browser service.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AVBrowserService
```
public AVBrowserService()
```
- 方法详细资料
  - onStart
```
protected void onStart(Intent intent)
```
    从类复制的说明: Ability
    
    Called back when an ability is started for initialization (it can be called only once in the entire lifecycle of an ability).
    Most initialization operations should be performed by calling this method. For example, you can use the current method to call Ability.setMainRoute(java.lang.String) and Ability.addActionRoute(java.lang.String,java.lang.String) to set the main router and action router for a Page ability.
    
    覆盖:
    
    onStart 在类中 Ability
    
    参数:
    
    intent - Indicates information carried when this ability is started. Note: For a Service ability, null is passed.
  - onGetRoot
```
public abstract AVBrowserRoot onGetRoot(String callerPackageName,
                                        int clientUid,
                                        PacMap options)
```
    Called after the AVBrowser#connect() method to return the information about the root item.
    
    参数:
    
    callerPackageName - Indicates the bundle name of the application.
    
    clientUid - Indicates the user ID of the application.
    
    options - Indicates optional parameters sent to the media browser service when the AVBrowser instance is created.
    
    返回:
    
    Returns the AVBrowserRoot instance; returns null if your application does not have permission to access the root item.
    
    从以下版本开始:
    
    3
  - onLoadAVElementList
```
public abstract void onLoadAVElementList(String parentMediaId,
                                         AVBrowserResult result)
```
    Called after AVBrowser#subscribeByParentMediaId or notifyAVElementListUpdated(java.lang.String) to return the requested AVBrowserResult instance, including a list of AVElement instances for child media items.
    
    参数:
    
    parentMediaId - Indicates the ID of the parent media item in the AVBrowserResult instance.
    
    result - Indicates the AVBrowserResult instance.
    
    从以下版本开始:
    
    3
  - onLoadAVElementList
```
public abstract void onLoadAVElementList(String parentMediaId,
                                         AVBrowserResult result,
                                         PacMap options)
```
    Called after AVBrowser#subscribeByParentMediaId or notifyAVElementListUpdated(java.lang.String) to return the requested AVBrowserResult instance and media browser service parameters. The AVBrowserResult includes a list of AVElement instances for child media items.
    
    参数:
    
    parentMediaId - Indicates the ID of the parent media item in the AVBrowserResult instance.
    
    result - Indicates the AVBrowserResult instance.
    
    options - Indicates media browser service parameters.
    
    从以下版本开始:
    
    3
  - onLoadAVElement
```
public abstract void onLoadAVElement(String mediaId,
                                     AVBrowserResult result)
```
    Called after AVBrowser#getAVElement to obtain the AVBrowserResult instance of the AVElement specified by the media item ID.
    
    参数:
    
    mediaId - Indicates the media item ID.
    
    result - Indicates the AVBrowserResult instance of the media item.
    
    从以下版本开始:
    
    3
  - getAVToken
```
public AVToken getAVToken()
```
    Obtains the token for the session between the AVBrowser and this AVBrowserService.
    
    返回:
    
    Returns the session token; returns null if the session is not created or has been destroyed.
    
    从以下版本开始:
    
    3
  - setAVToken
```
public void setAVToken(AVToken token)
```
    Sets the token for the session between the AVBrowser and this AVBrowserService.
    
    参数:
    
    token - Indicates the session token.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if token is null.
    
    IllegalStateException - Throws this exception if this method is called repeatedly to set the token.
    
    从以下版本开始:
    
    3
  - getBrowserOptions
```
public final PacMap getBrowserOptions()
```
    Obtains the media browser service parameters set when the AVBrowser connects to this AVBrowserService.
    
    返回:
    
    Returns the media browser service parameters.
    
    抛出:
    
    IllegalStateException - Throw this exception if this method is not called in the onGetRoot(java.lang.String, int, ohos.utils.PacMap), onLoadAVElementList(java.lang.String, ohos.media.common.sessioncore.AVBrowserResult), or onLoadAVElement(java.lang.String, ohos.media.common.sessioncore.AVBrowserResult) method.
    
    从以下版本开始:
    
    3
  - getCallerUserInfo
```
public final AVCallerUserInfo getCallerUserInfo()
```
    Obtains information about the remote user who sends the current request.
    
    返回:
    
    Returns the remote user information.
    
    从以下版本开始:
    
    3
  - notifyAVElementListUpdated
```
public void notifyAVElementListUpdated(String parentMediaId)
```
    Notifies all connected AVBrowser instances that the child media items of the current parent media item have changed.
    
    参数:
    
    parentMediaId - Indicates the ID of the parent media item.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if parentMediaId is null.
    
    从以下版本开始:
    
    3
  - notifyAVElementListUpdated
```
public void notifyAVElementListUpdated(String parentMediaId,
                                       PacMap options)
```
    Notifies all connected AVBrowser instances that the child media items of the current parent media item have changed, with media browser service parameters set.
    
    参数:
    
    parentMediaId - Indicates the ID of the parent media item.
    
    options - Indicates media browser service parameters.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if parentMediaId or {code options} is null.
    
    从以下版本开始:
    
    3

类 AVBrowserService

嵌套类概要

从类继承的嵌套类/接口 ohos.aafwk.ability.Ability

字段概要

从类继承的字段 ohos.aafwk.ability.Ability

从接口继承的字段 ohos.app.Context

构造器概要

方法概要

从类继承的方法 ohos.aafwk.ability.Ability

从类继承的方法 ohos.app.AbilityContext

从类继承的方法 java.lang.Object

字段详细资料

SERVICE_ACTION

构造器详细资料

AVBrowserService

方法详细资料

onStart

onGetRoot

onLoadAVElementList

onLoadAVElementList

onLoadAVElement

getAVToken

setAVToken

getBrowserOptions

getCallerUserInfo

notifyAVElementListUpdated

notifyAVElementListUpdated