AVSessionCallback

java.lang.Object
- ohos.media.common.sessioncore.AVSessionCallback

```
public abstract class AVSessionCallback
extends Object
```
Provides callbacks to control media playback. You can use AVSession.setAVSessionCallback(ohos.media.common.sessioncore.AVSessionCallback) to register callbacks to listen to media sessions.

从以下版本开始:

3

SystemCapability

SystemCapability.Multimedia#MEDIA

构造器概要

构造器
构造器说明

AVSessionCallback()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`void`	`onCommand(String command, PacMap options, GeneralReceiver callback)`	Called when the `ohos.media.sessioncore.AVController` sends a command to the media session.
`boolean`	`onMediaButtonEvent(Intent mediaButtonIntent)`	Called when a button event is triggered and the media session has the highest priority, or when the `AVController` sends a button event to the session.
`void`	`onPause()`	Called when the application is requested to pause the ongoing playback.
`void`	`onPlay()`	Called when the application is requested to start playback.
`void`	`onPlayByMediaId(String mediaId, PacMap options)`	Called when the application is requested to play the media item specified by the `AVBrowserService` of the application.
`void`	`onPlayBySearch(String query, PacMap options)`	Called when the application is requested to play a search result.
`void`	`onPlayByUri(Uri uri, PacMap options)`	Called when the application is requested to play the media item specified by a URI.
`void`	`onPlayFastForward()`	Called when the application is requested to fast forward the media item.
`void`	`onPlayNext()`	Called when the application is requested to play the next media item.
`void`	`onPlayPrevious()`	Called when the application is requested to play the previous media item.
`void`	`onPrepareToPlay()`	Called when the application is requested to prepare for playback.
`void`	`onPrepareToPlayByMediaId(String mediaId, PacMap options)`	Called when the application is requested to prepare for playing the media item specified by the `AVBrowserService`.
`void`	`onPrepareToPlayBySearch(String query, PacMap options)`	Called when the application is requested to prepare for starting playback from a search result.
`void`	`onPrepareToPlayByUri(Uri uri, PacMap options)`	Called when the application is requested to prepare for playing the media item specified by a URI.
`void`	`onRewind()`	Called when the application is requested to rewind the media item.
`void`	`onSeekTo(long position)`	Called when the application is requested to skip to a specified playback position.
`void`	`onSetAVPlaybackCustomAction(String action, PacMap options)`	Called when the `AVController` is about to execute a custom playback action defined in `AVPlaybackState.AVPlaybackCustomAction`.
`void`	`onSetAVPlaybackSpeed(float speed)`	Called when the application is requested to change the playback speed.
`void`	`onSkipToAVQueueElement(long queueId)`	Called when the application is requested to play a specified media item.
`void`	`onStop()`	Called when the application is requested to stop playing.

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

- 构造器详细资料
  - AVSessionCallback
```
public AVSessionCallback()
```
- 方法详细资料
  - onCommand
```
public void onCommand(String command,
                      PacMap options,
                      GeneralReceiver callback)
```
    Called when the ohos.media.sessioncore.AVController sends a command to the media session. The media session owner can process custom commands.
    
    参数:
    
    command - Indicates the command name.
    
    options - Indicates optional parameters of the command.
    
    callback - Indicates the callback that receives the execution result. This parameter can be null.
  - onMediaButtonEvent
```
public boolean onMediaButtonEvent(Intent mediaButtonIntent)
```
    Called when a button event is triggered and the media session has the highest priority, or when the AVController sends a button event to the session.
    
    参数:
    
    mediaButtonIntent - Indicates the intent that contains the AVSession.PARAM_KEY_EVENT field specifying a KeyEvent object, based on which playback is controlled. This intent is of the AVSession.ACTION_MEDIA_BUTTON type.
    
    返回:
    
    Returns true if the key event in the intent has been processed; returns false otherwise.
    
    从以下版本开始:
    
    3
  - onPrepareToPlay
```
public void onPrepareToPlay()
```
    Called when the application is requested to prepare for playback.
    You can override this callback to handle the request. After the preparation is completed, the playback state should be changed to AVPlaybackState#PLAYBACK_STATE_PAUSED.
    
    从以下版本开始:
    
    3
  - onPrepareToPlayByMediaId
```
public void onPrepareToPlayByMediaId(String mediaId,
                                     PacMap options)
```
    Called when the application is requested to prepare for playing the media item specified by the AVBrowserService.
    You can override this callback to handle the request. After the preparation is completed, the playback state should be changed to AVPlaybackState#PLAYBACK_STATE_PAUSED.
    
    参数:
    
    mediaId - Identifies the media item.
    
    options - Indicates additional information about the media item.
    
    从以下版本开始:
    
    3
  - onPrepareToPlayBySearch
