AVPlaybackState

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

所有已实现的接口:

Sequenceable
```
public final class AVPlaybackState
extends Object
implements Sequenceable
```
Manages the playback state of a media session.

从以下版本开始:

3

SystemCapability

SystemCapability.Multimedia#MEDIA

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`AVPlaybackState.AVPlaybackCustomAction`	Extends `AVController` actions, for example, an action for setting loop playback.
`static class`	`AVPlaybackState.Builder`	A static inner class of `AVPlaybackState` to construct instances.

从接口继承的嵌套类/接口 ohos.utils.Sequenceable
Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`static Sequenceable.Producer<AVPlaybackState>`	`CREATOR`	Indicates the `AVPlaybackState` object unmarshalled from a `Parcel`.
`static long`	`PLAYBACK_ACTION_FAST_FORWARD`	Indicates that this media session supports the FAST FORWARD action.
`static long`	`PLAYBACK_ACTION_PAUSE`	Indicates that this media session supports the PAUSE action.
`static long`	`PLAYBACK_ACTION_PLAY`	Indicates that this media session supports the PLAYBACK action.
`static long`	`PLAYBACK_ACTION_PLAY_FROM_MEDIA_ID`	Indicates that this media session supports starting playback from a specified media ID.
`static long`	`PLAYBACK_ACTION_PLAY_FROM_SEARCH`	Indicates that this media session supports starting playback from a specified search result.
`static long`	`PLAYBACK_ACTION_PLAY_FROM_URI`	Indicates that this media session supports starting playback from the media item with a specified URI.
`static long`	`PLAYBACK_ACTION_PLAY_PAUSE`	Indicates that this media session supports a switchover between the PLAY and PAUSE actions.
`static long`	`PLAYBACK_ACTION_PREPARE`	Indicates that this media session supports the PREPARE action.
`static long`	`PLAYBACK_ACTION_PREPARE_FROM_MEDIA_ID`	Indicates that this media session supports preparation for playing a specified media ID.
`static long`	`PLAYBACK_ACTION_PREPARE_FROM_SEARCH`	Indicates that this media session supports preparation for playing a specified search result.
`static long`	`PLAYBACK_ACTION_PREPARE_FROM_URI`	Indicates that this media session supports preparation for playing the media item with a specified URI.
`static long`	`PLAYBACK_ACTION_REWIND`	Indicates that this media session supports the REWIND action.
`static long`	`PLAYBACK_ACTION_SEEK_TO`	Indicates that this media session supports moving to a new position in the media stream.
`static long`	`PLAYBACK_ACTION_SET_RATING`	Indicates that this media session supports the RATING action.
`static long`	`PLAYBACK_ACTION_SKIP_TO_NEXT`	Indicates the next command.
`static long`	`PLAYBACK_ACTION_SKIP_TO_PREVIOUS`	Indicates that this media session supports the PREVIOUS action.
`static long`	`PLAYBACK_ACTION_SKIP_TO_QUEUE_ITEM`	Indicates that this media session supports starting playback from a specified media item in the queue.
`static long`	`PLAYBACK_ACTION_STOP`	Indicates that this media session supports the STOP action.
`static long`	`PLAYBACK_POSITION_ERROR`	Indicates an invalid playback position.
`static int`	`PLAYBACK_STATE_BUFFERING`	Indicates the BUFFERING state.
`static int`	`PLAYBACK_STATE_CONNECTING`	Indicates that the client is connecting to the server.
`static int`	`PLAYBACK_STATE_ERROR`	Indicates the ERROR state.
`static int`	`PLAYBACK_STATE_FAST_FORWARDING`	Indicates the FAST FORWARDING state.
`static int`	`PLAYBACK_STATE_NONE`	Indicates the default playback state.
`static int`	`PLAYBACK_STATE_PAUSED`	Indicates the PAUSED state.
`static int`	`PLAYBACK_STATE_PLAYING`	Indicates the PLAYBACK state.
`static int`	`PLAYBACK_STATE_REWINDING`	Indicates the REWINDING state.
`static int`	`PLAYBACK_STATE_SKIPPING_TO_NEXT`	Indicates the NEXT state.
`static int`	`PLAYBACK_STATE_SKIPPING_TO_PREVIOUS`	Indicates the PREVIOUS state.
`static int`	`PLAYBACK_STATE_SKIPPING_TO_QUEUE_ITEM`	Indicates the state of moving to a specified media item in the queue.
`static int`	`PLAYBACK_STATE_STOPPED`	Indicates the STOPPED state.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`long`	`getActiveQueueElementId()`	Obtains the ID of the active media item in the playback queue.
`long`	`getAVPlaybackActions()`	Obtains the actions supported by this `AVSession` instance.
`List<AVPlaybackState.AVPlaybackCustomAction>`	`getAVPlaybackCustomActions()`	Obtains the custom action list.
`CharSequence`	`getAVPlaybackErrorMessage()`	Obtains the message displayed when an error occurs during playback.
`float`	`getAVPlaybackSpeed()`	Obtains the current playback speed.
`int`	`getAVPlaybackState()`	Obtains the playback state.
`long`	`getCurrentBufferedPosition()`	Obtains the buffer's position.
`long`	`getCurrentPosition()`	Obtains the current playback position.
`long`	`getLastPositionChangedTime()`	Obtains the time elapsed since the last playback position change.
`PacMap`	`getOptions()`	Obtains other optional information about the playback state.
`boolean`	`marshalling(Parcel out)`	Marshalls the `AVPlaybackState` object to a `Parcel`.
`String`	`toString()`	Returns a string representation of the object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshalls the `AVPlaybackState` object from a `Parcel`.

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

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - CREATOR
```
public static Sequenceable.Producer<AVPlaybackState> CREATOR
```
    Indicates the AVPlaybackState object unmarshalled from a Parcel.
    
    从以下版本开始:
    
    3
  - PLAYBACK_ACTION_FAST_FORWARD
