AVSession

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

```
public final class AVSession
extends Object
```
Represents the media session provided for your application to control media playback.

从以下版本开始:

3

SystemCapability

SystemCapability.Multimedia#MEDIA

字段概要

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

static String ACTION_MEDIA_BUTTON

static String PARAM_KEY_EVENT

字段
限定符和类型	字段	说明
`static String`	`ACTION_MEDIA_BUTTON`
`static String`	`PARAM_KEY_EVENT`

构造器概要

构造器
构造器	说明
`AVSession(Context context, String tag)`	A constructor used to create an `AVSession` instance to control media playback.
`AVSession(Context context, String tag, PacMap sessionInfo)`	A constructor used to create an `AVSession` instance with additional session information.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`void`	`enableAVSessionActive(boolean active)`	Sets whether to activate the media session.
`AVController`	`getAVController()`	Obtains the `AVController` instance automatically created when this `AVSession` instance was created.
`AVToken`	`getAVToken()`	Obtains the token for your application to connect to this `AVSession` instance.
`AVCallerUserInfo`	`getCurrentControllerInfo()`	Obtains information about the `AVController` instance sending the current request.
`boolean`	`isAVSessionActive()`	Checks whether this `AVSession` instance is activated.
`void`	`release()`	Releases resources associated with this `AVSession` instance.
`void`	`sendAVSessionEvent(String event, PacMap options)`	Sends a media session event to all `AVController` instances listening for this `AVSession` instance.
`boolean`	`setAVButtonReceiver(IntentAgent ia)`	Sets an `IntentAgent` instance to receive the media button event for restarting the application via a media button.
`void`	`setAVMetadata(AVMetadata avMetadata)`	Sets metadata of a media item.
`void`	`setAVPlaybackState(AVPlaybackState state)`	Sets the current playback state.
`void`	`setAVQueue(List<AVQueueElement> queue)`	Sets a playback queue.
`void`	`setAVQueueTitle(CharSequence queueTitle)`	Sets a title for the playback queue, which will be displayed on a UI page.
`void`	`setAVRatingStyle(int ratingStyle)`	Sets the media rating system used for this `AVSession` instance, which can be one of the following: AVRATING_NONE AVRATING_STYLE_HEART AVRATING_STYLE_THUMB_UP_DOWN AVRATING_STYLE_3_STARS AVRATING_STYLE_4_STARS AVRATING_STYLE_5_STARS AVRATING_STYLE_PERCENTAGE
`boolean`	`setAVSessionAbility(IntentAgent ia)`	Sets an `IntentAgent` instance for this `AVSession` to start a UI page.
`void`	`setAVSessionCallback(AVSessionCallback callback)`	Sets a callback to control the player.
`void`	`setOptions(PacMap options)`	Sets additional information about this `AVSession`.
`void`	`useLocalAudioStreamProperty(AudioStreamProperty properties)`	Sets audio stream properties for this media session.
`void`	`useRemoteVolumeHandler(AVVolumeHandler volumeHandler)`	Sets a specific `AVVolumeHandler` for volume control.

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

- 字段详细资料
  - ACTION_MEDIA_BUTTON
```
public static final String ACTION_MEDIA_BUTTON
```
  - PARAM_KEY_EVENT
```
public static final String PARAM_KEY_EVENT
```
- 构造器详细资料
  - AVSession
```
public AVSession(Context context,
                 String tag)
```
    A constructor used to create an AVSession instance to control media playback.
    
    参数:
    
    context - Indicates the application context.
    
    tag - Indicates a short name (usually the application name) for debugging.
    
    从以下版本开始:
    
    3
  - AVSession
```
public AVSession(Context context,
                 String tag,
                 PacMap sessionInfo)
```
    A constructor used to create an AVSession instance with additional session information.
    
    参数:
    
    context - Indicates the application context.
    
    tag - Indicates a short name (usually the application name) for debugging.
    
    sessionInfo - Indicates additional information about the media session. The information includes the application version and a list of custom commands supported by the session.
    
    从以下版本开始:
    
    3
- 方法详细资料
  - setAVSessionCallback
```
public void setAVSessionCallback(AVSessionCallback callback)
```
    Sets a callback to control the player. You need to define how to implement this callback.
    
    参数:
    
    callback - Indicates the callback to implement for your application. For available callbacks, see AVSessionCallback. If this parameter is null, the control over the player will be ineffective.
    
    从以下版本开始:
    
    3
  - setAVSessionAbility
```
public boolean setAVSessionAbility(IntentAgent ia)
```
    Sets an IntentAgent instance for this AVSession to start a UI page.
    
    参数:
    
    ia - Indicates the IntentAgent instance for starting the UI page.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setAVButtonReceiver
```
public boolean setAVButtonReceiver(IntentAgent ia)
```
    Sets an IntentAgent instance to receive the media button event for restarting the application via a media button.
    
    参数:
    
    ia - Indicates the IntentAgent instance to receive the media button event.
    
    返回:
    
    Returns true if the setting is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - enableAVSessionActive
