From fef2c622e3f23dcec11a7ba23920bbdafba26157 Mon Sep 17 00:00:00 2001 From: zengyawen Date: Mon, 16 Jan 2023 11:32:30 +0800 Subject: [PATCH] update docs Signed-off-by: zengyawen --- .../reference/native-apis/Readme-CN.md | 26 - ...ion_1_1_a_v_playback_state_1_1_position.md | 42 - ...a_v_session_1_1_a_v_controller_callback.md | 136 --- ...1_1_a_v_session_1_1_a_v_control_command.md | 400 -------- ...h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md | 926 ------------------ ..._1_1_a_v_session_1_1_a_v_playback_state.md | 502 ---------- ...o_h_o_s_1_1_a_v_session_1_1_a_v_session.md | 346 ------- ..._1_a_v_session_1_1_a_v_session_callback.md | 215 ---- ...1_1_a_v_session_1_1_a_v_session_manager.md | 300 ------ ...1_a_v_session_1_1_a_v_session_pixel_map.md | 154 --- ..._1_1_a_v_session_1_1_output_device_info.md | 25 - ..._s_1_1_a_v_session_1_1_session_listener.md | 95 -- ...h_o_s_1_1_a_v_session_1_1_session_token.md | 53 - .../reference/native-apis/av__session_8h.md | 24 - .../native-apis/avcontrol__command_8h.md | 24 - .../reference/native-apis/avmeta__data_8h.md | 24 - .../native-apis/avplayback__state_8h.md | 25 - .../reference/native-apis/avsession.md | 469 --------- .../native-apis/avsession__controller_8h.md | 24 - .../native-apis/avsession__descriptor_8h.md | 26 - .../native-apis/avsession__errors_8h.md | 268 ----- .../native-apis/avsession__info_8h.md | 75 -- .../native-apis/avsession__manager_8h.md | 24 - .../native-apis/avsession__pixel__map_8h.md | 44 - ..._a_v_session_1_1_a_v_session_basic_info.md | 37 - ..._a_v_session_1_1_a_v_session_controller.md | 328 ------- ..._a_v_session_1_1_a_v_session_descriptor.md | 41 - 27 files changed, 4653 deletions(-) delete mode 100644 zh-cn/application-dev/reference/native-apis/_1_a_v_session_1_1_a_v_playback_state_1_1_position.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_listener.md delete mode 100644 zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_token.md delete mode 100644 zh-cn/application-dev/reference/native-apis/av__session_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avcontrol__command_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avmeta__data_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avplayback__state_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avsession.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avsession__controller_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avsession__descriptor_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avsession__errors_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avsession__info_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avsession__manager_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/avsession__pixel__map_8h.md delete mode 100644 zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md delete mode 100644 zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md delete mode 100644 zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md diff --git a/zh-cn/application-dev/reference/native-apis/Readme-CN.md b/zh-cn/application-dev/reference/native-apis/Readme-CN.md index 523617f1f2..7aa501d679 100644 --- a/zh-cn/application-dev/reference/native-apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/native-apis/Readme-CN.md @@ -12,7 +12,6 @@ - [Rawfile](rawfile.md) - [MindSpore](_mind_spore.md) - [NeuralNeworkRuntime](_neural_nework_runtime.md) - - [Avsession](avsession.md) - [AudioDecoder](_audio_decoder.md) - [AudioEncoder](_audio_encoder.md) - [CodecBase](_codec_base.md) @@ -52,16 +51,6 @@ - [types.h](types_8h.md) - [neural_network_runtime_type.h](neural__network__runtime__type_8h.md) - [neural_network_runtime.h](neural__network__runtime_8h.md) - - [av_session.h](av__session_8h.md) - - [avcontrol_command.h](avcontrol__command_8h.md) - - [avmeta_data.h](avmeta__data_8h.md) - - [avplayback_state.h](avplayback__state_8h.md) - - [avsession_controller.h](avsession__controller_8h.md) - - [avsession_descriptor.h](avsession__descriptor_8h.md) - - [avsession_errors.h](avsession__errors_8h.md) - - [avsession_info.h](avsession__info_8h.md) - - [avsession_manager.h](avsession__manager_8h.md) - - [avsession_pixel_map.h](avsession__pixel__map_8h.md) - [native_avcodec_audiodecoder.h](native__avcodec__audiodecoder_8h.md) - [native_avcodec_audioencoder.h](native__avcodec__audioencoder_8h.md) - [native_avcodec_base.h](native__avcodec__base_8h.md) @@ -96,21 +85,6 @@ - [OH_NN_UInt32Array](_o_h___n_n___u_int32_array.md) - [OH_AVCodecAsyncCallback](_o_h___a_v_codec_async_callback.md) - [OH_AVCodecBufferAttr](_o_h___a_v_codec_buffer_attr.md) - - [OHOS::AVSession::AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md) - - [OHOS::AVSession::AVControllerCallback](_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md) - - [OHOS::AVSession::AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) - - [OHOS::AVSession::AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) - - [OHOS::AVSession::AVPlaybackState::Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md) - - [OHOS::AVSession::AVSession](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md) - - [OHOS::AVSession::AVSessionBasicInfo](o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md) - - [OHOS::AVSession::AVSessionCallback](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md) - - [OHOS::AVSession::AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md) - - [OHOS::AVSession::AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) - - [OHOS::AVSession::AVSessionManager](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md) - - [OHOS::AVSession::AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md) - - [OHOS::AVSession::OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) - - [OHOS::AVSession::SessionListener](_o_h_o_s_1_1_a_v_session_1_1_session_listener.md) - - [OHOS::AVSession::SessionToken](_o_h_o_s_1_1_a_v_session_1_1_session_token.md) - [OH_Huks_Blob](_o_h___huks___blob.md) - [OH_Huks_CertChain](_o_h___huks___cert_chain.md) - [OH_Huks_KeyInfo](_o_h___huks___key_info.md) diff --git a/zh-cn/application-dev/reference/native-apis/_1_a_v_session_1_1_a_v_playback_state_1_1_position.md b/zh-cn/application-dev/reference/native-apis/_1_a_v_session_1_1_a_v_playback_state_1_1_position.md deleted file mode 100644 index c9c21886df..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_1_a_v_session_1_1_a_v_playback_state_1_1_position.md +++ /dev/null @@ -1,42 +0,0 @@ -# OHOS::AVSession::AVPlaybackState::Position - - -## 概述 - -播放位置的相关信息。 - -**起始版本：** -9 - -## 汇总 - - -### 成员变量 - -| 名称 | 描述 | -| -------- | -------- | -| [elapsedTime_](#elapsedtime) {} | int64_t
媒体已经播放的时间点，第x ms，单位为ms  | -| [updateTime_](#updatetime) {} | int64_t
更新的时间戳，单位为ms  | - - -## 结构体成员变量说明 - - -### elapsedTime_ - - -``` -int64_t OHOS::AVSession::AVPlaybackState::Position::elapsedTime_ {} -``` -**描述:** -媒体已经播放的时间点，第x ms，单位为ms - - -### updateTime_ - - -``` -int64_t OHOS::AVSession::AVPlaybackState::Position::updateTime_ {} -``` -**描述:** -更新的时间戳，单位为ms diff --git a/zh-cn/application-dev/reference/native-apis/_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md b/zh-cn/application-dev/reference/native-apis/_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md deleted file mode 100644 index e22742620f..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md +++ /dev/null @@ -1,136 +0,0 @@ -# OHOS::AVSession::AVControllerCallback - - -## 概述 - -定义控制器相关回调操作的类的实现。 - -**起始版本：** -9 - -## 汇总 - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [OnSessionDestroy](#onsessiondestroy) ()=0 | AVSession会话销毁的抽象的回调方法。  | -| [OnPlaybackStateChange](#onplaybackstatechange) (const [AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) &state)=0 | 音视频的播放状态发生改变的抽象的回调方法。  | -| [OnMetaDataChange](#onmetadatachange) (const [AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) &data)=0 | 会话元数据内容发生变化的抽象的回调方法。  | -| [OnActiveStateChange](#onactivestatechange) (bool isActive)=0 | 当前会话激活状态发生改变的抽象的回调方法。  | -| [OnValidCommandChange](#onvalidcommandchange) (const std::vector< int32_t > &cmds)=0 | 控制命令的有效性发生变化的抽象的回调方法。  | -| [OnOutputDeviceChange](#onoutputdevicechange) (const [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) &outputDeviceInfo)=0 | 注册会话输出设备更改。  | -| [~AVControllerCallback](#avcontrollercallback) ()=default | AVControllerCallback的默认的析构函数。  | - - -## 构造及析构函数说明 - - -### ~AVControllerCallback() - - -``` -virtual OHOS::AVSession::AVControllerCallback::~AVControllerCallback () -``` -**描述:** -AVControllerCallback的默认的析构函数。 - - -## 成员函数说明 - - -### OnActiveStateChange() - - -``` -virtual void OHOS::AVSession::AVControllerCallback::OnActiveStateChange (bool isActive) -``` -**描述:** -当前会话激活状态发生改变的抽象的回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| isActive | 表示是否激活。  | - - -### OnMetaDataChange() - - -``` -virtual void OHOS::AVSession::AVControllerCallback::OnMetaDataChange (const AVMetaData & data) -``` -**描述:** -会话元数据内容发生变化的抽象的回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| data | 会话元数据内容，类型为[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md)。  | - -**参见:** - -[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) - - -### OnOutputDeviceChange() - - -``` -virtual void OHOS::AVSession::AVControllerCallback::OnOutputDeviceChange (const OutputDeviceInfo & outputDeviceInfo) -``` -**描述:** -注册会话输出设备更改。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| outputDeviceInfo | 输出设备信息 [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md)。  | - - -### OnPlaybackStateChange() - - -``` -virtual void OHOS::AVSession::AVControllerCallback::OnPlaybackStateChange (const AVPlaybackState & state) -``` -**描述:** -音视频的播放状态发生改变的抽象的回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| state | 音视频的播放状态的枚举值，类型为[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)。  | - - -### OnSessionDestroy() - - -``` -virtual void OHOS::AVSession::AVControllerCallback::OnSessionDestroy () -``` -**描述:** -AVSession会话销毁的抽象的回调方法。 - - -### OnValidCommandChange() - - -``` -virtual void OHOS::AVSession::AVControllerCallback::OnValidCommandChange (const std::vector< int32_t > & cmds) -``` -**描述:** -控制命令的有效性发生变化的抽象的回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| cmds，媒体有效的指令列表，范围为{ | | - - \ No newline at end of file diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md deleted file mode 100644 index b6af07bf0f..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md +++ /dev/null @@ -1,400 +0,0 @@ -# OHOS::AVSession::AVControlCommand - - -## 概述 - -用于描述音视频播控命令工具类，播控命令的封装对象，支持设置和获取控制命令。 - - -## 汇总 - - -### Public 类型 - - | 名称 | 描述 | -| -------- | -------- | -| {
**SESSION_CMD_INVALID** = -1, **SESSION_CMD_PLAY** = 0, **SESSION_CMD_PAUSE** = 1, **SESSION_CMD_STOP** = 2, **SESSION_CMD_PLAY_NEXT** = 3, **SESSION_CMD_PLAY_PREVIOUS** = 4, **SESSION_CMD_FAST_FORWARD** = 5, **SESSION_CMD_REWIND** = 6, **SESSION_CMD_SEEK** = 7, **SESSION_CMD_SET_SPEED** = 8, **SESSION_CMD_SET_LOOP_MODE** = 9, **SESSION_CMD_TOGGLE_FAVORITE** = 10, **SESSION_CMD_MAX** = 11
} | 操作指令。 | - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [Marshalling](#marshalling) (Parcel &parcel) const override | IPC通信数据序列化。 | - - -### 静态 Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [Unmarshalling](#unmarshalling) (Parcel &data) | IPC通信数据反序列化。 | -| [localCapability](#localcapability) | 命令数组，用于分布式业务，判断是否支持某个命令。 | -| [IsValid](#isvalid) () const | 判断当前指令是否在有效范围内。 | -| [SetCommand](#setcommand) (int32_t cmd) | 设置操作指令。 | -| [GetCommand](#getcommand) () const | 获取操作指令。 | -| [SetSpeed](#setspeed) (double speed) | 设置媒体播放倍数。 | -| [GetSpeed](#getspeed) (double &speed) const | 获取媒体播放倍数 | -| [SetSeekTime](#setseektime) (int64_t time) | 设置媒体跳播时间。 | -| [GetSeekTime](#getseektime) (int64_t &time) const | 获取媒体跳播时间。 | -| [SetLoopMode](#setloopmode) (int32_t mode) | 设置媒体循环模式。 | -| [GetLoopMode](#getloopmode) (int32_t &mode) const | 获取媒体循环模式。 | -| [SetAssetId](#setassetid) (const std::string &assetId) | 设置媒体id。 | -| [GetAssetId](#getassetid) (std::string &assetId) const | 获取媒体id。 | - - -## 成员枚举类型说明 - - -### anonymous enum - - -``` -anonymous enum -``` -**描述:** -操作指令。 - - | 枚举值 | 描述 | -| -------- | -------- | -| SESSION_CMD_INVALID | 无效指令，内部用于判断指令是否有效 | -| SESSION_CMD_PLAY | 播放 | -| SESSION_CMD_PAUSE | 暂停 | -| SESSION_CMD_STOP | 停止 | -| SESSION_CMD_PLAY_NEXT | 播放下一首 | -| SESSION_CMD_PLAY_PREVIOUS | 播放上一首 | -| SESSION_CMD_FAST_FORWARD | 快进 | -| SESSION_CMD_REWIND | 快退 | -| SESSION_CMD_SEEK | 跳播 | -| SESSION_CMD_SET_SPEED | 设置播放倍数 | -| SESSION_CMD_SET_LOOP_MODE | 设置循环模式 | -| SESSION_CMD_TOGGLE_FAVORITE | 收藏 | -| SESSION_CMD_MAX | 无效指令，内部用于判断指令是否有效 | - - -## 成员函数说明 - - -### GetAssetId() - - -``` -int32_t OHOS::AVSession::AVControlCommand::GetAssetId (std::string & assetId) const -``` -**描述:** -获取媒体id。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| assetId | 保存媒体id。 | - -**参见:** - -[SetAssetId](#setassetid) - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### GetCommand() - - -``` -int32_t OHOS::AVSession::AVControlCommand::GetCommand () const -``` -**描述:** -获取操作指令。 - -**返回:** - -返回操作指令，范围在**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**之间。 - -**参见:** - -[SetCommand](#setcommand) - - -### GetLoopMode() - - -``` -int32_t OHOS::AVSession::AVControlCommand::GetLoopMode (int32_t & mode) const -``` -**描述:** -获取媒体循环模式。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| mode | 保存媒体循环模式。 取值在[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)的**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 | - -**参见:** - -[SetLoopMode](#setloopmode) - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### GetSeekTime() - - -``` -int32_t OHOS::AVSession::AVControlCommand::GetSeekTime (int64_t & time) const -``` -**描述:** -获取媒体跳播时间。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| time | 媒体资源的位置，从媒体资源开头开始计算，单位为ms。取值需大于等于0。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[SetSeekTime](#setseektime) - - -### GetSpeed() - - -``` -int32_t OHOS::AVSession::AVControlCommand::GetSpeed (double & speed) const -``` -**描述:** -获取媒体播放倍数 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| speed | 媒体播放倍数，返回值。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[SetSpeed](#setspeed) - - -### IsValid() - - -``` -bool OHOS::AVSession::AVControlCommand::IsValid () const -``` -**描述:** -判断当前指令是否在有效范围内。 - -**返回:** - -如果cmd_在有效范围内，范围在**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**之间， 返回true；否则，返回false。 - - -### Marshalling() - - -``` -bool OHOS::AVSession::AVControlCommand::Marshalling (Parcel & parcel) const -``` -**描述:** -IPC通信数据序列化。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| parcel | 保存序列化值的对象**Parcel**。 | - -**返回:** - -成功返回true；否则，返回false。 - -**参见:** - -[Unmarshalling](#unmarshalling) - - -### SetAssetId() - - -``` -int32_t OHOS::AVSession::AVControlCommand::SetAssetId (const std::string & assetId) -``` -**描述:** -设置媒体id。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| assetId | 媒体id，不可为空。 | - -**参见:** - -[GetAssetId](#getassetid) - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### SetCommand() - - -``` -int32_t OHOS::AVSession::AVControlCommand::SetCommand (int32_t cmd) -``` -**描述:** -设置操作指令。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| cmd | 操作指令，范围在**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**之间。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[GetCommand](#getcommand) - - -### SetLoopMode() - - -``` -int32_t OHOS::AVSession::AVControlCommand::SetLoopMode (int32_t mode) -``` -**描述:** -设置媒体循环模式。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| mode | 媒体循环模式， 取值在[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)的**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 | - -**参见:** - -[GetLoopMode](#getloopmode) - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### SetSeekTime() - - -``` -int32_t OHOS::AVSession::AVControlCommand::SetSeekTime (int64_t time) -``` -**描述:** -设置媒体跳播时间。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| time | 媒体资源的位置，从媒体资源开头开始计算，单位为ms。取值需大于等于0。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[GetSeekTime](#getseektime) - - -### SetSpeed() - - -``` -int32_t OHOS::AVSession::AVControlCommand::SetSpeed (double speed) -``` -**描述:** -设置媒体播放倍数。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| speed | 媒体播放倍数，需大于0。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[GetSpeed](#getspeed) - - -### Unmarshalling() - - -``` -static AVControlCommand* OHOS::AVSession::AVControlCommand::Unmarshalling (Parcel & data) -``` -**描述:** -IPC通信数据反序列化。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| data | 序列化对象**Parcel**。 | - -**返回:** - -返回AVControlCommand的函数指针。 - -**参见:** - -[Marshalling](#marshalling) - - -## 结构体成员变量说明 - - -### localCapability - - -``` -const std::vector OHOS::AVSession::AVControlCommand::localCapability -``` -**Value:** - -``` -{ - SESSION_CMD_PLAY, - SESSION_CMD_PAUSE, - SESSION_CMD_STOP, - SESSION_CMD_PLAY_NEXT, - SESSION_CMD_PLAY_PREVIOUS, - SESSION_CMD_FAST_FORWARD, - SESSION_CMD_REWIND, - SESSION_CMD_SEEK, - SESSION_CMD_SET_SPEED, - SESSION_CMD_SET_LOOP_MODE, - SESSION_CMD_TOGGLE_FAVORITE, - } -``` -**描述:** -命令数组，用于分布式业务，判断是否支持某个命令。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md deleted file mode 100644 index 2300db5d2d..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md +++ /dev/null @@ -1,926 +0,0 @@ -# OHOS::AVSession::AVMetaData - - -## 概述 - -会话元数据类，提供获取metadata进程间传递的序列化和反序列话及数据拷贝的接口方法。 - - -## 汇总 - - -### Public 类型 - - | 名称 | 描述 | -| -------- | -------- | -| {
**META_KEY_ASSET_ID** = 0, **META_KEY_TITLE** = 1, **META_KEY_ARTIST** = 2, **META_KEY_AUTHOR** = 3, **META_KEY_ALBUM** = 4, **META_KEY_WRITER** = 5, **META_KEY_COMPOSER** = 6, **META_KEY_DURATION** = 7, **META_KEY_MEDIA_IMAGE** = 8, **META_KEY_MEDIA_IMAGE_URI** = 9, **META_KEY_PUBLISH_DATE** = 10, **META_KEY_SUBTITLE** = 11, **META_KEY_DESCRIPTION** = 12, **META_KEY_LYRIC** = 13, **META_KEY_PREVIOUS_ASSET_ID** = 14, **META_KEY_NEXT_ASSET_ID** = 15, **META_KEY_MAX** = 16
} | 会话元数据具体枚举项。 | -| [MetaMaskType](#metamasktype) = std::bitset< META_KEY_MAX > | 引入掩码标记需要拷贝的会话元数据。 | - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [AVMetaData](#avmetadata) ()=default | 会话元数据默认构造函数。 | -| [~AVMetaData](#avmetadata) () override | 会话元数据默认析构函数。 | -| [Marshalling](#marshalling) (Parcel &data) const override | 实现会话元数据进程间传递的序列化。 | -| [SetAssetId](#setassetid) (const std::string &assetId) | 设置曲目ID。 | -| [GetAssetId](#getassetid) () const | 获取曲目ID。 | -| [SetTitle](#settitle) (const std::string &title) | 设置标题。 | -| [GetTitle](#gettitle) () const | 获取标题。 | -| [SetArtist](#setartist) (const std::string &artist) | 设置艺术家名称。 | -| [GetArtist](#getartist) () const | 获取艺术家名称。 | -| [SetAuthor](#setauthor) (const std::string &author) | 设置制作人名称。 | -| [GetAuthor](#getauthor) () const | 获取制作人名称。 | -| [SetAlbum](#setalbum) (const std::string &album) | 设置专辑名称。 | -| [GetAlbum](#getalbum) () const | 获取专辑名称。 | -| [SetWriter](#setwriter) (const std::string &writer) | 设置作词名称。 | -| [GetWriter](#getwriter) () const | 获取作词名称。 | -| [SetComposer](#setcomposer) (const std::string &composer) | 设置作曲名称。 | -| [GetComposer](#getcomposer) () const | 获取作曲名称。 | -| [SetDuration](#setduration) (int64_t duration) | 设置媒体时长。 | -| [GetDuration](#getduration) () const | 获取媒体时长。 | -| [SetMediaImage](#setmediaimage) (const std::shared_ptr< [AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md) > &mediaImage) | 设置媒体图片。 | -| [GetMediaImage](#getmediaimage) () const | 获取媒体图片。 | -| [SetMediaImageUri](#setmediaimageuri) (const std::string &mediaImageUri) | 设置媒体图片URI。 | -| [GetMediaImageUri](#getmediaimageuri) () const | 获取媒体图片URI。 | -| [SetPublishDate](#setpublishdate) (double date) | 设置曲目发布日期，时间戳，单位为ms。 | -| [GetPublishDate](#getpublishdate) () const | 获取曲目发布日期，时间戳，单位为ms。 | -| [SetSubTitle](#setsubtitle) (const std::string &subTitle) | 设置子标题。 | -| [GetSubTitle](#getsubtitle) () const | 获取子标题。 | -| [SetDescription](#setdescription) (const std::string &description) | 设置曲目描述。 | -| [GetDescription](#getdescription) () const | 获取曲目描述。 | -| [SetLyric](#setlyric) (const std::string &lyric) | 设置歌词。 | -| [GetLyric](#getlyric) () const | 获取歌词。 | -| [SetPreviousAssetId](#setpreviousassetid) (const std::string &assetId) | 设置上一曲曲目ID。 | -| [GetPreviousAssetId](#getpreviousassetid) () const | 获取上一曲曲目ID。 | -| [SetNextAssetId](#setnextassetid) (const std::string &assetId) | 设置下一曲曲目ID。 | -| [GetNextAssetId](#getnextassetid) () const | 获取下一曲曲目ID。 | -| [Reset](#reset) () | 重置所有会话元数据项。 | -| [GetMetaMask](#getmetamask) () const | 获取掩码。 | -| [CopyToByMask](#copytobymask) ([MetaMaskType](#metamasktype) &mask, AVMetaData &metaOut) const | 根据metadata掩码,将metadata项复制到metaOut。 | -| [CopyFrom](#copyfrom) (const AVMetaData &metaIn) | 根据metaIn元掩码的设置位从metaIn复制metadata项。 | -| [IsValid](#isvalid) () const | 会话元数据有效性判断。 | - - -### 静态 Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [Unmarshalling](#unmarshalling) (Parcel &data) | 实现会话元数据进程间传递的反序列化。 | - - -### 静态 Public 属性 - - | 名称 | 描述 | -| -------- | -------- | -| [DURATION_ALWAYS_PLAY](#duration_always_play) = -1 | 持续时间全局变量宏定义。 | -| [localCapability](#localcapability) | 会话元数据数组，用于分布式业务，设置会话属性。 | - - -## 成员类型定义说明 - - -### MetaMaskType - - -``` -using OHOS::AVSession::AVMetaData::MetaMaskType = std::bitset -``` -**描述:** -引入掩码标记需要拷贝的会话元数据。 - - -## 成员枚举类型说明 - - -### anonymous enum - - -``` -anonymous enum -``` -**描述:** -会话元数据具体枚举项。 - - | 枚举值 | 描述 | -| -------- | -------- | -| META_KEY_ASSET_ID | 曲目ID | -| META_KEY_TITLE | 标题 | -| META_KEY_ARTIST | 艺术家 | -| META_KEY_AUTHOR | 制作人 | -| META_KEY_ALBUM | 专辑 | -| META_KEY_WRITER | 作词 | -| META_KEY_COMPOSER | 作曲 | -| META_KEY_DURATION | 媒体时长 | -| META_KEY_MEDIA_IMAGE | 媒体影像 | -| META_KEY_MEDIA_IMAGE_URI | 媒体影像路径 | -| META_KEY_PUBLISH_DATE | 曲目发布日期 | -| META_KEY_SUBTITLE | 子标题 | -| META_KEY_DESCRIPTION | 曲目描述 | -| META_KEY_LYRIC | 歌词 | -| META_KEY_PREVIOUS_ASSET_ID | 上一曲 | -| META_KEY_NEXT_ASSET_ID | 下一曲 | -| META_KEY_MAX | 无效指令，内部用来判断会话元数据是否有效 | - - -## 构造及析构函数说明 - - -### AVMetaData() - - -``` -OHOS::AVSession::AVMetaData::AVMetaData () -``` -**描述:** -会话元数据默认构造函数。 - - -### ~AVMetaData() - - -``` -OHOS::AVSession::AVMetaData::~AVMetaData () -``` -**描述:** -会话元数据默认析构函数。 - - -## 成员函数说明 - - -### CopyFrom() - - -``` -bool OHOS::AVSession::AVMetaData::CopyFrom (const AVMetaData & metaIn) -``` -**描述:** -根据metaIn元掩码的设置位从metaIn复制metadata项。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| metaIn | 会话元数据将要拷贝的入参。| - - -### CopyToByMask() - - -``` -bool OHOS::AVSession::AVMetaData::CopyToByMask (MetaMaskType & mask, AVMetaData & metaOut ) const -``` -**描述:** -根据metadata掩码,将metadata项复制到metaOut。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| mask | metadata掩码[MetaMaskType](#metamasktype)。 | -| metaOut | metadata已拷贝成功的出参AVMetaData。 | - -**返回:** - -成功返回true；失败则返回false。 - - -### GetAlbum() - - -``` -std::string OHOS::AVSession::AVMetaData::GetAlbum () const -``` -**描述:** -获取专辑名称。 - -**返回:** - -返回专辑名称。 - -**参见:** - -[SetAlbum](#setalbum) - - -### GetArtist() - - -``` -std::string OHOS::AVSession::AVMetaData::GetArtist () const -``` -**描述:** -获取艺术家名称。 - -**返回:** - -返回艺术家名称。 - -**参见:** - -[SetArtist](#setartist) - - -### GetAssetId() - - -``` -std::string OHOS::AVSession::AVMetaData::GetAssetId () const -``` -**描述:** -获取曲目ID。 - -**返回:** - -返回曲目ID。 - -**参见:** - -[SetAssetId](#setassetid) - - -### GetAuthor() - - -``` -std::string OHOS::AVSession::AVMetaData::GetAuthor () const -``` -**描述:** -获取制作人名称。 - -**返回:** - -返回制作人名称。 - -**参见:** - -[SetAuthor](#setauthor) - - -### GetComposer() - - -``` -std::string OHOS::AVSession::AVMetaData::GetComposer () const -``` -**描述:** -获取作曲名称。 - -**返回:** - -返回作曲名称。 - -**参见:** - -[SetComposer](#setcomposer) - - -### GetDescription() - - -``` -std::string OHOS::AVSession::AVMetaData::GetDescription () const -``` -**描述:** -获取曲目描述。 - -**返回:** - -返回曲目描述。 - -**参见:** - -[SetDescription](#setdescription) - - -### GetDuration() - - -``` -int64_t OHOS::AVSession::AVMetaData::GetDuration () const -``` -**描述:** -获取媒体时长。 - -**返回:** - -返回媒体时长，单位为ms。 - -**参见:** - -[SetDuration](#setduration) - - -### GetLyric() - - -``` -std::string OHOS::AVSession::AVMetaData::GetLyric () const -``` -**描述:** -获取歌词。 - -**返回:** - -返回歌词。 - -**参见:** - -[SetLyric](#setlyric) - - -### GetMediaImage() - - -``` -std::shared_ptr OHOS::AVSession::AVMetaData::GetMediaImage () const -``` -**描述:** -获取媒体图片。 - -**返回:** - -返回媒体图片[AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md)。 - -**参见:** - -[SetMediaImage](#setmediaimage) - - -### GetMediaImageUri() - - -``` -std::string OHOS::AVSession::AVMetaData::GetMediaImageUri () const -``` -**描述:** -获取媒体图片URI。 - -**返回:** - -返回媒体图片URI。 - -**参见:** - -[SetMediaImageUri](#setmediaimageuri) - - -### GetMetaMask() - - -``` -MetaMaskType OHOS::AVSession::AVMetaData::GetMetaMask () const -``` -**描述:** -获取掩码。 - -**返回:** - -返回掩码[MetaMaskType](#metamasktype)。 - - -### GetNextAssetId() - - -``` -std::string OHOS::AVSession::AVMetaData::GetNextAssetId () const -``` -**描述:** -获取下一曲曲目ID。 - -**返回:** - -返回下一曲曲目ID。 - -**参见:** - -[SetNextAssetId](#setnextassetid) - - -### GetPreviousAssetId() - - -``` -std::string OHOS::AVSession::AVMetaData::GetPreviousAssetId () const -``` -**描述:** -获取上一曲曲目ID。 - -**返回:** - -返回上一曲曲目ID。 - -**参见:** - -[SetPreviousAssetId](#setpreviousassetid) - - -### GetPublishDate() - - -``` -double OHOS::AVSession::AVMetaData::GetPublishDate () const -``` -**描述:** -获取曲目发布日期，时间戳，单位为ms。 - -**返回:** - -返回曲目发布日期，时间戳，单位为ms。 - -**参见:** - -[SetPublishDate](#setpublishdate) - - -### GetSubTitle() - - -``` -std::string OHOS::AVSession::AVMetaData::GetSubTitle () const -``` -**描述:** -获取子标题。 - -**返回:** - -返回子标题。 - -**参见:** - -[SetSubTitle](#setsubtitle) - - -### GetTitle() - - -``` -std::string OHOS::AVSession::AVMetaData::GetTitle () const -``` -**描述:** -获取标题。 - -**返回:** - -返回标题。 - -**参见:** - -[SetTitle](#settitle) - - -### GetWriter() - - -``` -std::string OHOS::AVSession::AVMetaData::GetWriter () const -``` -**描述:** -获取作词名称。 - -**返回:** - -返回作词名称。 - -**参见:** - -[SetWriter](#setwriter) - - -### IsValid() - - -``` -bool OHOS::AVSession::AVMetaData::IsValid () const -``` -**描述:** -会话元数据有效性判断。 - -**返回:** - -有效返回true；无效则返回false。 - - -### Marshalling() - - -``` -bool OHOS::AVSession::AVMetaData::Marshalling (Parcel & data) const -``` -**描述:** -实现会话元数据进程间传递的序列化。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| data | 保存序列化值的对象**Parcel**。 | - -**返回:** - -如果序列化成功，则返回true；如果操作失败，则返回false。 - -**参见:** - -[Unmarshalling](#unmarshalling) - - -### Reset() - - -``` -void OHOS::AVSession::AVMetaData::Reset () -``` -**描述:** -重置所有会话元数据项。 - - -### SetAlbum() - - -``` -void OHOS::AVSession::AVMetaData::SetAlbum (const std::string & album) -``` -**描述:** -设置专辑名称。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| album | 专辑名称。 | - -**参见:** - -[GetAlbum](#getalbum) - - -### SetArtist() - - -``` -void OHOS::AVSession::AVMetaData::SetArtist (const std::string & artist) -``` -**描述:** -设置艺术家名称。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| artist | 艺术家名称。 | - -**参见:** - -[GetArtist](#getartist) - - -### SetAssetId() - - -``` -void OHOS::AVSession::AVMetaData::SetAssetId (const std::string & assetId) -``` -**描述:** -设置曲目ID。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| assetId | 曲目ID,不可为空。 | - -**参见:** - -[GetAssetId](#getassetid) - - -### SetAuthor() - - -``` -void OHOS::AVSession::AVMetaData::SetAuthor (const std::string & author) -``` -**描述:** -设置制作人名称。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| author | 制作人名称。 | - -**参见:** - -[GetArtist](#getartist) - - -### SetComposer() - - -``` -void OHOS::AVSession::AVMetaData::SetComposer (const std::string & composer) -``` -**描述:** -设置作曲名称。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| composer | 作曲名称。 | - -**参见:** - -[GetComposer](#getcomposer) - - -### SetDescription() - - -``` -void OHOS::AVSession::AVMetaData::SetDescription (const std::string & description) -``` -**描述:** -设置曲目描述。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| description | 曲目描述。 | - -**参见:** - -[GetDescription](#getdescription) - - -### SetDuration() - - -``` -void OHOS::AVSession::AVMetaData::SetDuration (int64_t duration) -``` -**描述:** -设置媒体时长。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| duration | 媒体时长，必须大于等于-1，单位为ms 。 | - -**参见:** - -[GetDuration](#getduration) - - -### SetLyric() - - -``` -void OHOS::AVSession::AVMetaData::SetLyric (const std::string & lyric) -``` -**描述:** -设置歌词。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| lyric | 歌词。 | - -**参见:** - -[GetLyric](#getlyric) - - -### SetMediaImage() - - -``` -void OHOS::AVSession::AVMetaData::SetMediaImage (const std::shared_ptr< AVSessionPixelMap > & mediaImage) -``` -**描述:** -设置媒体图片。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| mediaImage | 媒体图片[AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md)。 | - -**参见:** - -[GetMediaImage](#getmediaimage) - - -### SetMediaImageUri() - - -``` -void OHOS::AVSession::AVMetaData::SetMediaImageUri (const std::string & mediaImageUri) -``` -**描述:** -设置媒体图片URI。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| mediaImageUri | 媒体图片URI。 | - -**参见:** - -[GetMediaImageUri](#getmediaimageuri) - - -### SetNextAssetId() - - -``` -void OHOS::AVSession::AVMetaData::SetNextAssetId (const std::string & assetId) -``` -**描述:** -设置下一曲曲目ID。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| assetId | 下一曲曲目ID。 | - -**参见:** - -[GetNextAssetId](#getnextassetid) - - -### SetPreviousAssetId() - - -``` -void OHOS::AVSession::AVMetaData::SetPreviousAssetId (const std::string & assetId) -``` -**描述:** -设置上一曲曲目ID。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| assetId | 上一曲曲目ID。 | - -**参见:** - -[GetPreviousAssetId](#getpreviousassetid) - - -### SetPublishDate() - - -``` -void OHOS::AVSession::AVMetaData::SetPublishDate (double date) -``` -**描述:** -设置曲目发布日期，时间戳，单位为ms。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| date | 曲目发布日期，时间戳，单位为ms。 | - -**参见:** - -[GetPublishDate](#getpublishdate) - - -### SetSubTitle() - - -``` -void OHOS::AVSession::AVMetaData::SetSubTitle (const std::string & subTitle) -``` -**描述:** -设置子标题。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| subTitle | 子标题。 | - -**参见:** - -[GetSubTitle](#getsubtitle) - - -### SetTitle() - - -``` -void OHOS::AVSession::AVMetaData::SetTitle (const std::string & title) -``` -**描述:** -设置标题。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| title | 标题。 | - -**参见:** - -[GetTitle](#gettitle) - - -### SetWriter() - - -``` -void OHOS::AVSession::AVMetaData::SetWriter (const std::string & writer) -``` -**描述:** -设置作词名称。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| writer | 作词名称。 | - -**参见:** - -[GetWriter](#getwriter) - - -### Unmarshalling() - - -``` -static AVMetaData* OHOS::AVSession::AVMetaData::Unmarshalling (Parcel & data) -``` -**描述:** -实现会话元数据进程间传递的反序列化。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| data | 序列化对象**Parcel**。 | - -**返回:** - -如果反序列化成功，返回AVMetaData类型指针；失败则返回nullptr。 - -**参见:** - -[Marshalling](#marshalling) - - -## 结构体成员变量说明 - - -### DURATION_ALWAYS_PLAY - - -``` -constexpr std::int64_t OHOS::AVSession::AVMetaData::DURATION_ALWAYS_PLAY = -1 -``` -**描述:** -持续时间全局变量宏定义。 - - -### localCapability - - -``` -const std::vector OHOS::AVSession::AVMetaData::localCapability -``` -**Value:** - -``` -{ - META_KEY_ASSET_ID, - META_KEY_TITLE, - META_KEY_ARTIST, - META_KEY_AUTHOR, - META_KEY_ALBUM, - META_KEY_WRITER, - META_KEY_COMPOSER, - META_KEY_DURATION, - META_KEY_MEDIA_IMAGE, - META_KEY_MEDIA_IMAGE_URI, - META_KEY_PUBLISH_DATE, - META_KEY_SUBTITLE, - META_KEY_DESCRIPTION, - META_KEY_LYRIC, - META_KEY_PREVIOUS_ASSET_ID, - META_KEY_NEXT_ASSET_ID, - } -``` -**描述:** -会话元数据数组，用于分布式业务，设置会话属性。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md deleted file mode 100644 index 8183b4b57c..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md +++ /dev/null @@ -1,502 +0,0 @@ -# OHOS::AVSession::AVPlaybackState - - -## 概述 - -音视频播放状态类，提供获取和设置播放界面的信息。 - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md) | struct
播放位置的相关信息。 | - - -### Public 类型 - - | 名称 | 描述 | -| -------- | -------- | -| {
**PLAYBACK_STATE_INITIAL** = 0, **PLAYBACK_STATE_PREPARING** = 1, **PLAYBACK_STATE_PLAYING** = 2, **PLAYBACK_STATE_PAUSED** = 3, **PLAYBACK_STATE_FAST_FORWARD** = 4, **PLAYBACK_STATE_REWIND** = 5, **PLAYBACK_STATE_STOP** = 6, **PLAYBACK_STATE_MAX** = 7
} | 描述播放状态的枚举。 | -| {
**PLAYBACK_KEY_STATE** = 0, **PLAYBACK_KEY_SPEED** = 1, **PLAYBACK_KEY_POSITION** = 2, **PLAYBACK_KEY_BUFFERED_TIME** = 3, **PLAYBACK_KEY_LOOP_MODE** = 4, **PLAYBACK_KEY_IS_FAVORITE** = 5, **PLAYBACK_KEY_MAX** = 6
} | 播放界面信息的枚举。 | -| { **LOOP_MODE_SEQUENCE** = 0, **LOOP_MODE_SINGLE** = 1, **LOOP_MODE_LIST** = 2, **LOOP_MODE_SHUFFLE** = 3 } | 循环模式的枚举。 | -| **PlaybackStateMaskType** = std::bitset< PLAYBACK_KEY_MAX > | | - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [Marshalling](#marshalling) (Parcel &parcel) const override | IPC通信数据序列化。 | -| [IsValid](#isvalid) () const | 验证当前信息的有效性。 | -| [SetState](#setstate) (int32_t state) | 设置音视频的播放状态。 | -| [GetState](#getstate) () const | 获取当前音视频的播放状态。 | -| [SetSpeed](#setspeed) (double speed) | 设置播放倍速。 | -| [GetSpeed](#getspeed) () const | 获取当前播放倍速。 | -| [SetPosition](#setposition) (const [Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md) &position) | 设置播放位置，通过更新时间与经过时间来计算，单位ms。 | -| [GetPosition](#getposition) () const | 获取播放位置。 | -| [SetBufferedTime](#setbufferedtime) (int64_t time) | 设置缓冲时间，单位为ms。 | -| [GetBufferedTime](#getbufferedtime) () const | 获取当前缓冲时间，单位为ms。 | -| [SetLoopMode](#setloopmode) (int32_t mode) | 设置循环模式。 | -| [GetLoopMode](#getloopmode) () const | 获取当前循环模式。 | -| [SetFavorite](#setfavorite) (bool isFavorite) | 设置是否收藏。 | -| [GetFavorite](#getfavorite) () const | 获取是否收藏。 | -| [GetMask](#getmask) () const | 获取掩码。 | - - -### 静态 Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [Unmarshalling](#unmarshalling) (Parcel &parcel) | IPC通信数据反序列化。 | -| [localCapability](#localcapability) | 内联函数指针数组AVPlaybackState，用于分布式业务，设置播放界面信息。 | -| [CopyToByMask](#copytobymask) (PlaybackStateMaskType &mask, AVPlaybackState &out) const | 通过掩码拷贝信息到新的AVPlaybackState对象。 | -| [CopyFrom](#copyfrom) (const AVPlaybackState &in) | 根据当前对象的mask_掩码，将输入的AVPlaybackState类型的信息复制到当前对象。 | - - -## 成员枚举类型说明 - - -### anonymous enum - - -``` -anonymous enum -``` -**描述:** -描述播放状态的枚举。 - - | 枚举值 | 描述 | -| -------- | -------- | -| PLAYBACK_STATE_INITIAL | 初始状态 | -| PLAYBACK_STATE_PREPARING | 缓冲状态 | -| PLAYBACK_STATE_PLAYING | 播放状态 | -| PLAYBACK_STATE_PAUSED | 暂停状态 | -| PLAYBACK_STATE_FAST_FORWARD | 快进状态 | -| PLAYBACK_STATE_REWIND | 快退状态 | -| PLAYBACK_STATE_STOP | 停止状态 | -| PLAYBACK_STATE_MAX | 无效类型，内部用于判断状态是否有效 | - - -### anonymous enum - - -``` -anonymous enum -``` -**描述:** -播放界面信息的枚举。 - - | 枚举值 | 描述 | -| -------- | -------- | -| PLAYBACK_KEY_STATE | 播放状态，包括正在播放、暂停、快进等 | -| PLAYBACK_KEY_SPEED | 播放倍数 | -| PLAYBACK_KEY_POSITION | 播放位置 | -| PLAYBACK_KEY_BUFFERED_TIME | 缓冲时间 | -| PLAYBACK_KEY_LOOP_MODE | 循环模式 | -| PLAYBACK_KEY_IS_FAVORITE | 设置喜欢(收藏) | -| PLAYBACK_KEY_MAX | 无效类型，内部用于判断key是否有效 | - - -### anonymous enum - - -``` -anonymous enum -``` -**描述:** -循环模式的枚举。 - - | 枚举值 | 描述 | -| -------- | -------- | -| LOOP_MODE_SEQUENCE | 顺序播放 | -| LOOP_MODE_SINGLE | 单曲循环 | -| LOOP_MODE_LIST | 列表循环 | -| LOOP_MODE_SHUFFLE | 随机播放 | - - -## 成员函数说明 - - -### CopyFrom() - - -``` -bool OHOS::AVSession::AVPlaybackState::CopyFrom (const AVPlaybackState & in) -``` -**描述:** -根据当前对象的mask_掩码，将输入的AVPlaybackState类型的信息复制到当前对象。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| in | AVPlaybackState类型。 | - -**返回:** - -如果有至少一个播放界面信息被拷贝，返回true；如果一个播放界面信息都没有被拷贝，返回false。 - -**参见:** - -[CopyToByMask](#copytobymask) - -[GetMask](#getmask) - - -### CopyToByMask() - - -``` -bool OHOS::AVSession::AVPlaybackState::CopyToByMask (PlaybackStateMaskType & mask, AVPlaybackState & out ) const -``` -**描述:** -通过掩码拷贝信息到新的AVPlaybackState对象。 - -mask对应位上有值的对象拷贝给out。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| mask | 输入的掩码**}。 out 输出的音视频的播放状态 AVPlaybackState}。 如果有至少一个播放界面信息被拷贝，返回true；如果一个播放界面信息都没有被拷贝，返回false。 CopyFrom 9 1.0 ** | - - -### GetBufferedTime() - - -``` -int64_t OHOS::AVSession::AVPlaybackState::GetBufferedTime () const -``` -**描述:** -获取当前缓冲时间，单位为ms。 - -**返回:** - -返回缓冲时间。 - -**参见:** - -[SetBufferedTime](#setbufferedtime) - - -### GetFavorite() - - -``` -bool OHOS::AVSession::AVPlaybackState::GetFavorite () const -``` -**描述:** -获取是否收藏。 - -**返回:** - -是否收藏，是则返回true，否则返回false。 - -**参见:** - -[SetFavorite](#setfavorite) - - -### GetLoopMode() - - -``` -int32_t OHOS::AVSession::AVPlaybackState::GetLoopMode () const -``` -**描述:** -获取当前循环模式。 - -**返回:** - -返回循环模式，范围**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 - -**参见:** - -[SetLoopMode](#setloopmode) - - -### GetMask() - - -``` -PlaybackStateMaskType OHOS::AVSession::AVPlaybackState::GetMask () const -``` -**描述:** -获取掩码。 - -**返回:** - -返回播放界面信息的掩码**PlaybackStateMaskType**。 - -**参见:** - -[CopyFrom](#copyfrom) - - -### GetPosition() - - -``` -Position OHOS::AVSession::AVPlaybackState::GetPosition () const -``` -**描述:** -获取播放位置。 - -**返回:** - -返回播放位置[Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md)。 - -**参见:** - -[SetPosition](#setposition) - - -### GetSpeed() - - -``` -double OHOS::AVSession::AVPlaybackState::GetSpeed () const -``` -**描述:** -获取当前播放倍速。 - -**返回:** - -返回当前播放倍速。 - -**参见:** - -[SetSpeed](#setspeed) - - -### GetState() - - -``` -int32_t OHOS::AVSession::AVPlaybackState::GetState () const -``` -**描述:** -获取当前音视频的播放状态。 - -**返回:** - -返回当前音视频的播放状态，范围**PLAYBACK_STATE_INITIAL**到**PLAYBACK_STATE_MAX**之间。 - -**参见:** - -[SetState](#setstate) - - -### IsValid() - - -``` -bool OHOS::AVSession::AVPlaybackState::IsValid () const -``` -**描述:** -验证当前信息的有效性。 - -**返回:** - -有效返回true；无效则返回false。 - - -### Marshalling() - - -``` -bool OHOS::AVSession::AVPlaybackState::Marshalling (Parcel & parcel) const -``` -**描述:** -IPC通信数据序列化。 - -将AVPlaybackState类型的信息，序列化为**Parcel**类型的信息，用来进行IPC通信。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| parcel | 保存序列化值的对象**Parcel**。 | - -**返回:** - -成功返回true；失败返回false。 - -**参见:** - -[Unmarshalling](#unmarshalling) - - -### SetBufferedTime() - - -``` -void OHOS::AVSession::AVPlaybackState::SetBufferedTime (int64_t time) -``` -**描述:** -设置缓冲时间，单位为ms。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| time | 缓冲时间。 | - -**参见:** - -[GetBufferedTime](#getbufferedtime) - - -### SetFavorite() - - -``` -void OHOS::AVSession::AVPlaybackState::SetFavorite (bool isFavorite) -``` -**描述:** -设置是否收藏。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| isFavorite | 是否收藏，是则为true，否则false。 | - -**参见:** - -[GetFavorite](#getfavorite) - - -### SetLoopMode() - - -``` -void OHOS::AVSession::AVPlaybackState::SetLoopMode (int32_t mode) -``` -**描述:** -设置循环模式。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| mode | 循环模式，范围**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 | - -**参见:** - -[GetLoopMode](#getloopmode) - - -### SetPosition() - - -``` -void OHOS::AVSession::AVPlaybackState::SetPosition (const Position & position) -``` -**描述:** -设置播放位置，通过更新时间与经过时间来计算，单位ms。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| position | 播放位置[Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md)。 | - -**参见:** - -[GetPosition](#getposition) - - -### SetSpeed() - - -``` -void OHOS::AVSession::AVPlaybackState::SetSpeed (double speed) -``` -**描述:** -设置播放倍速。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| speed | 播放倍速。 | - -**参见:** - -[SetSpeed](#setspeed) - - -### SetState() - - -``` -void OHOS::AVSession::AVPlaybackState::SetState (int32_t state) -``` -**描述:** -设置音视频的播放状态。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| state | 音视频的播放状态，范围**PLAYBACK_STATE_INITIAL**到**PLAYBACK_STATE_MAX**之间。 | - -**参见:** - -[GetState](#getstate) - - -### Unmarshalling() - - -``` -static AVPlaybackState* OHOS::AVSession::AVPlaybackState::Unmarshalling (Parcel & parcel) -``` -**描述:** -IPC通信数据反序列化。 - -将通过IPC接收的**Parcel**类型的信息，反序列化为AVPlaybackState类型的信息。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| parcel | 序列化对象**Parcel**。 | - -**返回:** - -如果反序列化成功，则返回AVPlaybackState对象; 如果反序列化失败，则返回nullptr。 - -**参见:** - -[Marshalling](#marshalling) - - -## 结构体成员变量说明 - - -### localCapability - - -``` -const std::vector OHOS::AVSession::AVPlaybackState::localCapability -``` -**Value:** - -``` -{ - PLAYBACK_KEY_STATE, - PLAYBACK_KEY_SPEED, - PLAYBACK_KEY_POSITION, - PLAYBACK_KEY_BUFFERED_TIME, - PLAYBACK_KEY_LOOP_MODE, - PLAYBACK_KEY_IS_FAVORITE, - } -``` -**描述:** -内联函数指针数组AVPlaybackState，用于分布式业务，设置播放界面信息。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md deleted file mode 100644 index 342eada497..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md +++ /dev/null @@ -1,346 +0,0 @@ -# OHOS::AVSession::AVSession - - -## 概述 - -会话对象，支持配置会话属性，并可主动更新播放状态和会话元数据。 - - -## 汇总 - - -### Public 类型 - - | 名称 | 描述 | -| -------- | -------- | -| { **SESSION_TYPE_INVALID** = -1, **SESSION_TYPE_AUDIO** = 0, **SESSION_TYPE_VIDEO** = 1 } | 会话类型的枚举。 | - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [GetSessionId](#getsessionid) ()=0 | 获取会话的标识。 | -| [GetAVMetaData](#getavmetadata) ([AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) &meta)=0 | 获取会话元数据。 | -| [SetAVMetaData](#setavmetadata) (const [AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) &meta)=0 | 设置会话元数据。 | -| [GetAVPlaybackState](#getavplaybackstate) ([AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) &state)=0 | 获取音视频的播放状态。 | -| [SetAVPlaybackState](#setavplaybackstate) (const [AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) &state)=0 | 设置音视频的播放状态。 | -| [SetLaunchAbility](#setlaunchability) (const AbilityRuntime::WantAgent::WantAgent &ability)=0 | 设置一个WantAgent用于启动会话的Ability。 | -| [GetController](#getcontroller) ()=0 | 获取会话控制器。 | -| [RegisterCallback](#registercallback) (const std::shared_ptr< [AVSessionCallback](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md) > &callback)=0 | 注册会话回调。 | -| [Activate](#activate) ()=0 | 激活会话。 | -| [Deactivate](#deactivate) ()=0 | 去激活会话。 | -| [IsActive](#isactive) ()=0 | 获取会话是否被激活。 | -| [Destroy](#destroy) ()=0 | 销毁会话。 | -| [AddSupportCommand](#addsupportcommand) (const int32_t cmd)=0 | 添加支持的控制命令。 | -| [DeleteSupportCommand](#deletesupportcommand) (const int32_t cmd)=0 | 删除支持的控制命令。 | - - -## 成员枚举类型说明 - - -### anonymous enum - - -``` -anonymous enum -``` -**描述:** -会话类型的枚举。 - - | 枚举值 | 描述 | -| -------- | -------- | -| SESSION_TYPE_INVALID | 无效会话 | -| SESSION_TYPE_AUDIO | 音频会话 | -| SESSION_TYPE_VIDEO | 视频会话 | - - -## 成员函数说明 - - -### Activate() - - -``` -virtual int32_t OHOS::AVSession::AVSession::Activate () -``` -**描述:** -激活会话。 - -激活成功后，会话才可以接收控制指令。 - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[Deactivate](#deactivate) - -[IsActive](#isactive) - - -### AddSupportCommand() - - -``` -virtual int32_t OHOS::AVSession::AVSession::AddSupportCommand (const int32_t cmd) -``` -**描述:** -添加支持的控制命令。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| cmd | 待添加的控制命令，范围为**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### Deactivate() - - -``` -virtual int32_t OHOS::AVSession::AVSession::Deactivate () -``` -**描述:** -去激活会话。 - -去激活成功后，表示会话还不能接收控制指令。 - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[Activate](#activate) - -[IsActive](#isactive) - - -### DeleteSupportCommand() - - -``` -virtual int32_t OHOS::AVSession::AVSession::DeleteSupportCommand (const int32_t cmd) -``` -**描述:** -删除支持的控制命令。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| cmd | 待删除的控制命令，范围为**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### Destroy() - - -``` -virtual int32_t OHOS::AVSession::AVSession::Destroy () -``` -**描述:** -销毁会话。 - -如果应用要创建一个新会话，必须要销毁之前的会话，否则会创建失败。 - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### GetAVMetaData() - - -``` -virtual int32_t OHOS::AVSession::AVSession::GetAVMetaData (AVMetaData & meta) -``` -**描述:** -获取会话元数据。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| meta | 用于保存会话的元数据[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md)对象。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[SetAVMetaData](#setavmetadata) - - -### GetAVPlaybackState() - - -``` -virtual int32_t OHOS::AVSession::AVSession::GetAVPlaybackState (AVPlaybackState & state) -``` -**描述:** -获取音视频的播放状态。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| state | 用于保存播放状态的[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)对象。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[SetAVPlaybackState](#setavplaybackstate) - - -### GetController() - - -``` -virtual std::shared_ptr OHOS::AVSession::AVSession::GetController () -``` -**描述:** -获取会话控制器。 - -**返回:** - -返回会话控制器，[AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md)类型智能指针。 - - -### GetSessionId() - - -``` -virtual std::string OHOS::AVSession::AVSession::GetSessionId () -``` -**描述:** -获取会话的标识。 - -**返回:** - -返回会话的标识。 - - -### IsActive() - - -``` -virtual bool OHOS::AVSession::AVSession::IsActive () -``` -**描述:** -获取会话是否被激活。 - -**返回:** - -如果是激活状态，则返回true；否则返回false。 - -**参见:** - -[Activate](#activate) - -[Deactivate](#deactivate) - - -### RegisterCallback() - - -``` -virtual int32_t OHOS::AVSession::AVSession::RegisterCallback (const std::shared_ptr< AVSessionCallback > & callback) -``` -**描述:** -注册会话回调。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| callback | 用于注册会话回调的[AVSessionCallback](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md)对象。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### SetAVMetaData() - - -``` -virtual int32_t OHOS::AVSession::AVSession::SetAVMetaData (const AVMetaData & meta) -``` -**描述:** -设置会话元数据。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| meta | 用于修改会话的元数据[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md)对象。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[GetAVMetaData](#getavmetadata) - - -### SetAVPlaybackState() - - -``` -virtual int32_t OHOS::AVSession::AVSession::SetAVPlaybackState (const AVPlaybackState & state) -``` -**描述:** -设置音视频的播放状态。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| state | 用于修改播放状态的[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)对象。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[GetAVPlaybackState](#getavplaybackstate) - - -### SetLaunchAbility() - - -``` -virtual int32_t OHOS::AVSession::AVSession::SetLaunchAbility (const AbilityRuntime::WantAgent::WantAgent & ability) -``` -**描述:** -设置一个WantAgent用于启动会话的Ability。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| ability | 具体的应用对应的能力，类型为**AbilityRuntime::WantAgent::WantAgent**。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[AVSessionController::GetLaunchAbility](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md#getlaunchability) diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md deleted file mode 100644 index f29d9b05cc..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md +++ /dev/null @@ -1,215 +0,0 @@ -# OHOS::AVSession::AVSessionCallback - - -## 概述 - -定义AVSession回调类的实现 - -**起始版本：** -9 - -## 汇总 - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [OnPlay](#onplay) ()=0 | AVSession多媒体播放的抽象的回调方法。 | -| [OnPause](#onpause) ()=0 | AVSession多媒体播放暂停的抽象的回调方法。 | -| [OnStop](#onstop) ()=0 | AVSession多媒体播放停止的抽象的回调方法。 | -| [OnPlayNext](#onplaynext) ()=0 | AVSession播放下一首多媒体的抽象的回调方法。 | -| [OnPlayPrevious](#onplayprevious) ()=0 | AVSession播放上一首多媒体的抽象的回调方法。 | -| [OnFastForward](#onfastforward) ()=0 | AVSession快进播放多媒体的抽象的回调方法。 | -| [OnRewind](#onrewind) ()=0 | AVSession多媒体快退的抽象的回调方法。 | -| [OnSeek](#onseek) (int64_t time)=0 | AVSession多媒体跳播操作的抽象的回调方法。 | -| [OnSetSpeed](#onsetspeed) (double speed)=0 | AVSession设置多媒体倍速播放操作的抽象的回调方法。 | -| [OnSetLoopMode](#onsetloopmode) (int32_t loopMode)=0 | AVSession设置多媒体循环播放模式的抽象的回调方法。 | -| [OnToggleFavorite](#ontogglefavorite) (const std::string &mediald)=0 | AVSession设置多媒体切换收藏操作的抽象的回调方法。 | -| [OnMediaKeyEvent](#onmediakeyevent) (const MMI::KeyEvent &keyEvent)=0 | AVSession多媒体按键事件处理的抽象的回调方法。 | -| [OnOutputDeviceChange](#onoutputdevicechange) (const [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) &outputDeviceInfo)=0 | 注册会话输出设备变更监听。 | -| [~AVSessionCallback](#avsessioncallback) ()=default | AVSessionCallback的默认的析构函数。 | - - -## 构造及析构函数说明 - - -### ~AVSessionCallback() - - -``` -virtual OHOS::AVSession::AVSessionCallback::~AVSessionCallback () -``` -**描述:** -AVSessionCallback的默认的析构函数。 - - -## 成员函数说明 - - -### OnFastForward() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnFastForward () -``` -**描述:** -AVSession快进播放多媒体的抽象的回调方法。 - - -### OnMediaKeyEvent() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnMediaKeyEvent (const MMI::KeyEvent & keyEvent) -``` -**描述:** -AVSession多媒体按键事件处理的抽象的回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| keyEvent | 按键事件码，类型为**MMI::KeyEvent**。 | - - -### OnOutputDeviceChange() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnOutputDeviceChange (const OutputDeviceInfo & outputDeviceInfo) -``` -**描述:** -注册会话输出设备变更监听。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| outputDeviceInfo | 输出设备信息 [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md)。 | - - -### OnPause() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnPause () -``` -**描述:** -AVSession多媒体播放暂停的抽象的回调方法。 - - -### OnPlay() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnPlay () -``` -**描述:** -AVSession多媒体播放的抽象的回调方法。 - - -### OnPlayNext() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnPlayNext () -``` -**描述:** -AVSession播放下一首多媒体的抽象的回调方法。 - - -### OnPlayPrevious() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnPlayPrevious () -``` -**描述:** -AVSession播放上一首多媒体的抽象的回调方法。 - - -### OnRewind() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnRewind () -``` -**描述:** -AVSession多媒体快退的抽象的回调方法。 - - -### OnSeek() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnSeek (int64_t time) -``` -**描述:** -AVSession多媒体跳播操作的抽象的回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| time | 媒体资源的位置，从媒体资源开头开始计算，单位为ms。取值需大于等于0。 | - - -### OnSetLoopMode() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnSetLoopMode (int32_t loopMode) -``` -**描述:** -AVSession设置多媒体循环播放模式的抽象的回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| loopMode | 多媒体循环播放模式， 范围在[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)的**LOOP_MODE_SEQUENCE**到**LOOP_MODE_SHUFFLE**之间。 | - - -### OnSetSpeed() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnSetSpeed (double speed) -``` -**描述:** -AVSession设置多媒体倍速播放操作的抽象的回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| speed | 多媒体播放的倍速值。 | - - -### OnStop() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnStop () -``` -**描述:** -AVSession多媒体播放停止的抽象的回调方法。 - - -### OnToggleFavorite() - - -``` -virtual void OHOS::AVSession::AVSessionCallback::OnToggleFavorite (const std::string & mediald) -``` -**描述:** -AVSession设置多媒体切换收藏操作的抽象的回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| mediald | 多媒体ID号标识。 | - - diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md deleted file mode 100644 index 1b6f5216da..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md +++ /dev/null @@ -1,300 +0,0 @@ -# OHOS::AVSession::AVSessionManager - - -## 概述 - -实现会话管理器对外接口功能的类的实现。 - -**起始版本：** -9 - -## 汇总 - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [CreateSession](#createsession) (const std::string &tag, int32_t type, const AppExecFwk::ElementName &elementName)=0 | 创建AVSession会话的接口方法。 | -| [GetAllSessionDescriptors](#getallsessiondescriptors) (std::vector< [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) > &descriptors)=0 | 获取AVSession全部的会话描述的接口方法。 | -| [GetActivatedSessionDescriptors](#getactivatedsessiondescriptors) (std::vector< [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) > &activatedSessions)=0 | 获取AVSession全部处于活动状态的会话描述的接口方法。 | -| [GetSessionDescriptorsBySessionId](#getsessiondescriptorsbysessionid) (const std::string &sessionId, [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) &descriptor)=0 | 通过会话ID获得会话描述的方法。 | -| [CreateController](#createcontroller) (const std::string &sessionId, std::shared_ptr< [AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md) > &controller)=0 | 创建AVSession会话控制器的接口方法。 | -| [RegisterSessionListener](#registersessionlistener) (const std::shared_ptr< [SessionListener](_o_h_o_s_1_1_a_v_session_1_1_session_listener.md) > &listener)=0 | 注册AVSession会话监听器的接口方法。 | -| [RegisterServiceDeathCallback](#registerservicedeathcallback) (const [DeathCallback](avsession__info_8h.md#deathcallback) &callback)=0 | 注册AVSession服务器的死亡回调的接口方法。 | -| [UnregisterServiceDeathCallback](#unregisterservicedeathcallback) ()=0 | 注销AVSession服务器的死亡回调的接口方法。 | -| [SendSystemAVKeyEvent](#sendsystemavkeyevent) (const MMI::KeyEvent &keyEvent)=0 | 发送系统按键事件的接口方法。 | -| [SendSystemControlCommand](#sendsystemcontrolcommand) (const [AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md) &command)=0 | 发送系统控制命令的接口方法。 | -| [CastAudio](#castaudio) (const [SessionToken](_o_h_o_s_1_1_a_v_session_1_1_session_token.md) &token, const std::vector< AudioStandard::AudioDeviceDescriptor > &descriptors)=0 | 将媒体会话投射到远程设备或投射回本地设备。 | -| [CastAudioForAll](#castaudioforall) (const std::vector< AudioStandard::AudioDeviceDescriptor > &descriptors)=0 | 将此设备的所有媒体会话投播到远程设备。 | - - -### 静态 Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [GetInstance](#getinstance) () | 获取会话管理器实例。 | - - -## 成员函数说明 - - -### CastAudio() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::CastAudio (const SessionToken & token, const std::vector< AudioStandard::AudioDeviceDescriptor > & descriptors ) -``` -**描述:** -将媒体会话投射到远程设备或投射回本地设备。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| token | 需要投播的会话令牌。 | -| descriptors | 指定要转换的音频设备。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### CastAudioForAll() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::CastAudioForAll (const std::vector< AudioStandard::AudioDeviceDescriptor > & descriptors) -``` -**描述:** -将此设备的所有媒体会话投播到远程设备。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| descriptors | 指定要转换的音频设备。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### CreateController() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::CreateController (const std::string & sessionId, std::shared_ptr< AVSessionController > & controller ) -``` -**描述:** -创建AVSession会话控制器的接口方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| sessionId | AVSession的会话ID。 | -| controller | 会话控制器实例，类型为[AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md)。 | - -**返回:** - -返回成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### CreateSession() - - -``` -virtual std::shared_ptr OHOS::AVSession::AVSessionManager::CreateSession (const std::string & tag, int32_t type, const AppExecFwk::ElementName & elementName ) -``` -**描述:** -创建AVSession会话的接口方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| tag | AVSession的会话标签，不可为空。 | -| type | AVSession的会话类型, 入参为[AVSession](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md)的**SESSION_TYPE_AUDIO**，**SESSION_TYPE_VIDEO**。 | -| elementName | AVSession的会话名称**AppExecFwk::ElementName**。 | - -**返回:** - -返回已创建的会话对象的智能指针。 - - -### GetActivatedSessionDescriptors() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::GetActivatedSessionDescriptors (std::vector< AVSessionDescriptor > & activatedSessions) -``` -**描述:** -获取AVSession全部处于活动状态的会话描述的接口方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| activatedSessions | 处于活动状态的会话描述，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### GetAllSessionDescriptors() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::GetAllSessionDescriptors (std::vector< AVSessionDescriptor > & descriptors) -``` -**描述:** -获取AVSession全部的会话描述的接口方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| descriptors | AVSession的会话描述，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### GetInstance() - - -``` -static AVSessionManager& OHOS::AVSession::AVSessionManager::GetInstance () -``` -**描述:** -获取会话管理器实例。 - -**返回:** - -返回会话管理器实例。 - - -### GetSessionDescriptorsBySessionId() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::GetSessionDescriptorsBySessionId (const std::string & sessionId, AVSessionDescriptor & descriptor ) -``` -**描述:** -通过会话ID获得会话描述的方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| sessionId | AVSession的会话标签。 | -| descriptor | AVSession的会话描述，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### RegisterServiceDeathCallback() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::RegisterServiceDeathCallback (const DeathCallback & callback) -``` -**描述:** -注册AVSession服务器的死亡回调的接口方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| callback | 死亡回调的方法，类型为**DeathCallback**。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[UnregisterServiceDeathCallback](#unregisterservicedeathcallback) - - -### RegisterSessionListener() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::RegisterSessionListener (const std::shared_ptr< SessionListener > & listener) -``` -**描述:** -注册AVSession会话监听器的接口方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| listener | 会话监听器的智能指针，类型为[SessionListener](_o_h_o_s_1_1_a_v_session_1_1_session_listener.md)。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### SendSystemAVKeyEvent() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::SendSystemAVKeyEvent (const MMI::KeyEvent & keyEvent) -``` -**描述:** -发送系统按键事件的接口方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| keyEvent | 按键事件码，类型为**MMI::KeyEvent**。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### SendSystemControlCommand() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::SendSystemControlCommand (const AVControlCommand & command) -``` -**描述:** -发送系统控制命令的接口方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| command | 系统控制命令[AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md)。 | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### UnregisterServiceDeathCallback() - - -``` -virtual int32_t OHOS::AVSession::AVSessionManager::UnregisterServiceDeathCallback () -``` -**描述:** -注销AVSession服务器的死亡回调的接口方法。 - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[RegisterServiceDeathCallback](#registerservicedeathcallback) diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md deleted file mode 100644 index 39038f5b3f..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md +++ /dev/null @@ -1,154 +0,0 @@ -# OHOS::AVSession::AVSessionPixelMap - - -## 概述 - -读取、设置图片及图片信息。 - - -## 汇总 - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [Marshalling](#marshalling) (Parcel &data) const override | 实现图片及图片信息的序列化。  | -| [GetPixelData](#getpixeldata) () const | 获取图片数据。  | -| [SetPixelData](#setpixeldata) (const std::vector< uint8_t > &data) | 设置图片数据。  | -| [GetImageInfo](#getimageinfo) () const | 获取图片信息。  | -| [SetImageInfo](#setimageinfo) (const std::vector< uint8_t > &imageInfo) | 设置图片信息。  | - - -### 静态 Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [Unmarshalling](#unmarshalling) (Parcel &data) | 实现图片及图片信息的反序列化。  | - - -## 成员函数说明 - - -### GetImageInfo() - - -``` -std::vector OHOS::AVSession::AVSessionPixelMap::GetImageInfo () const -``` -**描述:** -获取图片信息。 - -**返回:** - -返回图片信息。 - -**参见:** - -[SetImageInfo](#setimageinfo) - - -### GetPixelData() - - -``` -std::vector OHOS::AVSession::AVSessionPixelMap::GetPixelData () const -``` -**描述:** -获取图片数据。 - -**返回:** - -返回图片数据。 - -**参见:** - -[SetPixelData](#setpixeldata) - - -### Marshalling() - - -``` -bool OHOS::AVSession::AVSessionPixelMap::Marshalling (Parcel & data) const -``` -**描述:** -实现图片及图片信息的序列化。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| data | 保存序列化值的对象**Parcel**。  | - -**返回:** - -如果序列化成功，则返回true；失败则返回false。 - -**参见:** - -[Unmarshalling](#unmarshalling) - - -### SetImageInfo() - - -``` -void OHOS::AVSession::AVSessionPixelMap::SetImageInfo (const std::vector< uint8_t > & imageInfo) -``` -**描述:** -设置图片信息。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| imageInfo | 图片信息。  | - -**参见:** - -[GetImageInfo](#getimageinfo) - - -### SetPixelData() - - -``` -void OHOS::AVSession::AVSessionPixelMap::SetPixelData (const std::vector< uint8_t > & data) -``` -**描述:** -设置图片数据。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| data | 图片数据。  | - -**参见:** - -[GetPixelData](#getpixeldata) - - -### Unmarshalling() - - -``` -static AVSessionPixelMap* OHOS::AVSession::AVSessionPixelMap::Unmarshalling (Parcel & data) -``` -**描述:** -实现图片及图片信息的反序列化。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| data | 保存反序列化值的对象**Parcel**。  | - -**返回:** - -如果反序列化成功，则返回true；失败则返回false。 - -**参见:** - -[Marshalling](#marshalling) diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md deleted file mode 100644 index f1aa54fa9b..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md +++ /dev/null @@ -1,25 +0,0 @@ -# OHOS::AVSession::OutputDeviceInfo - - -## 概述 - -描述分布式设备的相关信息。 - -**起始版本：** -9 - -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 成员变量 - - | 名称 | 描述 | -| -------- | -------- | -| [isRemote_](avsession.md#isremote) {} | bool | -| [deviceIds_](avsession.md#deviceids) | std::vector< std::string > | -| [deviceNames_](avsession.md#devicenames) | std::vector< std::string > | diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_listener.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_listener.md deleted file mode 100644 index f4d8988dc3..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_listener.md +++ /dev/null @@ -1,95 +0,0 @@ -# OHOS::AVSession::SessionListener - - -## 概述 - -定义与AVSession相关监听器的类的实现。 - -**起始版本：** -9 - -## 汇总 - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [OnSessionCreate](#onsessioncreate) (const [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) &descriptor)=0 | 创建AVSession会话的抽象的接口回调方法。  | -| [OnSessionRelease](#onsessionrelease) (const [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) &descriptor)=0 | 释放AVSession会话的抽象的接口回调方法。  | -| [OnTopSessionChange](#ontopsessionchange) (const [AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) &descriptor)=0 | AVSession的TOP会话发生变化的抽象的接口回调方法。  | -| [~SessionListener](#sessionlistener) ()=default | SessionListener的默认的析构函数。  | - - -## 构造及析构函数说明 - - -### ~SessionListener() - - -``` -virtual OHOS::AVSession::SessionListener::~SessionListener () -``` -**描述:** -SessionListener的默认的析构函数。 - - -## 成员函数说明 - - -### OnSessionCreate() - - -``` -virtual void OHOS::AVSession::SessionListener::OnSessionCreate (const AVSessionDescriptor & descriptor) -``` -**描述:** -创建AVSession会话的抽象的接口回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| descriptor | AVSession的会话描述对象，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。  | - -**参见:** - -[OnSessionRelease](#onsessionrelease) - - -### OnSessionRelease() - - -``` -virtual void OHOS::AVSession::SessionListener::OnSessionRelease (const AVSessionDescriptor & descriptor) -``` -**描述:** -释放AVSession会话的抽象的接口回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| descriptor | AVSession的会话描述对象，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。  | - -**参见:** - -[OnSessionCreate](#onsessioncreate) - - -### OnTopSessionChange() - - -``` -virtual void OHOS::AVSession::SessionListener::OnTopSessionChange (const AVSessionDescriptor & descriptor) -``` -**描述:** -AVSession的TOP会话发生变化的抽象的接口回调方法。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| descriptor | AVSession的会话描述对象，类型为[AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md)。  | - - \ No newline at end of file diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_token.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_token.md deleted file mode 100644 index 66fe6a463a..0000000000 --- a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_a_v_session_1_1_session_token.md +++ /dev/null @@ -1,53 +0,0 @@ -# OHOS::AVSession::SessionToken - - -## 概述 - -会话令牌的信息。 - -**起始版本：** -9 - -## 汇总 - - -### 成员变量 - - | 名称 | 描述 | -| -------- | -------- | -| [sessionId](#sessionid) | std::string
会话id  | -| [pid](#pid) | pid_t
会话的进程id  | -| [uid](#uid) | uid_t
用户id  | - - -## 结构体成员变量说明 - - -### pid - - -``` -pid_t OHOS::AVSession::SessionToken::pid -``` -**描述:** -会话的进程id - - -### sessionId - - -``` -std::string OHOS::AVSession::SessionToken::sessionId -``` -**描述:** -会话id - - -### uid - - -``` -uid_t OHOS::AVSession::SessionToken::uid -``` -**描述:** -用户id diff --git a/zh-cn/application-dev/reference/native-apis/av__session_8h.md b/zh-cn/application-dev/reference/native-apis/av__session_8h.md deleted file mode 100644 index d66bfd2434..0000000000 --- a/zh-cn/application-dev/reference/native-apis/av__session_8h.md +++ /dev/null @@ -1,24 +0,0 @@ -# av_session.h - - -## 概述 - -会话的设置、获取等声明。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::AVSession](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md) | class
会话对象，支持配置会话属性，并可主动更新播放状态和会话元数据。 | diff --git a/zh-cn/application-dev/reference/native-apis/avcontrol__command_8h.md b/zh-cn/application-dev/reference/native-apis/avcontrol__command_8h.md deleted file mode 100644 index 4cc45e9019..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avcontrol__command_8h.md +++ /dev/null @@ -1,24 +0,0 @@ -# avcontrol_command.h - - -## 概述 - -音视频控制指令的设置、获取、拷贝等声明。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md) | class
用于描述音视频播控命令工具类，播控命令的封装对象，支持设置和获取控制命令。 | diff --git a/zh-cn/application-dev/reference/native-apis/avmeta__data_8h.md b/zh-cn/application-dev/reference/native-apis/avmeta__data_8h.md deleted file mode 100644 index bbaa050e9c..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avmeta__data_8h.md +++ /dev/null @@ -1,24 +0,0 @@ -# avmeta_data.h - - -## 概述 - -会话元数据设置、获取、拷贝等接口声明。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) | class
会话元数据类，提供获取metadata进程间传递的序列化和反序列话及数据拷贝的接口方法。 | diff --git a/zh-cn/application-dev/reference/native-apis/avplayback__state_8h.md b/zh-cn/application-dev/reference/native-apis/avplayback__state_8h.md deleted file mode 100644 index d8099b9ab1..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avplayback__state_8h.md +++ /dev/null @@ -1,25 +0,0 @@ -# avplayback_state.h - - -## 概述 - -音视频播放状态声明。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) | class
音视频播放状态类，提供获取和设置播放界面的信息。 | -| [OHOS::AVSession::AVPlaybackState::Position](_1_a_v_session_1_1_a_v_playback_state_1_1_position.md) | struct
播放位置的相关信息。 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession.md b/zh-cn/application-dev/reference/native-apis/avsession.md deleted file mode 100644 index 95409373aa..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avsession.md +++ /dev/null @@ -1,469 +0,0 @@ -# Avsession - - -## 概述 - -音视频媒体会话，提供系统内媒体的统一控制能力。 - -功能包括媒体会话，媒体会话管理，媒体会话控制。 - -@syscap SystemCapability.Multimedia.AVSession.Core - -**起始版本：** - -9 - -**Version:** - -1.0 - - -## 汇总 - - -### 文件 - - | 名称 | 描述 | -| -------- | -------- | -| [av_session.h](av__session_8h.md) | 会话的设置、获取等声明。 | -| [avcontrol_command.h](avcontrol__command_8h.md) | 音视频控制指令的设置、获取、拷贝等声明。 | -| [avmeta_data.h](avmeta__data_8h.md) | 会话元数据设置、获取、拷贝等接口声明。 | -| [avplayback_state.h](avplayback__state_8h.md) | 音视频播放状态声明。 | -| [avsession_controller.h](avsession__controller_8h.md) | 控制器对象的描述，可获取会话的播放状态和会话元数据，远程发送控制命令到会话端也可以通过订阅监听会话段的更新事件。 | -| [avsession_descriptor.h](avsession__descriptor_8h.md) | 会话的相关描述信息。 | -| [avsession_errors.h](avsession__errors_8h.md) | 定义了avsession错误码。 | -| [avsession_info.h](avsession__info_8h.md) | 定义了与avsession相关的监听器以及回调功能的实现。 | -| [avsession_manager.h](avsession__manager_8h.md) | 定义了会话管理器对外接口的功能的实现。 | -| [avsession_pixel_map.h](avsession__pixel__map_8h.md) | 读取、设置图片及图片信息。 | - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) | struct
描述分布式设备的相关信息。 | -| [OHOS::AVSession::AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) | struct
会话的相关描述信息。 | -| [OHOS::AVSession::AVSessionBasicInfo](o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md) | struct
会话基础信息描述。 | - - -### 函数 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::AVSessionDescriptor::WriteToParcel](#writetoparcel) (Parcel &out) const | bool
将会话相关描述信息写进包里。 | -| [OHOS::AVSession::AVSessionDescriptor::ReadFromParcel](#readfromparcel) (Parcel &in) | bool
对会话相关描述信息进行解包。 | - - -### 变量 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::OutputDeviceInfo::isRemote_](#isremote) {} | bool
是否连接 | -| [OHOS::AVSession::OutputDeviceInfo::deviceIds_](#deviceids) | std::vector< std::string >
分布式设备的id集合 | -| [OHOS::AVSession::OutputDeviceInfo::deviceNames_](#devicenames) | std::vector< std::string >
分布式设备的名称集合 | -| [OHOS::AVSession::AVSessionDescriptor::sessionId_](#sessionid) | std::string
会话的id | -| [OHOS::AVSession::AVSessionDescriptor::sessionType_](#sessiontype) {} | int32_t
会话的类型 | -| [OHOS::AVSession::AVSessionDescriptor::sessionTag_](#sessiontag) | std::string
会话的自定义名称 | -| [OHOS::AVSession::AVSessionDescriptor::elementName_](#elementname) | AppExecFwk::ElementName
会话所属应用的信息包含bundleName，abilityName等 | -| [OHOS::AVSession::AVSessionDescriptor::pid_](#pid) {} | pid_t
进程id | -| [OHOS::AVSession::AVSessionDescriptor::uid_](#uid) {} | pid_t
用户id | -| [OHOS::AVSession::AVSessionDescriptor::isActive_](#isactive) {} | bool
会话是否为激活状态 | -| [OHOS::AVSession::AVSessionDescriptor::isTopSession_](#istopsession) {} | bool
会话是否是最新的会话 | -| [OHOS::AVSession::AVSessionDescriptor::isThirdPartyApp_](#isthirdpartyapp) {} | bool
是否是第三方应用 | -| [OHOS::AVSession::AVSessionDescriptor::outputDeviceInfo_](#outputdeviceinfo) | [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md)
分布式设备相关信息 | -| [OHOS::AVSession::AVSessionBasicInfo::deviceName_](#devicename) {} | std::string
设备名称 | -| [OHOS::AVSession::AVSessionBasicInfo::networkId_](#networkid) {} | std::string
设备id | -| [OHOS::AVSession::AVSessionBasicInfo::vendorId_](#vendorid) {} | std::string
供应商id | -| [OHOS::AVSession::AVSessionBasicInfo::deviceType_](#devicetype) {} | std::string
设备类型 | -| [OHOS::AVSession::AVSessionBasicInfo::systemVersion_](#systemversion) {} | std::string
系统版本 | -| [OHOS::AVSession::AVSessionBasicInfo::sessionVersion_](#sessionversion) {} | int32_t
会话版本 | -| [OHOS::AVSession::AVSessionBasicInfo::reserve_](#reserve) {} | std::vector< int32_t >
备注信息 | -| [OHOS::AVSession::AVSessionBasicInfo::feature_](#feature) {} | std::vector< int32_t >
特征信息 | -| [OHOS::AVSession::AVSessionBasicInfo::metaDataCap_](#metadatacap) {} | std::vector< int32_t >
会话元数据 | -| [OHOS::AVSession::AVSessionBasicInfo::playBackStateCap_](#playbackstatecap) {} | std::vector< int32_t >
支持播放状态数组 | -| [OHOS::AVSession::AVSessionBasicInfo::controlCommandCap_](#controlcommandcap) {} | std::vector< int32_t >
系统控制命令 | -| [OHOS::AVSession::AVSessionBasicInfo::extendCapability_](#extendcapability) {} | std::vector< int32_t >
扩展能力 | -| [OHOS::AVSession::AVSessionBasicInfo::systemTime_](#systemtime) {} | int32_t
系统时间 | -| [OHOS::AVSession::AVSessionBasicInfo::extend_](#extend) {} | std::vector< int32_t >
扩展信息 | - - -## 函数说明 - - -### ReadFromParcel() - - -``` -bool OHOS::AVSession::AVSessionDescriptor::ReadFromParcel (Parcel & in) -``` - -**描述:** - -对会话相关描述信息进行解包。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| in | 读出的会话相关描述信息对象**Parcel**。 | - -**返回:** - -成功返回true；失败则返回false。 - -**参见:** - -[WriteToParcel](#writetoparcel) - - -### WriteToParcel() - - -``` -bool OHOS::AVSession::AVSessionDescriptor::WriteToParcel (Parcel & out) const -``` - -**描述:** - -将会话相关描述信息写进包里。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| out | 写入的会话相关描述信息对象**Parcel**。 | - -**返回:** - -成功返回true；失败则返回false。 - -**参见:** - -[ReadFromParcel](#readfromparcel) - - -## 变量说明 - - -### controlCommandCap_ - - -``` -std::vector OHOS::AVSession::AVSessionBasicInfo::controlCommandCap_ {} -``` - -**描述:** - -系统控制命令 - - -### deviceIds_ - - -``` -std::vector OHOS::AVSession::OutputDeviceInfo::deviceIds_ -``` - -**描述:** - -分布式设备的id集合 - - -### deviceName_ - - -``` -std::string OHOS::AVSession::AVSessionBasicInfo::deviceName_ {} -``` - -**描述:** - -设备名称 - - -### deviceNames_ - - -``` -std::vector OHOS::AVSession::OutputDeviceInfo::deviceNames_ -``` - -**描述:** - -分布式设备的名称集合 - - -### deviceType_ - - -``` -std::string OHOS::AVSession::AVSessionBasicInfo::deviceType_ {} -``` - -**描述:** - -设备类型 - - -### elementName_ - - -``` -AppExecFwk::ElementName OHOS::AVSession::AVSessionDescriptor::elementName_ -``` - -**描述:** - -会话所属应用的信息包含bundleName，abilityName等 - - -### extend_ - - -``` -std::vector OHOS::AVSession::AVSessionBasicInfo::extend_ {} -``` - -**描述:** - -扩展信息 - - -### extendCapability_ - - -``` -std::vector OHOS::AVSession::AVSessionBasicInfo::extendCapability_ {} -``` - -**描述:** - -扩展能力 - - -### feature_ - - -``` -std::vector OHOS::AVSession::AVSessionBasicInfo::feature_ {} -``` - -**描述:** - -特征信息 - - -### isActive_ - - -``` -bool OHOS::AVSession::AVSessionDescriptor::isActive_ {} -``` - -**描述:** - -会话是否为激活状态 - - -### isRemote_ - - -``` -bool OHOS::AVSession::OutputDeviceInfo::isRemote_ {} -``` - -**描述:** - -是否连接 - - -### isThirdPartyApp_ - - -``` -bool OHOS::AVSession::AVSessionDescriptor::isThirdPartyApp_ {} -``` - -**描述:** - -是否是第三方应用 - - -### isTopSession_ - - -``` -bool OHOS::AVSession::AVSessionDescriptor::isTopSession_ {} -``` - -**描述:** - -会话是否是最新的会话 - - -### metaDataCap_ - - -``` -std::vector OHOS::AVSession::AVSessionBasicInfo::metaDataCap_ {} -``` - -**描述:** - -会话元数据 - - -### networkId_ - - -``` -std::string OHOS::AVSession::AVSessionBasicInfo::networkId_ {} -``` - -**描述:** - -设备id - - -### outputDeviceInfo_ - - -``` -OutputDeviceInfo OHOS::AVSession::AVSessionDescriptor::outputDeviceInfo_ -``` - -**描述:** - -分布式设备相关信息 - - -### pid_ - - -``` -pid_t OHOS::AVSession::AVSessionDescriptor::pid_ {} -``` - -**描述:** - -进程id - - -### playBackStateCap_ - - -``` -std::vector OHOS::AVSession::AVSessionBasicInfo::playBackStateCap_ {} -``` - -**描述:** - -支持播放状态数组 - - -### reserve_ - - -``` -std::vector OHOS::AVSession::AVSessionBasicInfo::reserve_ {} -``` - -**描述:** - -备注信息 - - -### sessionId_ - - -``` -std::string OHOS::AVSession::AVSessionDescriptor::sessionId_ -``` - -**描述:** - -会话的id - - -### sessionTag_ - - -``` -std::string OHOS::AVSession::AVSessionDescriptor::sessionTag_ -``` - -**描述:** - -会话的自定义名称 - - -### sessionType_ - - -``` -int32_t OHOS::AVSession::AVSessionDescriptor::sessionType_ {} -``` - -**描述:** - -会话的类型 - - -### sessionVersion_ - - -``` -int32_t OHOS::AVSession::AVSessionBasicInfo::sessionVersion_ {} -``` - -**描述:** - -会话版本 - - -### systemTime_ - - -``` -int32_t OHOS::AVSession::AVSessionBasicInfo::systemTime_ {} -``` - -**描述:** - -系统时间 - - -### systemVersion_ - - -``` -std::string OHOS::AVSession::AVSessionBasicInfo::systemVersion_ {} -``` - -**描述:** - -系统版本 - - -### uid_ - - -``` -pid_t OHOS::AVSession::AVSessionDescriptor::uid_ {} -``` - -**描述:** - -用户id - - -### vendorId_ - - -``` -std::string OHOS::AVSession::AVSessionBasicInfo::vendorId_ {} -``` - -**描述:** - -供应商id diff --git a/zh-cn/application-dev/reference/native-apis/avsession__controller_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__controller_8h.md deleted file mode 100644 index 38446db715..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avsession__controller_8h.md +++ /dev/null @@ -1,24 +0,0 @@ -# avsession_controller.h - - -## 概述 - -控制器对象的描述，可获取会话的播放状态和会话元数据，远程发送控制命令到会话端也可以通过订阅监听会话段的更新事件。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::AVSessionController](o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md) | class
控制器对象，可获取会话的播放状态和会话元数据，远程发送控制命令到会话端也可以通过订阅监听会话段的更新事件。 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession__descriptor_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__descriptor_8h.md deleted file mode 100644 index 73c87d3892..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avsession__descriptor_8h.md +++ /dev/null @@ -1,26 +0,0 @@ -# avsession_descriptor.h - - -## 概述 - -会话的相关描述信息。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) | struct
描述分布式设备的相关信息。 | -| [OHOS::AVSession::AVSessionDescriptor](o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md) | struct
会话的相关描述信息。 | -| [OHOS::AVSession::AVSessionBasicInfo](o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md) | struct
会话基础信息描述。 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession__errors_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__errors_8h.md deleted file mode 100644 index 649a7edbf8..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avsession__errors_8h.md +++ /dev/null @@ -1,268 +0,0 @@ -# avsession_errors.h - - -## 概述 - -定义了avsession错误码。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 变量 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::AVSESSION_ERROR](#avsession_error) = -1 | constexpr int32_t
存在错误 | -| [OHOS::AVSession::AVSESSION_SUCCESS](#avsession_success) = 0 | constexpr int32_t
操作成功 | -| [OHOS::AVSession::AVSESSION_ERROR_BASE](#avsession_error_base) = 1000 | constexpr int32_t
avsession错误码的基定义 | -| [OHOS::AVSession::ERR_NO_MEMORY](#err_no_memory) = -(AVSESSION_ERROR_BASE + 1) | constexpr int32_t
无可用内存 | -| [OHOS::AVSession::ERR_INVALID_PARAM](#err_invalid_param) = -(AVSESSION_ERROR_BASE + 2) | constexpr int32_t
传递的参数无效 | -| [OHOS::AVSession::ERR_SERVICE_NOT_EXIST](#err_service_not_exist) = -(AVSESSION_ERROR_BASE + 3) | constexpr int32_t
服务不存在 | -| [OHOS::AVSession::ERR_SESSION_LISTENER_EXIST](#err_session_listener_exist) = -(AVSESSION_ERROR_BASE + 4) | constexpr int32_t
Session监听器已存在 | -| [OHOS::AVSession::ERR_MARSHALLING](#err_marshalling) = -(AVSESSION_ERROR_BASE + 5) | constexpr int32_t
数据序列化操作错误 | -| [OHOS::AVSession::ERR_UNMARSHALLING](#err_unmarshalling) = -(AVSESSION_ERROR_BASE + 6) | constexpr int32_t
数据反序列化操作错误 | -| [OHOS::AVSession::ERR_IPC_SEND_REQUEST](#err_ipc_send_request) = -(AVSESSION_ERROR_BASE + 7) | constexpr int32_t
IPC发送数据失败 | -| [OHOS::AVSession::ERR_SESSION_EXCEED_MAX](#err_session_exceed_max) = -(AVSESSION_ERROR_BASE + 8) | constexpr int32_t
超过允许会话最大数量 | -| [OHOS::AVSession::ERR_SESSION_NOT_EXIST](#err_session_not_exist) = -(AVSESSION_ERROR_BASE + 9) | constexpr int32_t
会话不存在 | -| [OHOS::AVSession::ERR_COMMAND_NOT_SUPPORT](#err_command_not_support) = -(AVSESSION_ERROR_BASE + 10) | constexpr int32_t
会话命令不支持 | -| [OHOS::AVSession::ERR_CONTROLLER_NOT_EXIST](#err_controller_not_exist) = -(AVSESSION_ERROR_BASE + 11) | constexpr int32_t
控制器不存在 | -| [OHOS::AVSession::ERR_NO_PERMISSION](#err_no_permission) = -(AVSESSION_ERROR_BASE + 12) | constexpr int32_t
无权限 | -| [OHOS::AVSession::ERR_SESSION_DEACTIVE](#err_session_deactive) = -(AVSESSION_ERROR_BASE + 13) | constexpr int32_t
会话未激活 | -| [OHOS::AVSession::ERR_CONTROLLER_IS_EXIST](#err_controller_is_exist) = -(AVSESSION_ERROR_BASE + 14) | constexpr int32_t
控制器存在 | -| [OHOS::AVSession::ERR_START_ABILITY_IS_RUNNING](#err_start_ability_is_running) = -(AVSESSION_ERROR_BASE + 15) | constexpr int32_t
元能力正在运行 | -| [OHOS::AVSession::ERR_ABILITY_NOT_AVAILABLE](#err_ability_not_available) = -(AVSESSION_ERROR_BASE + 16) | constexpr int32_t
元能力启动超失败 | -| [OHOS::AVSession::ERR_START_ABILITY_TIMEOUT](#err_start_ability_timeout) = -(AVSESSION_ERROR_BASE + 17) | constexpr int32_t
元能力启动超时 | -| [OHOS::AVSession::ERR_COMMAND_SEND_EXCEED_MAX](#err_command_send_exceed_max) = -(AVSESSION_ERROR_BASE + 18) | constexpr int32_t
指令发送次数超过最大值 | -| [OHOS::AVSession::ERR_RPC_SEND_REQUEST](#err_rpc_send_request) = -(AVSESSION_ERROR_BASE + 19) | constexpr int32_t
RPC发送数据失败 | - - -## 变量说明 - - -### AVSESSION_ERROR - - -``` -constexpr int32_t OHOS::AVSession::AVSESSION_ERROR = -1 -``` -**描述:** -存在错误 - - -### AVSESSION_ERROR_BASE - - -``` -constexpr int32_t OHOS::AVSession::AVSESSION_ERROR_BASE = 1000 -``` -**描述:** -avsession错误码的基定义 - - -### AVSESSION_SUCCESS - - -``` -constexpr int32_t OHOS::AVSession::AVSESSION_SUCCESS = 0 -``` -**描述:** -操作成功 - - -### ERR_ABILITY_NOT_AVAILABLE - - -``` -constexpr int32_t OHOS::AVSession::ERR_ABILITY_NOT_AVAILABLE = -(AVSESSION_ERROR_BASE + 16) -``` -**描述:** -元能力启动超失败 - - -### ERR_COMMAND_NOT_SUPPORT - - -``` -constexpr int32_t OHOS::AVSession::ERR_COMMAND_NOT_SUPPORT = -(AVSESSION_ERROR_BASE + 10) -``` -**描述:** -会话命令不支持 - - -### ERR_COMMAND_SEND_EXCEED_MAX - - -``` -constexpr int32_t OHOS::AVSession::ERR_COMMAND_SEND_EXCEED_MAX = -(AVSESSION_ERROR_BASE + 18) -``` -**描述:** -指令发送次数超过最大值 - - -### ERR_CONTROLLER_IS_EXIST - - -``` -constexpr int32_t OHOS::AVSession::ERR_CONTROLLER_IS_EXIST = -(AVSESSION_ERROR_BASE + 14) -``` -**描述:** -控制器存在 - - -### ERR_CONTROLLER_NOT_EXIST - - -``` -constexpr int32_t OHOS::AVSession::ERR_CONTROLLER_NOT_EXIST = -(AVSESSION_ERROR_BASE + 11) -``` -**描述:** -控制器不存在 - - -### ERR_INVALID_PARAM - - -``` -constexpr int32_t OHOS::AVSession::ERR_INVALID_PARAM = -(AVSESSION_ERROR_BASE + 2) -``` -**描述:** -传递的参数无效 - - -### ERR_IPC_SEND_REQUEST - - -``` -constexpr int32_t OHOS::AVSession::ERR_IPC_SEND_REQUEST = -(AVSESSION_ERROR_BASE + 7) -``` -**描述:** -IPC发送数据失败 - - -### ERR_MARSHALLING - - -``` -constexpr int32_t OHOS::AVSession::ERR_MARSHALLING = -(AVSESSION_ERROR_BASE + 5) -``` -**描述:** -数据序列化操作错误 - - -### ERR_NO_MEMORY - - -``` -constexpr int32_t OHOS::AVSession::ERR_NO_MEMORY = -(AVSESSION_ERROR_BASE + 1) -``` -**描述:** -无可用内存 - - -### ERR_NO_PERMISSION - - -``` -constexpr int32_t OHOS::AVSession::ERR_NO_PERMISSION = -(AVSESSION_ERROR_BASE + 12) -``` -**描述:** -无权限 - - -### ERR_RPC_SEND_REQUEST - - -``` -constexpr int32_t OHOS::AVSession::ERR_RPC_SEND_REQUEST = -(AVSESSION_ERROR_BASE + 19) -``` -**描述:** -RPC发送数据失败 - - -### ERR_SERVICE_NOT_EXIST - - -``` -constexpr int32_t OHOS::AVSession::ERR_SERVICE_NOT_EXIST = -(AVSESSION_ERROR_BASE + 3) -``` -**描述:** -服务不存在 - - -### ERR_SESSION_DEACTIVE - - -``` -constexpr int32_t OHOS::AVSession::ERR_SESSION_DEACTIVE = -(AVSESSION_ERROR_BASE + 13) -``` -**描述:** -会话未激活 - - -### ERR_SESSION_EXCEED_MAX - - -``` -constexpr int32_t OHOS::AVSession::ERR_SESSION_EXCEED_MAX = -(AVSESSION_ERROR_BASE + 8) -``` -**描述:** -超过允许会话最大数量 - - -### ERR_SESSION_LISTENER_EXIST - - -``` -constexpr int32_t OHOS::AVSession::ERR_SESSION_LISTENER_EXIST = -(AVSESSION_ERROR_BASE + 4) -``` -**描述:** -Session监听器已存在 - - -### ERR_SESSION_NOT_EXIST - - -``` -constexpr int32_t OHOS::AVSession::ERR_SESSION_NOT_EXIST = -(AVSESSION_ERROR_BASE + 9) -``` -**描述:** -会话不存在 - - -### ERR_START_ABILITY_IS_RUNNING - - -``` -constexpr int32_t OHOS::AVSession::ERR_START_ABILITY_IS_RUNNING = -(AVSESSION_ERROR_BASE + 15) -``` -**描述:** -元能力正在运行 - - -### ERR_START_ABILITY_TIMEOUT - - -``` -constexpr int32_t OHOS::AVSession::ERR_START_ABILITY_TIMEOUT = -(AVSESSION_ERROR_BASE + 17) -``` -**描述:** -元能力启动超时 - - -### ERR_UNMARSHALLING - - -``` -constexpr int32_t OHOS::AVSession::ERR_UNMARSHALLING = -(AVSESSION_ERROR_BASE + 6) -``` -**描述:** -数据反序列化操作错误 diff --git a/zh-cn/application-dev/reference/native-apis/avsession__info_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__info_8h.md deleted file mode 100644 index 5d2eda467f..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avsession__info_8h.md +++ /dev/null @@ -1,75 +0,0 @@ -# avsession_info.h - - -## 概述 - -定义了与avsession相关的监听器以及回调功能的实现。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::SessionListener](_o_h_o_s_1_1_a_v_session_1_1_session_listener.md) | class
定义与AVSession相关监听器的类的实现。 | -| [OHOS::AVSession::AVSessionCallback](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_callback.md) | class
定义AVSession回调类的实现 | -| [OHOS::AVSession::AVControllerCallback](_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md) | class
定义控制器相关回调操作的类的实现。 | -| [OHOS::AVSession::SessionToken](_o_h_o_s_1_1_a_v_session_1_1_session_token.md) | struct
会话令牌的信息。 | - - -### 类型定义 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::DeathCallback](#deathcallback) = std::function< void()> | using | - - -### 枚举 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::SessionDataCategory](#sessiondatacategory) {
**OHOS::AVSession::SESSION_DATA_CATEGORY_INVALID** = -1, **OHOS::AVSession::SESSION_DATA_META** = 0, **OHOS::AVSession::SESSION_DATA_PLAYBACK_STATE** = 1, **OHOS::AVSession::SESSION_DATA_CONTROL_COMMAND** = 2, **OHOS::AVSession::SESSION_DATA_CATEGORY_MAX** = 3
} | 会话元数据处理标识 | - - -## 类型定义说明 - - -### DeathCallback - - -``` -using OHOS::AVSession::DeathCallback = typedef std::function -``` -**描述:** -AVSession死亡回调 - - -## 枚举类型说明 - - -### SessionDataCategory - - -``` -enum OHOS::AVSession::SessionDataCategory -``` -**描述:** -会话元数据处理标识 - - | 枚举值 | 描述 | -| -------- | -------- | -| SESSION_DATA_CATEGORY_INVALID | 无效类型，内部用于类型是否有效 | -| SESSION_DATA_META | 会话元数据 | -| SESSION_DATA_PLAYBACK_STATE | 会话播放状态 | -| SESSION_DATA_CONTROL_COMMAND | 会话控制命令 | -| SESSION_DATA_CATEGORY_MAX | 会话数据类型的数量 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession__manager_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__manager_8h.md deleted file mode 100644 index 86b408d3bb..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avsession__manager_8h.md +++ /dev/null @@ -1,24 +0,0 @@ -# avsession_manager.h - - -## 概述 - -定义了会话管理器对外接口的功能的实现。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::AVSessionManager](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md) | class
实现会话管理器对外接口功能的类的实现。 | diff --git a/zh-cn/application-dev/reference/native-apis/avsession__pixel__map_8h.md b/zh-cn/application-dev/reference/native-apis/avsession__pixel__map_8h.md deleted file mode 100644 index 0843e8fad6..0000000000 --- a/zh-cn/application-dev/reference/native-apis/avsession__pixel__map_8h.md +++ /dev/null @@ -1,44 +0,0 @@ -# avsession_pixel_map.h - - -## 概述 - -读取、设置图片及图片信息。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 结构体 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::AVSessionPixelMap](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_pixel_map.md) | class
读取、设置图片及图片信息。 | - - -### 变量 - - | 名称 | 描述 | -| -------- | -------- | -| [OHOS::AVSession::DEFAULT_BUFFER_SIZE](#default_buffer_size) = 160 \* 1024 | constexpr size_t
初始化容器大小为160KB | - - -## 变量说明 - - -### DEFAULT_BUFFER_SIZE - - -``` -constexpr size_t OHOS::AVSession::DEFAULT_BUFFER_SIZE = 160 * 1024 -``` -**描述:** -初始化容器大小为160KB diff --git a/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md b/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md deleted file mode 100644 index 7f80f23b75..0000000000 --- a/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_basic_info.md +++ /dev/null @@ -1,37 +0,0 @@ -# OHOS::AVSession::AVSessionBasicInfo - - -## 概述 - -会话基础信息描述。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### 成员变量 - - | 名称 | 描述 | -| -------- | -------- | -| [deviceName_](avsession.md#devicename) {} | std::string | -| [networkId_](avsession.md#networkid) {} | std::string | -| [vendorId_](avsession.md#vendorid) {} | std::string | -| [deviceType_](avsession.md#devicetype) {} | std::string | -| [systemVersion_](avsession.md#systemversion) {} | std::string | -| [sessionVersion_](avsession.md#sessionversion) {} | int32_t | -| [reserve_](avsession.md#reserve) {} | std::vector< int32_t > | -| [feature_](avsession.md#feature) {} | std::vector< int32_t > | -| [metaDataCap_](avsession.md#metadatacap) {} | std::vector< int32_t > | -| [playBackStateCap_](avsession.md#playbackstatecap) {} | std::vector< int32_t > | -| [controlCommandCap_](avsession.md#controlcommandcap) {} | std::vector< int32_t > | -| [extendCapability_](avsession.md#extendcapability) {} | std::vector< int32_t > | -| [systemTime_](avsession.md#systemtime) {} | int32_t | -| [extend_](avsession.md#extend) {} | std::vector< int32_t > | diff --git a/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md b/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md deleted file mode 100644 index 337f6045d9..0000000000 --- a/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_controller.md +++ /dev/null @@ -1,328 +0,0 @@ -# OHOS::AVSession::AVSessionController - - -## 概述 - -控制器对象，可获取会话的播放状态和会话元数据，远程发送控制命令到会话端也可以通过订阅监听会话段的更新事件。 - - -## 汇总 - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [GetAVPlaybackState](#getavplaybackstate) ([AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md) &state)=0 | 获取音视频的播放状态。  | -| [GetAVMetaData](#getavmetadata) ([AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md) &data)=0 | 获取会话元数据。  | -| [SendAVKeyEvent](#sendavkeyevent) (const MMI::KeyEvent &keyEvent)=0 | 发送系统按键事件。  | -| [GetLaunchAbility](#getlaunchability) (AbilityRuntime::WantAgent::WantAgent &ability)=0 | 获取Ability。  | -| [GetValidCommands](#getvalidcommands) (std::vector< int32_t > &cmds)=0 | 获取媒体有效的指令。  | -| [IsSessionActive](#issessionactive) (bool &isActive)=0 | 获取session的激活状态。  | -| [SendControlCommand](#sendcontrolcommand) (const [AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md) &cmd)=0 | 发送媒体控制指令。  | -| [RegisterCallback](#registercallback) (const std::shared_ptr< [AVControllerCallback](_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md) > &callback)=0 | 注册回调。  | -| [SetMetaFilter](#setmetafilter) (const [AVMetaData::MetaMaskType](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md#metamasktype) &filter)=0 | 设置会话元数据过滤。  | -| [SetPlaybackFilter](#setplaybackfilter) (const AVPlaybackState::PlaybackStateMaskType &filter)=0 | 设置音视频的播放状态回调过滤。  | -| [Destroy](#destroy) ()=0 | 释放控制器。  | -| [GetSessionId](#getsessionid) ()=0 | 获取sessionId。  | -| [GetRealPlaybackPosition](#getrealplaybackposition) ()=0 | 获取播放的实时位置，第 x ms。  | -| [IsDestroy](#isdestroy) ()=0 | 是否释放控制器。  | - - -## 成员函数说明 - - -### Destroy() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::Destroy () -``` -**描述:** -释放控制器。 - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### GetAVMetaData() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::GetAVMetaData (AVMetaData & data) -``` -**描述:** -获取会话元数据。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| data | 会话元数据[AVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md)。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[AVSession::SetAVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#setavmetadata) - -[AVSession::GetAVMetaData](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#getavmetadata) - - -### GetAVPlaybackState() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::GetAVPlaybackState (AVPlaybackState & state) -``` -**描述:** -获取音视频的播放状态。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| state | 音视频的播放状态[AVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_playback_state.md)。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[AVSession::SetAVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#setavplaybackstate) - -[AVSession::GetAVPlaybackState](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#getavplaybackstate) - - -### GetLaunchAbility() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::GetLaunchAbility (AbilityRuntime::WantAgent::WantAgent & ability) -``` -**描述:** -获取Ability。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| ability | 类型为**AbilityRuntime::WantAgent::WantAgent**。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[AVSession::SetLaunchAbility](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#setlaunchability) - - -### GetRealPlaybackPosition() - - -``` -virtual int64_t OHOS::AVSession::AVSessionController::GetRealPlaybackPosition () -``` -**描述:** -获取播放的实时位置，第 x ms。 - -**返回:** - -返回播放的实时位置，第x ms，经过校正过的时间，单位为ms。 - - -### GetSessionId() - - -``` -virtual std::string OHOS::AVSession::AVSessionController::GetSessionId () -``` -**描述:** -获取sessionId。 - -**返回:** - -返回sessionId。 - - -### GetValidCommands() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::GetValidCommands (std::vector< int32_t > & cmds) -``` -**描述:** -获取媒体有效的指令。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| cmds | 媒体有效的指令列表，范围为**SESSION_CMD_INVALID**到**SESSION_CMD_MAX**。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[SendControlCommand](#sendcontrolcommand) - -[AVSession::AddSupportCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#addsupportcommand) - -[AVSession::DeleteSupportCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#deletesupportcommand) - - -### IsDestroy() - - -``` -virtual bool OHOS::AVSession::AVSessionController::IsDestroy () -``` -**描述:** -是否释放控制器。 - -**返回:** - -true：释放；false：不释放。 - - -### IsSessionActive() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::IsSessionActive (bool & isActive) -``` -**描述:** -获取session的激活状态。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| isActive | session是否激活。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[AVSession::Activate](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#activate) - -[AVSession::Deactivate](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#deactivate) - -[AVSession::IsActive](_o_h_o_s_1_1_a_v_session_1_1_a_v_session.md#isactive) - - -### RegisterCallback() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::RegisterCallback (const std::shared_ptr< AVControllerCallback > & callback) -``` -**描述:** -注册回调。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| callback | 需要注册的回调，类型为[AVControllerCallback](_h_o_s_1_1_a_v_session_1_1_a_v_controller_callback.md)。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### SendAVKeyEvent() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::SendAVKeyEvent (const MMI::KeyEvent & keyEvent) -``` -**描述:** -发送系统按键事件。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| keyEvent | 按键事件码，类型为**MMI::KeyEvent**。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[AVSessionManager::SendSystemAVKeyEvent](_o_h_o_s_1_1_a_v_session_1_1_a_v_session_manager.md#sendsystemavkeyevent) - - -### SendControlCommand() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::SendControlCommand (const AVControlCommand & cmd) -``` -**描述:** -发送媒体控制指令。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| cmd | 媒体控制指令，类型为[AVControlCommand](_o_h_o_s_1_1_a_v_session_1_1_a_v_control_command.md)。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - -**参见:** - -[GetValidCommands](#getvalidcommands) - - -### SetMetaFilter() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::SetMetaFilter (const AVMetaData::MetaMaskType & filter) -``` -**描述:** -设置会话元数据过滤。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| filter | 会话元数据过滤，类型为[AVMetaData#MetaMaskType](_o_h_o_s_1_1_a_v_session_1_1_a_v_meta_data.md#metamasktype)。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 - - -### SetPlaybackFilter() - - -``` -virtual int32_t OHOS::AVSession::AVSessionController::SetPlaybackFilter (const AVPlaybackState::PlaybackStateMaskType & filter) -``` -**描述:** -设置音视频的播放状态回调过滤。 - -**参数:** - - | 名称 | 描述 | -| -------- | -------- | -| filter | 音视频播放状态回调过滤，类型为**AVPlaybackState\#PlaybackStateMaskType**。  | - -**返回:** - -成功返回**AVSESSION_SUCCESS**；失败则返回对应错误码。 diff --git a/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md b/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md deleted file mode 100644 index c68f7cf388..0000000000 --- a/zh-cn/application-dev/reference/native-apis/o_h_o_s_1_1_a_v_session_1_1_a_v_session_descriptor.md +++ /dev/null @@ -1,41 +0,0 @@ -# OHOS::AVSession::AVSessionDescriptor - - -## 概述 - -会话的相关描述信息。 - -**起始版本：** -9 -**Version:** -1.0 -**相关模块:** - -[Avsession](avsession.md) - - -## 汇总 - - -### Public 成员函数 - - | 名称 | 描述 | -| -------- | -------- | -| [WriteToParcel](avsession.md#writetoparcel) (Parcel &out) const | 将会话相关描述信息写进包里。  | -| [ReadFromParcel](avsession.md#readfromparcel) (Parcel &in) | 对会话相关描述信息进行解包。  | - - -### 成员变量 - - | 名称 | 描述 | -| -------- | -------- | -| [sessionId_](avsession.md#sessionid) | std::string | -| [sessionType_](avsession.md#sessiontype) {} | int32_t | -| [sessionTag_](avsession.md#sessiontag) | std::string | -| [elementName_](avsession.md#elementname) | AppExecFwk::ElementName | -| [pid_](avsession.md#pid) {} | pid_t | -| [uid_](avsession.md#uid) {} | pid_t | -| [isActive_](avsession.md#isactive) {} | bool | -| [isTopSession_](avsession.md#istopsession) {} | bool | -| [isThirdPartyApp_](avsession.md#isthirdpartyapp) {} | bool | -| [outputDeviceInfo_](avsession.md#outputdeviceinfo) | [OutputDeviceInfo](_o_h_o_s_1_1_a_v_session_1_1_output_device_info.md) | -- GitLab