```
public static final long PLAYBACK_ACTION_FAST_FORWARD
```
    Indicates that this media session supports the FAST FORWARD action.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PAUSE
```
public static final long PLAYBACK_ACTION_PAUSE
```
    Indicates that this media session supports the PAUSE action.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PLAY
```
public static final long PLAYBACK_ACTION_PLAY
```
    Indicates that this media session supports the PLAYBACK action.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PLAY_FROM_MEDIA_ID
```
public static final long PLAYBACK_ACTION_PLAY_FROM_MEDIA_ID
```
    Indicates that this media session supports starting playback from a specified media ID.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PLAY_FROM_SEARCH
```
public static final long PLAYBACK_ACTION_PLAY_FROM_SEARCH
```
    Indicates that this media session supports starting playback from a specified search result.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PLAY_FROM_URI
```
public static final long PLAYBACK_ACTION_PLAY_FROM_URI
```
    Indicates that this media session supports starting playback from the media item with a specified URI.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PLAY_PAUSE
```
public static final long PLAYBACK_ACTION_PLAY_PAUSE
```
    Indicates that this media session supports a switchover between the PLAY and PAUSE actions.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PREPARE
```
public static final long PLAYBACK_ACTION_PREPARE
```
    Indicates that this media session supports the PREPARE action.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PREPARE_FROM_MEDIA_ID
```
public static final long PLAYBACK_ACTION_PREPARE_FROM_MEDIA_ID
```
    Indicates that this media session supports preparation for playing a specified media ID.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PREPARE_FROM_SEARCH
```
public static final long PLAYBACK_ACTION_PREPARE_FROM_SEARCH
```
    Indicates that this media session supports preparation for playing a specified search result.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_PREPARE_FROM_URI
```
public static final long PLAYBACK_ACTION_PREPARE_FROM_URI
```
    Indicates that this media session supports preparation for playing the media item with a specified URI.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_REWIND
```
public static final long PLAYBACK_ACTION_REWIND
```
    Indicates that this media session supports the REWIND action.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_SEEK_TO