```
public void enableAVSessionActive(boolean active)
```
    Sets whether to activate the media session. When the session is ready to receive a command, set the input parameter to true. If the session stops receiving a command, set the parameter to false.
    
    参数:
    
    active - Specifies whether the media session will be activated. Value true indicates that the session will be activated, and false indicates that the session will be deactivated.
    
    从以下版本开始:
    
    3
  - isAVSessionActive
```
public boolean isAVSessionActive()
```
    Checks whether this AVSession instance is activated.
    
    返回:
    
    Returns true if the session is activated; returns false otherwise.
    
    从以下版本开始:
    
    3
  - sendAVSessionEvent
```
public void sendAVSessionEvent(String event,
                               PacMap options)
```
    Sends a media session event to all AVController instances listening for this AVSession instance.
    
    参数:
    
    event - Indicates the name of the event to send.
    
    options - Indicates additional information about the event.
    
    从以下版本开始:
    
    3
  - release
```
public void release()
```
    Releases resources associated with this AVSession instance.
    You need to call this method after the application finishes playback.
    
    从以下版本开始:
    
    3
  - getAVToken
```
public AVToken getAVToken()
```
    Obtains the token for your application to connect to this AVSession instance. This token is used to create an AVController instance.
    
    返回:
    
    Returns the token.
    
    从以下版本开始:
    
    3
  - getAVController
```
public AVController getAVController()
```
    Obtains the AVController instance automatically created when this AVSession instance was created.
    
    返回:
    
    Returns the AVController instance.
    
    从以下版本开始:
    
    3
  - setAVPlaybackState
```
public void setAVPlaybackState(AVPlaybackState state)
```
    Sets the current playback state.
    
    参数:
    
    state - Indicates the AVPlaybackState instance representing the current playback state.
    
    从以下版本开始:
    
    3
  - setAVMetadata
```
public void setAVMetadata(AVMetadata avMetadata)
```
    Sets metadata of a media item.
    
    参数:
    
    avMetadata - Indicates the AVMetadata instance to set.
    
    从以下版本开始:
    
    3
  - setAVQueue
```
public void setAVQueue(List<AVQueueElement> queue)
```
    Sets a playback queue.
    
    参数:
    
    queue - Indicates the playback queue.
    
    从以下版本开始:
    
    3
  - setAVQueueTitle
```
public void setAVQueueTitle(CharSequence queueTitle)
```
    Sets a title for the playback queue, which will be displayed on a UI page.
    
    参数:
    
    queueTitle - Indicates the title to set.
    
    从以下版本开始:
    
    3
  - setAVRatingStyle
```
public void setAVRatingStyle(int ratingStyle)
```
    Sets the media rating system used for this AVSession instance, which can be one of the following:
    1. AVRATING_NONE
    2. AVRATING_STYLE_HEART
    3. AVRATING_STYLE_THUMB_UP_DOWN
    4. AVRATING_STYLE_3_STARS
    5. AVRATING_STYLE_4_STARS
    6. AVRATING_STYLE_5_STARS
    7. AVRATING_STYLE_PERCENTAGE
    参数:
    
    ratingStyle - Indicates the media rating system to set.
    
    从以下版本开始:
    
    3
  - setOptions
```
public void setOptions(PacMap options)
```
    Sets additional information about this AVSession.
    
    参数:
    
    options - Indicates additional session information.
    
    从以下版本开始:
    
    3
  - useRemoteVolumeHandler
```
public void useRemoteVolumeHandler(AVVolumeHandler volumeHandler)
                            throws IllegalArgumentException
```
    Sets a specific AVVolumeHandler for volume control.
    After this method is called, the system will not process volume adjustment requests for this media session.
    
    参数:
    
    volumeHandler - Indicates the AVVolumeHandler instance used to handle volume change events.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if volumeHandler is null.
    
    从以下版本开始:
    
    6
    
    另请参阅:
    
    useLocalAudioStreamProperty(AudioStreamProperty)
  - useLocalAudioStreamProperty
```
public void useLocalAudioStreamProperty(AudioStreamProperty properties)
                                 throws IllegalArgumentException
```
    Sets audio stream properties for this media session.
    After this method is called, volume adjustment requests sent to this media session will take effect on the audio streams with the properties you set.
    
    参数:
    
    properties - Indicates the audio stream properties to set.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if properties is null.
    
    从以下版本开始:
    
    6
    
    另请参阅:
    
    useRemoteVolumeHandler(AVVolumeHandler)
  - getCurrentControllerInfo
```
public AVCallerUserInfo getCurrentControllerInfo()
```
    Obtains information about the AVController instance sending the current request.
    
    返回:
    
    Returns the AVCallerUserInfo instance providing information about the AVController.
    
    从以下版本开始:
    
    3

类 AVSession

字段概要

构造器概要

方法概要

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

字段详细资料

ACTION_MEDIA_BUTTON

PARAM_KEY_EVENT

构造器详细资料

AVSession

AVSession

方法详细资料

setAVSessionCallback

setAVSessionAbility

setAVButtonReceiver

enableAVSessionActive

isAVSessionActive

sendAVSessionEvent

release

getAVToken

getAVController

setAVPlaybackState

setAVMetadata

setAVQueue

setAVQueueTitle

setAVRatingStyle

setOptions

useRemoteVolumeHandler

useLocalAudioStreamProperty

getCurrentControllerInfo