AVController

java.lang.Object
- ohos.media.sessioncore.AVController

```
public final class AVController
extends Object
```
Allows your application to interact with media sessions to control media playback, for example, to start or stop playback, or play the next media item. You can register a callback to receive changes, for example, of metadata and playback states from a media session.

从以下版本开始:

3

另请参阅:

AVSession

SystemCapability

SystemCapability.Multimedia#MEDIA

嵌套类概要

嵌套类
限定符和类型	类	说明
`class`	`AVController.PlayControls`	An inner class of `AVController` to send media playback requests to the `AVSession` and allow your application to send commands to the media session.

构造器概要

构造器
构造器	说明
`AVController(Context context, AVToken avToken)`	A constructor used to create an `AVController` instance for your application to control media playback.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`void`	`adjustAVPlaybackVolume(int direction, int flags)`	Adjusts relative volume for the playback.
`boolean`	`dispatchAVKeyEvent(KeyEvent keyEvent)`	Dispatches a key event to the media session for the application to control playback.
`AVMetadata`	`getAVMetadata()`	Obtains metadata of the media item.
`AVPlaybackState`	`getAVPlaybackState()`	Obtains the playback state.
`List<AVQueueElement>`	`getAVQueueElement()`	Obtains the playback queue.
`CharSequence`	`getAVQueueTitle()`	Obtains the title of the playback queue.
`IntentAgent`	`getAVSessionAbility()`	Obtains the `IntentAgent` instance for starting the user interface.
`PacMap`	`getAVSessionInfo()`	Obtains additional information about the media session.
`AVToken`	`getAVToken()`	Obtains the token for your application to connect to the `AVSession` instance.
`long`	`getFlags()`	Obtains flags for additional data of the `AVSession` instance in which the flags have been defined.
`PacMap`	`getOptions()`	Obtains additional data of the `AVSession` instance connected to this `AVController`.
`AVController.PlayControls`	`getPlayControls()`	Obtains a `PlayControls` instance to control playback, for example, to start or stop playback, or play the next item.
`String`	`getSessionOwnerPackageName()`	Obtains the application bundle name in the `AVSession` instance.
`boolean`	`releaseAVControllerCallback(AVControllerCallback callback)`	Releases the callback set for the `AVSession` instance.
`void`	`sendCustomCommand(String command, PacMap pacMap, GeneralReceiver receiverCb)`	Sends a custom command from the application to the media session.
`boolean`	`setAVControllerCallback(AVControllerCallback callback)`	Registers a callback to receive changes, for example, of metadata and playback states from a media session.
`void`	`setAVPlaybackVolume(int value, int flags)`	Sets absolute volume for the playback.
`static boolean`	`setControllerForAbility(Ability ability, AVController controller)`	Registers this `AVController` with an `Ability` to receive a key event.

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

- 构造器详细资料
  - AVController
```
public AVController(Context context,
                    AVToken avToken)
```
    A constructor used to create an AVController instance for your application to control media playback.
    
    参数:
    
    context - Indicates the application context.
    
    avToken - Indicates the media session token.
    
    从以下版本开始:
    
    3
- 方法详细资料
  - setControllerForAbility
```
public static boolean setControllerForAbility(Ability ability,
                                              AVController controller)
```
    Registers this AVController with an Ability to receive a key event.
    
    参数:
    
    ability - Indicates the ability to register the controller with.
    
    controller - Indicates the AVController instance to register.
    
    返回:
    
    Returns true if the registration is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setAVControllerCallback
```
public boolean setAVControllerCallback(AVControllerCallback callback)
```
    Registers a callback to receive changes, for example, of metadata and playback states from a media session.
    
    参数:
    
    callback - Indicates the callback to implement for your application. For available callbacks, see AVControllerCallback.
    
    返回:
    
    Returns true if the registration is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - releaseAVControllerCallback
```
public boolean releaseAVControllerCallback(AVControllerCallback callback)
```
    Releases the callback set for the AVSession instance.
    
    参数:
    
    callback - Indicates the callback to implement for your application. For available callbacks, see AVControllerCallback.
    
    返回:
    
    Returns true if the callback is released; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getAVQueueElement
```
public List<AVQueueElement> getAVQueueElement()
```
    Obtains the playback queue.
    
    返回:
    
    Returns the playback queue.
    
    从以下版本开始:
    
    3
  - getAVQueueTitle