```
public static final long PLAYBACK_ACTION_SEEK_TO
```
    Indicates that this media session supports moving to a new position in the media stream.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_SET_RATING
```
public static final long PLAYBACK_ACTION_SET_RATING
```
    Indicates that this media session supports the RATING action.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_SKIP_TO_NEXT
```
public static final long PLAYBACK_ACTION_SKIP_TO_NEXT
```
    Indicates the next command.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_SKIP_TO_PREVIOUS
```
public static final long PLAYBACK_ACTION_SKIP_TO_PREVIOUS
```
    Indicates that this media session supports the PREVIOUS action.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_SKIP_TO_QUEUE_ITEM
```
public static final long PLAYBACK_ACTION_SKIP_TO_QUEUE_ITEM
```
    Indicates that this media session supports starting playback from a specified media item in the queue.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_ACTION_STOP
```
public static final long PLAYBACK_ACTION_STOP
```
    Indicates that this media session supports the STOP action.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackActions(long), 常量字段值
  - PLAYBACK_POSITION_ERROR
```
public static final long PLAYBACK_POSITION_ERROR
```
    Indicates an invalid playback position.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - PLAYBACK_STATE_BUFFERING
```
public static final int PLAYBACK_STATE_BUFFERING
```
    Indicates the BUFFERING state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_CONNECTING
```
public static final int PLAYBACK_STATE_CONNECTING
```
    Indicates that the client is connecting to the server.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_ERROR
```
public static final int PLAYBACK_STATE_ERROR
```
    Indicates the ERROR state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_FAST_FORWARDING
```
public static final int PLAYBACK_STATE_FAST_FORWARDING
```
    Indicates the FAST FORWARDING state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_NONE
```
public static final int PLAYBACK_STATE_NONE
```
    Indicates the default playback state. The player is in this state after initialization or reset.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_PAUSED
```
public static final int PLAYBACK_STATE_PAUSED
```
    Indicates the PAUSED state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_PLAYING
```
public static final int PLAYBACK_STATE_PLAYING
```
    Indicates the PLAYBACK state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_REWINDING
```
public static final int PLAYBACK_STATE_REWINDING
```
    Indicates the REWINDING state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_SKIPPING_TO_NEXT
```
public static final int PLAYBACK_STATE_SKIPPING_TO_NEXT
```
    Indicates the NEXT state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_SKIPPING_TO_PREVIOUS
```
public static final int PLAYBACK_STATE_SKIPPING_TO_PREVIOUS
```
    Indicates the PREVIOUS state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_SKIPPING_TO_QUEUE_ITEM
```
public static final int PLAYBACK_STATE_SKIPPING_TO_QUEUE_ITEM
```
    Indicates the state of moving to a specified media item in the queue.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
  - PLAYBACK_STATE_STOPPED
```
public static final int PLAYBACK_STATE_STOPPED
```
    Indicates the STOPPED state.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    AVPlaybackState.Builder.setAVPlaybackState(int, long, float, long), 常量字段值
- 方法详细资料
  - toString
```
public String toString()
```
    从类复制的说明: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of the object.
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshalls the AVPlaybackState object to a Parcel.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object for marshalling.
    
    返回:
    
    Returns true if marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshalls the AVPlaybackState object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object for unmarshalling.
    
    返回:
    
    Returns true if unmarshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getAVPlaybackState
```
public int getAVPlaybackState()
```
    Obtains the playback state. Available states are as follows:
    返回:
    
    Returns the playback state.
    
    从以下版本开始:
    
    3
  - getCurrentPosition
```
public long getCurrentPosition()
```
    Obtains the current playback position.
    
    返回:
    
    Returns the playback position (milliseconds).
    
    从以下版本开始:
    
    3
  - getCurrentBufferedPosition
```
public long getCurrentBufferedPosition()
```
    Obtains the buffer's position. The buffer's position indicates the furthest position that the player can reach after playing all the current buffer contents.
    
    返回:
    
    Returns the buffer's position (milliseconds).
    
    从以下版本开始:
    
    3
  - getAVPlaybackSpeed