```
public void onPrepareToPlayBySearch(String query,
                                    PacMap options)
```
    Called when the application is requested to prepare for starting playback from a search result.
    You can override this callback to handle the request. After the preparation is completed, the playback state should be changed to AVPlaybackState#PLAYBACK_STATE_PAUSED.
    
    参数:
    
    query - Indicates the search criteria. If this parameter is null, the application can prepare for any media item.
    
    options - Indicates additional data to search for.
    
    从以下版本开始:
    
    3
  - onPrepareToPlayByUri
```
public void onPrepareToPlayByUri(Uri uri,
                                 PacMap options)
```
    Called when the application is requested to prepare for playing the media item specified by a URI.
    You can override this callback to handle the request. After the preparation is completed, the playback state should be changed to AVPlaybackState#PLAYBACK_STATE_PAUSED.
    
    参数:
    
    uri - Indicates the media item URI.
    
    options - Indicates additional information about the media item.
    
    从以下版本开始:
    
    3
  - onPlay
```
public void onPlay()
```
    Called when the application is requested to start playback.
    You can override this callback to handle the request.
    
    从以下版本开始:
    
    3
  - onPlayBySearch
```
public void onPlayBySearch(String query,
                           PacMap options)
```
    Called when the application is requested to play a search result.
    
    参数:
    
    query - Indicates the search criteria. If this parameter is null, the application can play any media item.
    
    options - Indicates additional data to search for.
    
    从以下版本开始:
    
    3
  - onPlayByMediaId
```
public void onPlayByMediaId(String mediaId,
                            PacMap options)
```
    Called when the application is requested to play the media item specified by the AVBrowserService of the application.
    You can override this callback to handle the request.
    
    参数:
    
    mediaId - Indicates the media item ID.
    
    options - Indicates additional information about the media item.
    
    从以下版本开始:
    
    3
  - onPlayByUri
```
public void onPlayByUri(Uri uri,
                        PacMap options)
```
    Called when the application is requested to play the media item specified by a URI.
    You can override this callback to handle the request.
    
    参数:
    
    uri - Indicates the media item URI.
    
    options - Indicates additional information about the media item.
    
    从以下版本开始:
    
    3
  - onSkipToAVQueueElement
```
public void onSkipToAVQueueElement(long queueId)
```
    Called when the application is requested to play a specified media item.
    You can override this callback to handle the request.
    
    参数:
    
    queueId - Indicates the media item to play.
    
    从以下版本开始:
    
    3
  - onPause
```
public void onPause()
```
    Called when the application is requested to pause the ongoing playback.
    You can override this callback to handle the request.
    
    从以下版本开始:
    
    3
  - onSeekTo
```
public void onSeekTo(long position)
```
    Called when the application is requested to skip to a specified playback position.
    You can override this callback to handle the request.
    
    参数:
    
    position - Indicates the playback position (milliseconds) to skip to.
    
    从以下版本开始:
    
    3
  - onPlayNext
```
public void onPlayNext()
```
    Called when the application is requested to play the next media item.
    You can override this callback to handle the request.
    
    从以下版本开始:
    
    3
  - onPlayPrevious
```
public void onPlayPrevious()
```
    Called when the application is requested to play the previous media item.
    You can override this callback to handle the request.
    
    从以下版本开始:
    
    3
  - onPlayFastForward
```
public void onPlayFastForward()
```
    Called when the application is requested to fast forward the media item.
    You can override this callback to handle the request.
    
    从以下版本开始:
    
    3
  - onRewind
```
public void onRewind()
```
    Called when the application is requested to rewind the media item.
    You can override this callback to handle the request.
    
    从以下版本开始:
    
    3
  - onStop
```
public void onStop()
```
    Called when the application is requested to stop playing.
    You can override this callback to handle the request.
    
    从以下版本开始:
    
    3
  - onSetAVPlaybackSpeed
```
public void onSetAVPlaybackSpeed(float speed)
```
    Called when the application is requested to change the playback speed.
    
    参数:
    
    speed - Indicates the target playback speed.
    
    从以下版本开始:
    
    3
  - onSetAVPlaybackCustomAction
```
public void onSetAVPlaybackCustomAction(String action,
                                        PacMap options)
```
    Called when the AVController is about to execute a custom playback action defined in AVPlaybackState.AVPlaybackCustomAction.
    
    参数:
    
    action - Indicates the custom playback action.
    
    options - Indicates additional data for the action.
    
    从以下版本开始:
    
    3

类 AVSessionCallback

构造器概要

方法概要

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

构造器详细资料

AVSessionCallback

方法详细资料

onCommand

onMediaButtonEvent

onPrepareToPlay

onPrepareToPlayByMediaId

onPrepareToPlayBySearch

onPrepareToPlayByUri

onPlay

onPlayBySearch

onPlayByMediaId

onPlayByUri

onSkipToAVQueueElement

onPause

onSeekTo

onPlayNext

onPlayPrevious

onPlayFastForward

onRewind

onStop

onSetAVPlaybackSpeed

onSetAVPlaybackCustomAction