```
public CharSequence getAVQueueTitle()
```
    Obtains the title of the playback queue.
    
    返回:
    
    Returns the title.
    
    从以下版本开始:
    
    3
  - getAVPlaybackState
```
public AVPlaybackState getAVPlaybackState()
```
    Obtains the playback state.
    
    返回:
    
    Returns the playback state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState
  - dispatchAVKeyEvent
```
public boolean dispatchAVKeyEvent(KeyEvent keyEvent)
```
    Dispatches a key event to the media session for the application to control playback.
    
    参数:
    
    keyEvent - Indicates the key event.
    
    返回:
    
    Returns true if the dispatch is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - sendCustomCommand
```
public void sendCustomCommand(String command,
                              PacMap pacMap,
                              GeneralReceiver receiverCb)
```
    Sends a custom command from the application to the media session.
    You can refer to AVSessionCallback.onCommand(java.lang.String, ohos.utils.PacMap, ohos.app.GeneralReceiver) to specify the input parameters.
    
    参数:
    
    command - Indicates the command.
    
    pacMap - Indicates command parameters, which can be null.
    
    receiverCb - Indicates the callback that receives the execution result. This parameter can be null.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the command is null.
    
    从以下版本开始:
    
    3
  - getAVSessionAbility
```
public IntentAgent getAVSessionAbility()
```
    Obtains the IntentAgent instance for starting the user interface.
    
    返回:
    
    Returns the IntentAgent instance.
    
    从以下版本开始:
    
    3
  - getAVToken
```
public AVToken getAVToken()
```
    Obtains the token for your application to connect to the AVSession instance. This token is used to create an AVController instance.
    
    返回:
    
    Returns the token.
  - adjustAVPlaybackVolume
```
public void adjustAVPlaybackVolume(int direction,
                                   int flags)
```
    Adjusts relative volume for the playback. The adjustment direction must be one of the following:
    - Increase: -1
    - Decrease: 1
    - Remain: 0
    参数:
    
    direction - Indicates the adjustment direction.
    
    flags - Indicates flags for additional information.
    
    从以下版本开始:
    
    3
  - setAVPlaybackVolume
```
public void setAVPlaybackVolume(int value,
                                int flags)
```
    Sets absolute volume for the playback.
    
    参数:
    
    value - Indicates the playback volume to set to.
    
    flags - Indicates flags for additional information.
    
    从以下版本开始:
    
    3
  - getOptions
```
public PacMap getOptions()
```
    Obtains additional data of the AVSession instance connected to this AVController.
    
    返回:
    
    Returns the additional data of the AVSession instance.
    
    从以下版本开始:
    
    3
  - getFlags
```
public long getFlags()
```
    Obtains flags for additional data of the AVSession instance in which the flags have been defined.
    
    返回:
    
    Returns the flags for additional data.
    
    从以下版本开始:
    
    3
  - getAVMetadata
```
public AVMetadata getAVMetadata()
```
    Obtains metadata of the media item.
    
    返回:
    
    Returns the AVMetadata instance.
    
    从以下版本开始:
    
    3
  - getSessionOwnerPackageName
```
public String getSessionOwnerPackageName()
```
    Obtains the application bundle name in the AVSession instance.
    
    返回:
    
    Returns the application bundle name.
    
    从以下版本开始:
    
    3
  - getAVSessionInfo
```
public PacMap getAVSessionInfo()
```
    Obtains additional information about the media session.
    
    返回:
    
    Returns the additional information about the media session.
    
    从以下版本开始:
    
    3
  - getPlayControls
```
public AVController.PlayControls getPlayControls()
```
    Obtains a PlayControls instance to control playback, for example, to start or stop playback, or play the next item.
    
    返回:
    
    Returns the PlayControls instance.
    
    从以下版本开始:
    
    3

类 AVController

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

AVController

方法详细资料

setControllerForAbility

setAVControllerCallback

releaseAVControllerCallback

getAVQueueElement

getAVQueueTitle

getAVPlaybackState

dispatchAVKeyEvent

sendCustomCommand

getAVSessionAbility

getAVToken

adjustAVPlaybackVolume

setAVPlaybackVolume

getOptions

getFlags

getAVMetadata

getSessionOwnerPackageName

getAVSessionInfo

getPlayControls