```
public float getAVPlaybackSpeed()
```
    Obtains the current playback speed.
    
    返回:
    
    Returns the playback speed.
    
    从以下版本开始:
    
    3
  - getAVPlaybackActions
```
public long getAVPlaybackActions()
```
    Obtains the actions supported by this AVSession instance. Available actions are as follows:
    返回:
    
    Returns the actions supported.
    
    从以下版本开始:
    
    3
  - getAVPlaybackCustomActions
```
public List<AVPlaybackState.AVPlaybackCustomAction> getAVPlaybackCustomActions()
```
    Obtains the custom action list.
    
    返回:
    
    Returns the custom action list.
    
    从以下版本开始:
    
    3
  - getAVPlaybackErrorMessage
```
public CharSequence getAVPlaybackErrorMessage()
```
    Obtains the message displayed when an error occurs during playback.
    
    返回:
    
    Returns the error message.
    
    从以下版本开始:
    
    3
  - getLastPositionChangedTime
```
public long getLastPositionChangedTime()
```
    Obtains the time elapsed since the last playback position change.
    
    返回:
    
    Returns the time elapsed.
    
    从以下版本开始:
    
    3
  - getActiveQueueElementId
```
public long getActiveQueueElementId()
```
    Obtains the ID of the active media item in the playback queue.
    
    返回:
    
    Returns the ID of the active media item.
    
    从以下版本开始:
    
    3
  - getOptions
```
public PacMap getOptions()
```
    Obtains other optional information about the playback state.
    
    返回:
    
    Returns other optional information about the playback state; returns null if no optional information is available.
    
    从以下版本开始:
    
    3

类 AVPlaybackState

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

方法概要

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

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

CREATOR

PLAYBACK_ACTION_FAST_FORWARD

PLAYBACK_ACTION_PAUSE

PLAYBACK_ACTION_PLAY

PLAYBACK_ACTION_PLAY_FROM_MEDIA_ID

PLAYBACK_ACTION_PLAY_FROM_SEARCH

PLAYBACK_ACTION_PLAY_FROM_URI

PLAYBACK_ACTION_PLAY_PAUSE

PLAYBACK_ACTION_PREPARE

PLAYBACK_ACTION_PREPARE_FROM_MEDIA_ID

PLAYBACK_ACTION_PREPARE_FROM_SEARCH

PLAYBACK_ACTION_PREPARE_FROM_URI

PLAYBACK_ACTION_REWIND

PLAYBACK_ACTION_SEEK_TO

PLAYBACK_ACTION_SET_RATING

PLAYBACK_ACTION_SKIP_TO_NEXT

PLAYBACK_ACTION_SKIP_TO_PREVIOUS

PLAYBACK_ACTION_SKIP_TO_QUEUE_ITEM

PLAYBACK_ACTION_STOP

PLAYBACK_POSITION_ERROR

PLAYBACK_STATE_BUFFERING

PLAYBACK_STATE_CONNECTING

PLAYBACK_STATE_ERROR

PLAYBACK_STATE_FAST_FORWARDING

PLAYBACK_STATE_NONE

PLAYBACK_STATE_PAUSED

PLAYBACK_STATE_PLAYING

PLAYBACK_STATE_REWINDING

PLAYBACK_STATE_SKIPPING_TO_NEXT

PLAYBACK_STATE_SKIPPING_TO_PREVIOUS

PLAYBACK_STATE_SKIPPING_TO_QUEUE_ITEM

PLAYBACK_STATE_STOPPED

方法详细资料

toString

marshalling

unmarshalling

getAVPlaybackState

getCurrentPosition

getCurrentBufferedPosition

getAVPlaybackSpeed

getAVPlaybackActions

getAVPlaybackCustomActions

getAVPlaybackErrorMessage

getLastPositionChangedTime

getActiveQueueElementId

getOptions