From 0e6ce1be307b580832e60e18b9215691eb012750 Mon Sep 17 00:00:00 2001 From: zengyawen Date: Mon, 16 Jan 2023 11:29:00 +0800 Subject: [PATCH] update docs Signed-off-by: zengyawen --- .../reference/native-apis/Readme-CN.md | 33 +- ...ion_1_1_a_v_playback_state_1_1_position.md | 42 - ...a_v_session_1_1_a_v_controller_callback.md | 136 -- .../native-apis/_neural_nework_runtime.md | 1377 +++++++++++++++++ .../native-apis/_o_h___n_n___memory.md | 52 + .../native-apis/_o_h___n_n___quant_param.md | 94 ++ .../native-apis/_o_h___n_n___tensor.md | 97 ++ .../native-apis/_o_h___n_n___u_int32_array.md | 52 + ...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 - .../neural__network__runtime_8h.md | 54 + .../neural__network__runtime__type_8h.md | 55 + ..._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 - 34 files changed, 1788 insertions(+), 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 create mode 100644 zh-cn/application-dev/reference/native-apis/_neural_nework_runtime.md create mode 100644 zh-cn/application-dev/reference/native-apis/_o_h___n_n___memory.md create mode 100644 zh-cn/application-dev/reference/native-apis/_o_h___n_n___quant_param.md create mode 100644 zh-cn/application-dev/reference/native-apis/_o_h___n_n___tensor.md create mode 100644 zh-cn/application-dev/reference/native-apis/_o_h___n_n___u_int32_array.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 create mode 100644 zh-cn/application-dev/reference/native-apis/neural__network__runtime_8h.md create mode 100644 zh-cn/application-dev/reference/native-apis/neural__network__runtime__type_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 25955fdf01..7aa501d679 100644 --- a/zh-cn/application-dev/reference/native-apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/native-apis/Readme-CN.md @@ -11,7 +11,7 @@ - [Image](image.md) - [Rawfile](rawfile.md) - [MindSpore](_mind_spore.md) - - [Avsession](avsession.md) + - [NeuralNeworkRuntime](_neural_nework_runtime.md) - [AudioDecoder](_audio_decoder.md) - [AudioEncoder](_audio_encoder.md) - [CodecBase](_codec_base.md) @@ -49,16 +49,8 @@ - [status.h](status_8h.md) - [tensor.h](tensor_8h.md) - [types.h](types_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) + - [neural_network_runtime_type.h](neural__network__runtime__type_8h.md) + - [neural_network_runtime.h](neural__network__runtime_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) @@ -87,23 +79,12 @@ - [OH_AI_CallBackParam](_o_h___a_i___call_back_param.md) - [OH_AI_ShapeInfo](_o_h___a_i___shape_info.md) - [OH_AI_TensorHandleArray](_o_h___a_i___tensor_handle_array.md) + - [OH_NN_Memory](_o_h___n_n___memory.md) + - [OH_NN_QuantParam](_o_h___n_n___quant_param.md) + - [OH_NN_Tensor](_o_h___n_n___tensor.md) + - [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/_neural_nework_runtime.md b/zh-cn/application-dev/reference/native-apis/_neural_nework_runtime.md new file mode 100644 index 0000000000..e265384899 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_neural_nework_runtime.md @@ -0,0 +1,1377 @@ +# NeuralNeworkRuntime + + +提供Neural Network Runtime加速模型推理的相关接口。 + + +@Syscap SystemCapability.Ai.NeuralNetworkRuntime + + +**起始版本：** + + +9 + + +## 汇总 + + +### 文件 + +| 文件名称 | 描述 | +| -------- | -------- | +| [neural_network_runtime.h](neural__network__runtime_8h.md) | Neural Network Runtime部件接口定义，AI推理框架通过Neural Network Runtime提供的Native接口，完成模型构造与编译，并在加速硬件上执行推理计算。 | +| [neural_network_runtime_type.h](neural__network__runtime__type_8h.md) | Neural Network Runtime定义的结构体和枚举值。 | + + +### 结构体 + +| 结构体名称 | 描述 | +| -------- | -------- | +| [OH_NN_UInt32Array](_o_h___n_n___u_int32_array.md) | 自定义的32位无符号整型数组。 | +| [OH_NN_QuantParam](_o_h___n_n___quant_param.md) | 量化信息。 | +| [OH_NN_Tensor](_o_h___n_n___tensor.md) | 张量结构体。 | +| [OH_NN_Memory](_o_h___n_n___memory.md) | 内存结构体。 | + + +### 类型定义 + +| 类型定义名称 | 描述 | +| -------- | -------- | +| [OH_NNModel](#oh_nnmodel) | Neural Network Runtime的模型句柄。 | +| [OH_NNCompilation](#oh_nncompilation) | Neural Network Runtime的编译器句柄。 | +| [OH_NNExecutor](#oh_nnexecutor) | Neural Network Runtime的执行器句柄。 | +| [OH_NN_UInt32Array](#oh_nn_uint32array) | 自定义的32位无符号整型数组类型。 | +| [OH_NN_QuantParam](#oh_nn_quantparam) | 量化信息。 | +| [OH_NN_Tensor](#oh_nn_tensor) | 张量结构体。 | +| [OH_NN_Memory](#oh_nn_memory) | 内存结构体。 | + + +### 枚举 + +| 枚举名称 | 描述 | +| -------- | -------- | +| [OH_NN_PerformanceMode](#oh_nn_performancemode) { OH_NN_PERFORMANCE_NONE = 0, OH_NN_PERFORMANCE_LOW = 1, OH_NN_PERFORMANCE_MEDIUM = 2, OH_NN_PERFORMANCE_HIGH = 3, OH_NN_PERFORMANCE_EXTREME = 4 } | 硬件的性能模式。 | +| [OH_NN_Priority](#oh_nn_priority) { OH_NN_PRIORITY_NONE = 0, OH_NN_PRIORITY_LOW = 1, OH_NN_PRIORITY_MEDIUM = 2, OH_NN_PRIORITY_HIGH = 3 } | 模型推理任务优先级。 | +| [OH_NN_ReturnCode](#oh_nn_returncode) { OH_NN_SUCCESS = 0, OH_NN_FAILED = 1, OH_NN_INVALID_PARAMETER = 2, OH_NN_MEMORY_ERROR = 3, OH_NN_OPERATION_FORBIDDEN = 4, OH_NN_NULL_PTR = 5, OH_NN_INVALID_FILE = 6, OH_NN_UNAVALIDABLE_DEVICE = 7, OH_NN_INVALID_PATH = 8 } | Neural Network Runtime 定义的错误码类型。 | +| [OH_NN_FuseType](#oh_nn_fusetype) : int8_t { OH_NN_FUSED_NONE = 0, OH_NN_FUSED_RELU = 1, OH_NN_FUSED_RELU6 = 2 } | Neural Network Runtime 融合算子中激活函数的类型。 | +| [OH_NN_Format](#oh_nn_format) { OH_NN_FORMAT_NONE = 0, OH_NN_FORMAT_NCHW = 1, OH_NN_FORMAT_NHWC = 2 } | 张量数据的排布类型。 | +| [OH_NN_DeviceType](#oh_nn_devicetype) { OH_NN_OTHERS = 0, OH_NN_CPU = 1, OH_NN_GPU = 2, OH_NN_ACCELERATOR = 3 } | Neural Network Runtime 支持的设备类型。 | +| [OH_NN_DataType](#oh_nn_datatype) { OH_NN_UNKNOWN = 0, OH_NN_BOOL = 1, OH_NN_INT8 = 2, OH_NN_INT16 = 3, OH_NN_INT32 = 4, OH_NN_INT64 = 5, OH_NN_UINT8 = 6, OH_NN_UINT16 = 7, OH_NN_UINT32 = 8, OH_NN_UINT64 = 9, OH_NN_FLOAT16 = 10, OH_NN_FLOAT32 = 11, OH_NN_FLOAT64 = 12 } | Neural Network Runtime 支持的数据类型。 | +| [OH_NN_OperationType](#oh_nn_operationtype) { OH_NN_OPS_ADD = 1, OH_NN_OPS_AVG_POOL = 2, OH_NN_OPS_BATCH_NORM = 3, OH_NN_OPS_BATCH_TO_SPACE_ND = 4, OH_NN_OPS_BIAS_ADD = 5, OH_NN_OPS_CAST = 6, OH_NN_OPS_CONCAT = 7, OH_NN_OPS_CONV2D = 8, OH_NN_OPS_CONV2D_TRANSPOSE = 9, OH_NN_OPS_DEPTHWISE_CONV2D_NATIVE = 10, OH_NN_OPS_DIV = 11, OH_NN_OPS_ELTWISE = 12, OH_NN_OPS_EXPAND_DIMS = 13, OH_NN_OPS_FILL = 14, OH_NN_OPS_FULL_CONNECTION = 15, OH_NN_OPS_GATHER = 16, OH_NN_OPS_HSWISH = 17, OH_NN_OPS_LESS_EQUAL = 18, OH_NN_OPS_MATMUL = 19, OH_NN_OPS_MAXIMUM = 20, OH_NN_OPS_MAX_POOL = 21, OH_NN_OPS_MUL = 22, OH_NN_OPS_ONE_HOT = 23, OH_NN_OPS_PAD = 24, OH_NN_OPS_POW = 25, OH_NN_OPS_SCALE = 26, OH_NN_OPS_SHAPE = 27, OH_NN_OPS_SIGMOID = 28, OH_NN_OPS_SLICE = 29, OH_NN_OPS_SOFTMAX = 30, OH_NN_OPS_SPACE_TO_BATCH_ND = 31, OH_NN_OPS_SPLIT = 32, OH_NN_OPS_SQRT = 33, OH_NN_OPS_SQUARED_DIFFERENCE = 34, OH_NN_OPS_SQUEEZE = 35, OH_NN_OPS_STACK = 36, OH_NN_OPS_STRIDED_SLICE = 37, OH_NN_OPS_SUB = 38, OH_NN_OPS_TANH = 39, OH_NN_OPS_TILE = 40, OH_NN_OPS_TRANSPOSE = 41, OH_NN_OPS_REDUCE_MEAN = 42, OH_NN_OPS_RESIZE_BILINEAR = 43, OH_NN_OPS_RSQRT = 44, OH_NN_OPS_RESHAPE = 45, OH_NN_OPS_PRELU = 46, OH_NN_OPS_RELU = 47, OH_NN_OPS_RELU6 = 48, OH_NN_OPS_LAYER_NORM = 49, OH_NN_OPS_REDUCE_PROD = 50, OH_NN_OPS_REDUCE_ALL = 51, OH_NN_OPS_QUANT_DTYPE_CAST = 52, OH_NN_OPS_TOP_K = 53, OH_NN_OPS_ARG_MAX = 54, OH_NN_OPS_UNSQUEEZE = 55, OH_NN_OPS_GELU = 56 } | Neural Network Runtime 支持算子的类型。 | +| [OH_NN_TensorType](#oh_nn_tensortype) { OH_NN_TENSOR = 0, OH_NN_ADD_ACTIVATIONTYPE = 1, OH_NN_AVG_POOL_KERNEL_SIZE = 2, OH_NN_AVG_POOL_STRIDE = 3, OH_NN_AVG_POOL_PAD_MODE = 4, OH_NN_AVG_POOL_PAD = 5, OH_NN_AVG_POOL_ACTIVATION_TYPE = 6, OH_NN_BATCH_NORM_EPSILON = 7, OH_NN_BATCH_TO_SPACE_ND_BLOCKSIZE = 8, OH_NN_BATCH_TO_SPACE_ND_CROPS = 9, OH_NN_CONCAT_AXIS = 10, OH_NN_CONV2D_STRIDES = 11, OH_NN_CONV2D_PAD = 12,OH_NN_CONV2D_DILATION = 13, OH_NN_CONV2D_PAD_MODE = 14, OH_NN_CONV2D_ACTIVATION_TYPE = 15, OH_NN_CONV2D_GROUP = 16, OH_NN_CONV2D_TRANSPOSE_STRIDES = 17, OH_NN_CONV2D_TRANSPOSE_PAD = 18, OH_NN_CONV2D_TRANSPOSE_DILATION = 19, OH_NN_CONV2D_TRANSPOSE_OUTPUT_PADDINGS = 20, OH_NN_CONV2D_TRANSPOSE_PAD_MODE = 21, OH_NN_CONV2D_TRANSPOSE_ACTIVATION_TYPE = 22, OH_NN_CONV2D_TRANSPOSE_GROUP = 23, OH_NN_DEPTHWISE_CONV2D_NATIVE_STRIDES = 24, OH_NN_DEPTHWISE_CONV2D_NATIVE_PAD = 25, OH_NN_DEPTHWISE_CONV2D_NATIVE_DILATION = 26, OH_NN_DEPTHWISE_CONV2D_NATIVE_PAD_MODE = 27, OH_NN_DEPTHWISE_CONV2D_NATIVE_ACTIVATION_TYPE = 28, OH_NN_DIV_ACTIVATIONTYPE = 29, OH_NN_ELTWISE_MODE = 30, OH_NN_FULL_CONNECTION_AXIS = 31, OH_NN_FULL_CONNECTION_ACTIVATIONTYPE = 32, OH_NN_MATMUL_TRANSPOSE_A = 33, OH_NN_MATMUL_TRANSPOSE_B = 34, OH_NN_MATMUL_ACTIVATION_TYPE = 35, OH_NN_MAX_POOL_KERNEL_SIZE = 36, OH_NN_MAX_POOL_STRIDE = 37, OH_NN_MAX_POOL_PAD_MODE = 38, OH_NN_MAX_POOL_PAD = 39, OH_NN_MAX_POOL_ACTIVATION_TYPE = 40, OH_NN_MUL_ACTIVATION_TYPE = 41, OH_NN_ONE_HOT_AXIS = 42, OH_NN_PAD_CONSTANT_VALUE = 43, OH_NN_SCALE_ACTIVATIONTYPE = 44, OH_NN_SCALE_AXIS = 45, OH_NN_SOFTMAX_AXIS = 46, OH_NN_SPACE_TO_BATCH_ND_BLOCK_SHAPE = 47, OH_NN_SPACE_TO_BATCH_ND_PADDINGS = 48, OH_NN_SPLIT_AXIS = 49, OH_NN_SPLIT_OUTPUT_NUM = 50, OH_NN_SPLIT_SIZE_SPLITS = 51, OH_NN_SQUEEZE_AXIS = 52, OH_NN_STACK_AXIS = 53, OH_NN_STRIDED_SLICE_BEGIN_MASK = 54, OH_NN_STRIDED_SLICE_END_MASK = 55, OH_NN_STRIDED_SLICE_ELLIPSIS_MASK = 56, OH_NN_STRIDED_SLICE_NEW_AXIS_MASK = 57, OH_NN_STRIDED_SLICE_SHRINK_AXIS_MASK = 58, OH_NN_SUB_ACTIVATIONTYPE = 59, OH_NN_REDUCE_MEAN_KEEP_DIMS = 60, OH_NN_RESIZE_BILINEAR_NEW_HEIGHT = 61, OH_NN_RESIZE_BILINEAR_NEW_WIDTH = 62, OH_NN_RESIZE_BILINEAR_PRESERVE_ASPECT_RATIO = 63, OH_NN_RESIZE_BILINEAR_COORDINATE_TRANSFORM_MODE = 64, OH_NN_RESIZE_BILINEAR_EXCLUDE_OUTSIDE = 65, OH_NN_LAYER_NORM_BEGIN_NORM_AXIS = 66, OH_NN_LAYER_NORM_EPSILON = 67, OH_NN_LAYER_NORM_BEGIN_PARAM_AXIS = 68, OH_NN_LAYER_NORM_ELEMENTWISE_AFFINE = 69, OH_NN_REDUCE_PROD_KEEP_DIMS = 70, OH_NN_REDUCE_ALL_KEEP_DIMS = 71, OH_NN_QUANT_DTYPE_CAST_SRC_T = 72, OH_NN_QUANT_DTYPE_CAST_DST_T = 73, OH_NN_TOP_K_SORTED = 74, OH_NN_ARG_MAX_AXIS = 75, OH_NN_ARG_MAX_KEEPDIMS = 76, OH_NN_UNSQUEEZE_AXIS = 77 } | 张量的类型。 | + + +### 函数 + +| 函数 名称 | 描述 | +| -------- | -------- | +| [OH_NNModel_Construct](#oh_nnmodel_construct) (void) | 创建[OH_NNModel](#oh_nnmodel)类型的模型实例，搭配OH_NNModel模块提供的其他接口，完成模型实例的构造。 | +| [OH_NNModel_AddTensor](#oh_nnmodel_addtensor) (OH_NNModel \*model, const OH_NN_Tensor \*tensor) | 向模型实例中添加张量。 | +| [OH_NNModel_SetTensorData](#oh_nnmodel_settensordata) (OH_NNModel \*model, uint32_t index, const void \*dataBuffer, size_t length) | 设置张量的数值。 | +| [OH_NNModel_AddOperation](#oh_nnmodel_addoperation) (OH_NNModel \*model, OH_NN_OperationType op, const OH_NN_UInt32Array \*paramIndices, const OH_NN_UInt32Array \*inputIndices, const OH_NN_UInt32Array \*outputIndices) | 向模型实例中添加算子。 | +| [OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs) (OH_NNModel \*model, const OH_NN_UInt32Array \*inputIndices, const OH_NN_UInt32Array \*outputIndices) | 指定模型的输入输出。 | +| [OH_NNModel_Finish](#oh_nnmodel_finish) (OH_NNModel \*model) | 完成模型构图。 | +| [OH_NNModel_Destroy](#oh_nnmodel_destroy) (OH_NNModel \*\*model) | 释放模型实例。 | +| [OH_NNModel_GetAvailableOperations](#oh_nnmodel_getavailableoperations) (OH_NNModel \*model, size_t deviceID, const bool \*\*isSupported, uint32_t \*opCount) | 查询硬件对模型内所有算子的支持情况，通过布尔值序列指示支持情况。 | +| [OH_NNCompilation_Construct](#oh_nncompilation_construct) (const OH_NNModel \*model) | 创建[OH_NNCompilation](#oh_nncompilation)类型的编译实例。 | +| [OH_NNCompilation_SetDevice](#oh_nncompilation_setdevice) (OH_NNCompilation \*compilation, size_t deviceID) | 指定模型编译和计算的硬件。 | +| [OH_NNCompilation_SetCache](#oh_nncompilation_setcache) (OH_NNCompilation \*compilation, const char \*cachePath, uint32_t version) | 设置编译后的模型缓存路径和缓存版本。 | +| [OH_NNCompilation_SetPerformanceMode](#oh_nncompilation_setperformancemode) (OH_NNCompilation \*compilation, OH_NN_PerformanceMode performanceMode) | 设置硬件的性能模式。 | +| [OH_NNCompilation_SetPriority](#oh_nncompilation_setpriority) (OH_NNCompilation \*compilation, OH_NN_Priority priority) | 设置模型计算的优先级。 | +| [OH_NNCompilation_EnableFloat16](#oh_nncompilation_enablefloat16) (OH_NNCompilation \*compilation, bool enableFloat16) | 是否以float16的浮点数精度计算。 | +| [OH_NNCompilation_Build](#oh_nncompilation_build) (OH_NNCompilation \*compilation) | 进行模型编译。 | +| [OH_NNCompilation_Destroy](#oh_nncompilation_destroy) (OH_NNCompilation \*\*compilation) | 释放Compilation对象。 | +| [OH_NNExecutor_Construct](#oh_nnexecutor_construct) (OH_NNCompilation \*compilation) | 创建[OH_NNExecutor](#oh_nnexecutor)类型的执行器实例。 | +| [OH_NNExecutor_SetInput](#oh_nnexecutor_setinput) (OH_NNExecutor \*executor, uint32_t inputIndex, const OH_NN_Tensor \*tensor, const void \*dataBuffer, size_t length) | 设置模型单个输入的数据。 | +| [OH_NNExecutor_SetOutput](#oh_nnexecutor_setoutput) (OH_NNExecutor \*executor, uint32_t outputIndex, void \*dataBuffer, size_t length) | 设置模型单个输出的缓冲区。 | +| [OH_NNExecutor_GetOutputShape](#oh_nnexecutor_getoutputshape) (OH_NNExecutor \*executor, uint32_t outputIndex, int32_t \*\*shape, uint32_t \*shapeLength) | 获取输出张量的维度信息。 | +| [OH_NNExecutor_Run](#oh_nnexecutor_run) (OH_NNExecutor \*executor) | 执行推理。 | +| [OH_NNExecutor_AllocateInputMemory](#oh_nnexecutor_allocateinputmemory) (OH_NNExecutor \*executor, uint32_t inputIndex, size_t length) | 在硬件上为单个输入申请共享内存。 | +| [OH_NNExecutor_AllocateOutputMemory](#oh_nnexecutor_allocateoutputmemory) (OH_NNExecutor \*executor, uint32_t outputIndex, size_t length) | 在硬件上为单个输出申请共享内存。 | +| [OH_NNExecutor_DestroyInputMemory](#oh_nnexecutor_destroyinputmemory) (OH_NNExecutor \*executor, uint32_t inputIndex, OH_NN_Memory \*\*memory) | 释放[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的输入内存。 | +| [OH_NNExecutor_DestroyOutputMemory](#oh_nnexecutor_destroyoutputmemory) (OH_NNExecutor \*executor, uint32_t outputIndex, OH_NN_Memory \*\*memory) | 释放[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的输出内存。 | +| [OH_NNExecutor_SetInputWithMemory](#oh_nnexecutor_setinputwithmemory) (OH_NNExecutor \*executor, uint32_t inputIndex, const OH_NN_Tensor \*tensor, const OH_NN_Memory \*memory) | 将[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的硬件共享内存，指定为单个输入使用的共享内存。 | +| [OH_NNExecutor_SetOutputWithMemory](#oh_nnexecutor_setoutputwithmemory) (OH_NNExecutor \*executor, uint32_t outputIndex, const OH_NN_Memory \*memory) | 将[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的硬件共享内存，指定为单个输出使用的共享内存。 | +| [OH_NNExecutor_Destroy](#oh_nnexecutor_destroy) (OH_NNExecutor \*\*executor) | 销毁执行器实例，释放执行器占用的内存。 | +| [OH_NNDevice_GetAllDevicesID](#oh_nndevice_getalldevicesid) (const size_t \*\*allDevicesID, uint32_t \*deviceCount) | 获取对接到 Neural Network Runtime 的硬件ID。 | +| [OH_NNDevice_GetName](#oh_nndevice_getname) (size_t deviceID, const char \*\*name) | 获取指定硬件的类型信息。 | +| [OH_NNDevice_GetType](#oh_nndevice_gettype) (size_t deviceID, OH_NN_DeviceType \*deviceType) | 获取指定硬件的类别信息。 | + + +## **类型定义说明** + + +### OH_NN_Memory + + +``` +typedef struct OH_NN_Memory OH_NN_Memory +``` + +**描述：** + +内存结构体。 + + +### OH_NN_QuantParam + + +``` +typedef struct OH_NN_QuantParam OH_NN_QuantParam +``` + +**描述：** + +量化信息。 + +在量化的场景中，32位浮点型数据根据以下公式量化为定点数据： + +![zh-cn_formulaimage_0000001460519245](figures/zh-cn_formulaimage_0000001460519245.png) + +其中s和z是量化参数，在OH_NN_QuanParam中通过scale和zeroPoint保存，r是浮点数，q是量化后的结果，q_min是量化后下界，q_max是量化后的上界，计算方式如下： + +![zh-cn_formulaimage_0000001460759081](figures/zh-cn_formulaimage_0000001460759081.png) + +![zh-cn_formulaimage_0000001460639441](figures/zh-cn_formulaimage_0000001460639441.png) + +clamp函数定义如下： + +![zh-cn_formulaimage_0000001410679330](figures/zh-cn_formulaimage_0000001410679330.png) + + +### OH_NN_Tensor + + +``` +typedef struct OH_NN_Tensor OH_NN_Tensor +``` + +**描述：** + +张量结构体。 + +通常用于构造模型图中的数据节点和算子参数，在构造张量时需要明确数据类型、维数、维度信息和量化信息。 + + +### OH_NN_UInt32Array + + +``` +typedef struct OH_NN_UInt32Array OH_NN_UInt32Array +``` + +**描述：** + +自定义的32位无符号整型数组类型。 + + +### OH_NNCompilation + + +``` +typedef struct OH_NNCompilation OH_NNCompilation +``` + +**描述：** + +Neural Network Runtime的编译器句柄。 + + +### OH_NNExecutor + + +``` +typedef struct OH_NNExecutor OH_NNExecutor +``` + +**描述：** + +Neural Network Runtime的执行器句柄。 + + +### OH_NNModel + + +``` +typedef struct OH_NNModel OH_NNModel +``` + +**描述：** + +Neural Network Runtime的模型句柄。 + + +## **枚举类型说明** + + +### OH_NN_DataType + + +``` +enum OH_NN_DataType +``` + +**描述：** + +Neural Network Runtime支持的数据类型。 + +| 枚举值 | 描述 | +| -------- | -------- | +| OH_NN_UNKNOWN | 张量数据类型未知。 | +| OH_NN_BOOL | 张量数据类型为bool。 | +| OH_NN_INT8 | 张量数据类型为int8。 | +| OH_NN_INT16 | 张量数据类型为int16。 | +| OH_NN_INT32 | 张量数据类型为int32。 | +| OH_NN_INT64 | 张量数据类型为int64。 | +| OH_NN_UINT8 | 张量数据类型为uint8。 | +| OH_NN_UINT16 | 张量数据类型为uint16。 | +| OH_NN_UINT32 | 张量数据类型为uint32。 | +| OH_NN_UINT64 | 张量数据类型为uint64。 | +| OH_NN_FLOAT16 | 张量数据类型为float16。 | +| OH_NN_FLOAT32 | 张量数据类型为float32。 | +| OH_NN_FLOAT64 | 张量数据类型为float64。 | + + +### OH_NN_DeviceType + + +``` +enum OH_NN_DeviceType +``` + +**描述：** + +Neural Network Runtime支持的设备类型。 + +| 枚举值 | 描述 | +| -------- | -------- | +| OH_NN_OTHERS | 不属于CPU、GPU、专用加速器的设备。 | +| OH_NN_CPU | CPU设备。 | +| OH_NN_GPU | GPU设备。 | +| OH_NN_ACCELERATOR | 专用硬件加速器。 | + + +### OH_NN_Format + + +``` +enum OH_NN_Format +``` + +**描述：** + +张量数据的排布类型。 + +| 枚举值 | 描述 | +| -------- | -------- | +| OH_NN_FORMAT_NONE | 当张量没有特定的排布类型（如标量或矢量）时，使用本枚举值。 | +| OH_NN_FORMAT_NCHW | 当张量按照NCHW的格式排布数据时，使用本枚举值。 | +| OH_NN_FORMAT_NHWC | 当张量按照NHWC的格式排布数据时，使用本枚举值。 | + + +### OH_NN_FuseType + + +``` +enum OH_NN_FuseType : int8_t +``` + +**描述：** + +Neural Network Runtime融合算子中激活函数的类型。 + +| 枚举值 | 描述 | +| -------- | -------- | +| OH_NN_FUSED_NONE | 未指定融合激活函数。 | +| OH_NN_FUSED_RELU | 融合relu激活函数。 | +| OH_NN_FUSED_RELU6 | 融合relu6激活函数。 | + + +### OH_NN_OperationType + + +``` +enum OH_NN_OperationType +``` + +**描述：** + +Neural Network Runtime支持算子的类型。 + +| 枚举值 | 描述 | +| -------- | -------- | +| OH_NN_OPS_ADD | 返回两个输入张量对应元素相加的和的张量。
输入：
- input1，第一个输入的张量，数据类型要求为布尔值或者数字。
- input2，第二个输入的张量，数据类型和形状需要和第一个输入保持一致。
参数：
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，input1和input2的和，数据形状与输入broadcast之后一样，数据类型与较高精度的输入精度一致 | +| OH_NN_OPS_AVG_POOL | 在输入张量上应用2D平均池化，仅支持NHWC格式的张量。支持int8量化输入。
如果输入中含有padMode参数：
输入：
- input，一个张量。
参数：
- kernelSize，用来取平均值的kernel大小，是一个长度为2的int数组[kernel_height，kernel_weight]， 第一个数表示kernel高度，第二个数表示kernel宽度。
- strides，kernel移动的距离，是一个长度为2的int数组[stride_height，stride_weight]， 第一个数表示高度上的移动步幅，第二个数表示宽度上的移动步幅。
- padMode，填充模式，int类型的可选值，0表示same，1表示valid，并且以最近邻的值填充。 same，输出的高度和宽度与input相同，填充总数将在水平和垂直方向计算，并在可能的情况下均匀分布到顶部 和底部、左侧和右侧。否则，最后一个额外的填充将从底部和右侧完成。 valid，输出的可能最大高度和宽度将在不填充的情况下返回。额外的像素将被丢弃。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
如果输入中含有padList参数：
输入：
- input，一个张量。
参数：
- kernelSize，用来取平均值的kernel大小，是一个长度为2的int数组[kernel_height，kernel_weight]， 第一个数表示kernel高度，第二个数表示kernel宽度。
- strides，kernel移动的距离，是一个长度为2的int数组[stride_height，stride_weight]， 第一个数表示高度上的移动步幅，第二个数表示宽度上的移动步幅。
- padList，input周围的填充，是一个长度为4的int数组[top，bottom，left，right]，并且以最近邻的值填充。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，对input进行平均池化后的结果。 | +| OH_NN_OPS_BATCH_NORM | 对一个张量进行batch normalization，对张量元素进行缩放和位移，缓解一批数据中潜在的covariate shift。
输入：
- input，一个n维的张量，要求形状为[N，...，C]，即第n维是通道数（channel）。
- scale，缩放因子的1D张量，用于缩放归一化的第一个张量。
- offset，用于偏移的1D张量，以移动到归一化的第一个张量。
- mean，总体均值的一维张量，仅用于推理；对于训练，必须为空。
- variance，用于总体方差的一维张量。仅用于推理；对于训练，必须为空。
参数：
- epsilon，数值稳定性的小附加值。
输出：
- output，n维输出张量，形状和数据类型与input一致。 | +| OH_NN_OPS_BATCH_TO_SPACE_ND | 将一个四维张量的batch维度按block_shape切分成小块，并将这些小块拼接到空间维度。
参数：
- input，输入张量，维将被切分，拼接回空间维度。
输出：
- blockSize，一个长度为2的数组[height_block，weight_block]，指定切分到空间维度上的block大小。
- crops，一个shape为(2，2)的二维数组[[crop0_start，crop0_end]，[crop1_start，crop1_end]]， 表示在output的空间维度上截掉部分元素。
输出：
- output，假设input的形状为(n，h，w，c)，output的形状为（n'，h'，w'，c'）： n' = n / (block_shape[0] \* block_shape[1]) h' = h \* block_shape[0] - crops[0][0] - crops[0][1] w' = w \* block_shape[1] - crops[1][0] - crops[1][1] c'= c | +| OH_NN_OPS_BIAS_ADD | 对给出的输入张量上的各个维度方向上的数据进行偏置。
输入：
- input，输入张量，可为2-5维度。
- bias，参数对应输入维度数量的偏移值。
输出：
- output，根据input中每个维度方向偏移后的结果。 | +| OH_NN_OPS_CAST | 对输入张量中的数据类型进行转换。
输入：
- input，输入张量。
- type，转换后的数据类型。
输出：
- output，转换后的张量。 | +| OH_NN_OPS_CONCAT | 在指定维度上连接张量。
输入：
- input：N个输入张量。
参数：
- axis，指定张量连接的维度。
输出：
- output，输出N个张量沿axis连接的结果。 | +| OH_NN_OPS_CONV2D | 二维卷积层。
如果输入中含有padMode参数：
输入：
- input，输入张量。
- weight，卷积的权重，要求weight排布为[outChannel，kernelHeight，kernelWidth，inChannel/group]， inChannel必须要能整除group。
- bias，卷积的偏置，是长度为[outChannel]的数组。在量化场景下，bias 参数不需要量化参数，其量化 版本要求输入 OH_NN_INT32 类型数据，实际量化参数由 input 和 weight 共同决定。
参数：
- stride，卷积核在height和weight上的步幅，是一个长度为2的int数组[strideHeight，strideWidth]。
- dilation，表示扩张卷积在height和weight上的扩张率，是一个长度为2的int数组[dilationHeight，dilationWidth]， 值必须大于或等于1，并且不能超过input的height和width。
- padMode，input的填充模式，支持same和valid，int类型，0表示same，1表示valid。 same，输出的高度和宽度与input相同，填充总数将在水平和垂直方向计算，并在可能的情况下均匀分布到顶部和底部、左侧 和右侧。否则，最后一个额外的填充将从底部和右侧完成。 Valid，输出的可能最大高度和宽度将在不填充的情况下返回。额外的像素将被丢弃。
- group，将input按in_channel分组，int类型。group等于1，这是常规卷积；group大于1且小于或等于in_channel，这是分组卷积。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
如果输入中含有padList参数：
输入：
- input，输入张量。
- weight，卷积的权重，要求weight排布为[outChannel，kernelHeight，kernelWidth，inChannel/group]， inChannel必须要能整除group。
- bias，卷积的偏置，是长度为[outChannel]的数组。在量化场景下，bias 参数不需要量化参数，其量化 版本要求输入 OH_NN_INT32 类型数据，实际量化参数由 input 和 weight 共同决定。
参数：
- stride，卷积核在height和weight上的步幅，是一个长度为2的int数组[strideHeight，strideWidth]。
- dilation，表示扩张卷积在height和weight上的扩张率，是一个长度为2的int数组[dilationHeight，dilationWidth]。 值必须大于或等于1，并且不能超过input的height和width。
- padList，input周围的填充，是一个长度为4的int数组[top，bottom，left，right]。
- group，将input按in_channel分组，int类型。 group等于1，这是常规卷积。 group等于in_channel，这是depthwiseConv2d，此时group==in_channel==out_channel。 group大于1且小于in_channel，这是分组卷积，out_channel==group。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，卷积计算结果。 | +| OH_NN_OPS_CONV2D_TRANSPOSE | 二维卷积转置。
如果输入中含有padMode参数：
输入：
- input，输入张量。
- weight，卷积的权重，要求weight排布为[outChannel，kernelHeight，kernelWidth，inChannel/group]， inChannel必须要能整除group。
- bias，卷积的偏置，是长度为[outChannel]的数组。在量化场景下，bias参数不需要量化参数，其量化 版本要求输入OH_NN_INT32类型数据，实际量化参数由input和weight共同决定。
- stride，卷积核在height和weight上的步幅，是一个长度为2的int数组[strideHeight，strideWidth]。
参数：
- dilation，表示扩张卷积在height和weight上的扩张率，是一个长度为2的int数组[dilationHeight，dilationWidth]。 值必须大于或等于1，并且不能超过input的height和width。
- padMode，input的填充模式，支持same和valid，int类型，0表示same，1表示valid。 same，输出的高度和宽度与input相同，填充总数将在水平和垂直方向计算，并在可能的情况下均匀分布到顶部和底部、左侧 和右侧。否则，最后一个额外的填充将从底部和右侧完成。 Valid，输出的可能最大高度和宽度将在不填充的情况下返回。额外的像素将被丢弃。
- group，将input按in_channel分组，int类型。group等于1，这是常规卷积；group大于1且小于或等于in_channel，这是分组卷积。
- outputPads，一个整数或元组/2 个整数的列表，指定沿输出张量的高度和宽度的填充量。可以是单个整数，用于为所 有空间维度指定相同的值。沿给定维度的输出填充量必须小于沿同一维度的步幅。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
如果输入中含有padList参数：
输入：
- input，输入张量。
- weight，卷积的权重，要求weight排布为[outChannel，kernelHeight，kernelWidth，inChannel/group]， inChannel必须要能整除group。
- bias，卷积的偏置，是长度为[outChannel]的数组。在量化场景下，bias 参数不需要量化参数，其量化 版本要求输入 OH_NN_INT32 类型数据，实际量化参数由 input 和 weight 共同决定。
参数：
- stride，卷积核在height和weight上的步幅，是一个长度为2的int数组[strideHeight，strideWidth]。
- dilation，表示扩张卷积在height和weight上的扩张率，是一个长度为2的int数组[dilationHeight，dilationWidth]。 值必须大于或等于1，并且不能超过input的height和width。
- padList，input周围的填充，是一个长度为4的int数组[top，bottom，left，right]。
- group，将input按in_channel分组，int类型。group等于1，这是常规卷积；group大于1且小于或等于in_channel，这是分组卷积。
- outputPads，一个整数或元组/2 个整数的列表，指定沿输出张量的高度和宽度的填充量。可以是单个整数，用于为所 有空间维度指定相同的值。沿给定维度的输出填充量必须小于沿同一维度的步幅。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，卷积转置后的计算结果。 | +| OH_NN_OPS_DEPTHWISE_CONV2D_NATIVE | 二维深度可分离卷积。
如果输入中含有padMode参数：
输入：
- input，输入张量。
- weight，卷积的权重，要求weight排布为[outChannel，kernelHeight，kernelWidth，1]，outChannel = channelMultiplier \* inChannel。
- bias，卷积的偏置，是长度为[outChannel]的数组。在量化场景下，bias 参数不需要量化参数，其量化 版本要求输入 OH_NN_INT32 类型数据，实际量化参数由 input 和 weight 共同决定。
参数：
- stride，卷积核在height和weight上的步幅，是一个长度为2的int数组[strideHeight，strideWidth]。
- dilation，表示扩张卷积在height和weight上的扩张率，是一个长度为2的int数组[dilationHeight，dilationWidth]。 值必须大于或等于1，并且不能超过input的height和width。
- padMode，input的填充模式，支持same和valid，int类型，0表示same，1表示valid same，输出的高度和宽度与input相同，填充总数将在水平和垂直方向计算，并在可能的情况下均匀分布到顶部和底部、左侧 和右侧。否则，最后一个额外的填充将从底部和右侧完成 Valid，输出的可能最大高度和宽度将在不填充的情况下返回。额外的像素将被丢弃
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
如果输入中含有padList 参数：
输入：
- input，输入张量。
- weight，卷积的权重，要求weight排布为[outChannel，kernelHeight，kernelWidth，1]，outChannel = channelMultiplier \* inChannel。
- bias，卷积的偏置，是长度为[outChannel]的数组。在量化场景下，bias参数不需要量化参数，其量化 版本要求输入 OH_NN_INT32 类型数据，实际量化参数由 input和weight共同决定。
参数：
- stride，卷积核在height和weight上的步幅，是一个长度为2的int数组[strideHeight，strideWidth]。
- dilation，表示扩张卷积在height和weight上的扩张率，是一个长度为2的int数组[dilationHeight，dilationWidth]。 值必须大于或等于1，并且不能超过input的height和width。
- padList，input周围的填充，是一个长度为4的int数组[top，bottom，left，right]。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，卷积计算的结果。 | +| OH_NN_OPS_DIV | 对输入的两个标量或张量做除法。
输入：
- input1，第一个输入是标量或布尔值或数据类型为数字或布尔值的张量。
- input2，数据类型根据input1的类型，要求有所不同： 当第一个输入是张量时，第二个输入可以是实数或布尔值或数据类型为实数/布尔值的张量。 当第一个输入是实数或布尔值时，第二个输入必须是数据类型为实数/布尔值的张量。
参数：
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，input1和input2相除的结果。 | +| OH_NN_OPS_ELTWISE | 设置参数对输入进行product(点乘)、sum(相加减)或max(取大值)。
输入：
- input1，第一个输入张量。
- input2，第二个输入张量。
参数：
- mode，枚举，选择操作方式。
输出：
- output，计算后的结果，output和input1拥有相同的数据类型和形状。 | +| OH_NN_OPS_EXPAND_DIMS | 在给定维度上为张量添加一个额外的维度。
输入：
- input，输入张量。
- axis，需要添加的维度的index，int32_t类型，值必须在[-dim-1，dim]，且只允许常量值。
输出：
- output，维度拓展后的张量。 | +| OH_NN_OPS_FILL | 根据指定的形状，创建由一个标量填充的张量。
输入：
- value，填充的标量。
- shape，指定创建张量的形状。
输出：
- output，生成的张量，和value具有相同的数据类型，张量形状由shape参数指定。 | +| OH_NN_OPS_FULL_CONNECTION | 全连接，整个输入作为feature map，进行特征提取。
输入：
- input，全连接的输入张量。
- weight，全连接的权重张量。
- bias，全连接的偏置，在量化场景下，bias参数不需要量化参数，其量化版本要求输入OH_NN_INT32 类型数据，实际量化参数由input和weight共同决定。
参数：
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，输出运算后的张量。
如果输入中含有axis参数：
输入：
- input，全连接的输入张量。
- weight，全连接的权重张量。
- bias，全连接的偏置，在量化场景下，bias参数不需要量化参数，其量化版本要求输入 OH_NN_INT32 类型数据，实际量化参数由input和weight共同决定。
参数：
- axis，input做全连接的轴，从指定轴axis开始，将axis和axis后面的轴展开成一维去做全连接
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，输出运算后的张量。 | +| OH_NN_OPS_GATHER | 根据指定的索引和轴返回输入张量的切片。
输入：
- input，输入待切片的张量。
- inputIndices，指定input在axis上的索引，是一个int类型的数组，值必须在[0，input.shape[axis])范围内
- axis，input被切片的轴，int32_t类型的数组，数组长度为1。
输出：
- output，输出切片后的张量。 | +| OH_NN_OPS_HSWISH | 计算输入的Hswish激活值。
输入：
- input，一个n维输入张量。
输出：
- output，n维Hswish激活值，数据类型和shape和input一致。 | +| OH_NN_OPS_LESS_EQUAL | 对input1和input2，计算每对元素的input1[i]<=input2[i]的结果，i是输入张量中每个元素的索引。
输入：
- input1，可以是实数、布尔值或数据类型是实数/NN_BOOL的张量。
- input2，如果input1是张量，input2可以是实数、布尔值，否则只能是张量，其数据类型是实数或NN_BOOL。
输出：
- 张量，数据类型为NN_BOOL的张量，使用量化模型时，output的量化参数不可省略，但量化参数的数值不会对输入结果产生影响。 | +| OH_NN_OPS_MATMUL | 计算input1和input2的内积。
输入：
- input1，n维输入张量。
- input2，n维输入张量。
参数：
- TransposeX，布尔值，是否对input1进行转置。
- TransposeY，布尔值，是否对input2进行转置。
输出：
- output，计算得到内积，当type!=NN_UNKNOWN时，output数据类型由type决定；当type==NN_UNKNOWN时， output的数据类型取决于input1和input2进行计算时转化的数据类型。 | +| OH_NN_OPS_MAXIMUM | 计算input1和input2对应元素最大值，input1和input2的输入遵守隐式类型转换规则，使数据类型一致。输入必须是两个张量或一个张量和一个标量。当输入是两个张量时，它们的数据类型不能同时为NN_BOOL。它们的形状支持broadcast成相同的大小。当输入是一个张量和一个标量时，标量只能是一个常数。
输入：
- input1，n维输入张量，实数或NN_BOOL类型。
- input2，n维输入张量，实数或NN_BOOL类型。
输出：
- output，n维输出张量，output的shape和数据类型和两个输入张量中精度或者位数高的相同。 | +| OH_NN_OPS_MAX_POOL | 在输入张量上应用2D最大值池化。
如果输入中含有padMode参数：
输入：
- input，一个张量。
参数：
- kernelSize，用来取最大值的kernel大小，是一个长度为2的int数组[kernel_height，kernel_weight]， 第一个数表示kernel高度，第二个数表示kernel宽度。
- strides，kernel移动的距离，是一个长度为2的int数组[stride_height，stride_weight]， 第一个数表示高度上的移动步幅，第二个数表示宽度上的移动步幅。
- padMode，填充模式，int类型的可选值，0表示same，1表示valid，并且以最近邻的值填充。 same，输出的高度和宽度与input相同，填充总数将在水平和垂直方向计算，并在可能的情况下均匀分布到顶部 和底部、左侧和右侧。否则，最后一个额外的填充将从底部和右侧完成。 valid，输出的可能最大高度和宽度将在不填充的情况下返回。额外的像素将被丢弃。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
如果输入中含有padList参数：
输入：
- input，一个张量。
参数：
- kernelSize，用来取最大值的kernel大小，是一个长度为2的int数组[kernel_height，kernel_weight]， 第一个数表示kernel高度，第二个数表示kernel宽度。
- strides，kernel移动的距离，是一个长度为2的int数组[stride_height，stride_weight]， 第一个数表示高度上的移动步幅，第二个数表示宽度上的移动步幅。
- padList，input周围的填充，是一个长度为4的int数组[top，bottom，left，right]，并且以最近邻的值填充。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，对input最大值池化后的张量。 | +| OH_NN_OPS_MUL | 将input1和input2相同的位置的元素相乘得到output。如果input1和input2类型shape不同，要求input1和input2可以通过broadcast扩充成相同的shape进行相乘。
输入：
- input1，一个n维张量。
- input2，一个n维张量。
参数：
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，input1和input2每个元素的乘积。 | +| OH_NN_OPS_ONE_HOT | 根据indices指定的位置，生成一个由one-hot向量构成的张量。每个onehot向量中的有效值由on_value决定，其他位置由off_value决定。
输入：
- indices，n维张量。indices中每个元素决定每个one-hot向量，on_value的位置
- depth，一个整型标量，决定one-hot向量的深度。要求depth>0。
- on_value，一个标量，指定one-hot向量中的有效值。
- off_value，一个标量，指定one-hot向量中除有效位以外，其他位置的值。
参数：
- axis，一个整型标量，指定插入one-hot的维度。 indices的形状是[N，C]，depth的值是D，当axis=0时，output形状为[D，N，C]， indices的形状是[N，C]，depth的值是D，当axis=-1时，output形状为[N，C，D]， indices的形状是[N，C]，depth的值是D，当axis=1时，output形状为[N，D，C]。
输出：
- output，如果indices时n维张量，则output是(n+1)维张量。output的形状由indices和axis共同决定。 | +| OH_NN_OPS_PAD | 在input1指定维度的数据前后，添加指定数值进行增广。
输入：
- input，一个n维张量，要求input1的排布为[BatchSize，…]。
- paddings，一个二维张量，指定每一维度增补的长度，shape为[n，2]。paddings[i][0]表示第i维上，需要在input前增补的数量； paddings[i][1]表示第i维上，需要在inputX后增补的数量。
参数：
- padValues，一个常数，数据类型和input一致，指定Pad操作补全的数值。
输出：
- output，一个n维张量，维数和数据类型和input保持一致。shape由input和paddings共同决定 output.shape[i] = input.shape[i] + paddings[i][0]+paddings[i][1]。 | +| OH_NN_OPS_POW | 求input的y次幂，输入必须是两个张量或一个张量和一个标量。当输入是两个张量时，它们的数据类型不能同时为NN_BOOL， 且要求两个张量的shape相同。当输入是一个张量和一个标量时，标量只能是一个常数。
输入：
- input，实数、bool值或张量，张量的数据类型为实数/NN_BOOL。
- y，实数、bool值或张量，张量的数据类型为实数/NN_BOOL。
输出：
- output，形状由input和y通过broadcast后的形状决定。 | +| OH_NN_OPS_SCALE | 给定一个张量，计算其缩放后的值。
输入：
- input，一个n维张量。
- scale，缩放张量。
- bias，偏置张量。
参数：
- axis，指定缩放的维度。
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，scale的计算结果，一个n维张量，类型和input一致，shape由axis决定。 | +| OH_NN_OPS_SHAPE | 输入一个张量，计算其shape。
输入：
- input，一个n维张量。
输出：
- output，输出张量的维度，一个整型数组。 | +| OH_NN_OPS_SIGMOID | 给定一个张量，计算其sigmoid结果。
输入：
- input，一个n维张量。
输出：
- output，sigmoid的计算结果，一个n维张量，类型和shape和input一致。 | +| OH_NN_OPS_SLICE | 在输入张量的各个维度，以begin为起点，截取size长度的切片。
输入：
- input，n维输入张量。
- begin，一组不小于0的整数，指定每个维度上的起始切分点。
- size，一组不小于1的整数，指定每个维度上切片的长度。假设某一维度i，1<=size[i]<=input.shape[i]-begin[i]。
输出：
- output，切片得到的n维张量，其TensorType和input一致，shape和size相同。 | +| OH_NN_OPS_SOFTMAX | 给定一个张量，计算其softmax结果。
输入：
- input，n维输入张量。
参数：
- axis，int64类型，指定计算softmax的维度。整数取值范围为[-n，n)。
输出：
- output，softmax的计算结果，一个n维张量，类型和shape和input一致。 | +| OH_NN_OPS_SPACE_TO_BATCH_ND | 将四维张量在空间维度上进行切分成blockShape[0] \* blockShape[1]个小块，然后在batch维度上拼接这些小块。
输入：
- input，一个四维张量
参数：
- blockShape，一对整数，每个整数不小于1。
- paddings，一对数组，每个数组由两个整数组成。组成paddings的4个整数都不小于0。paddings[0][0]和paddings[0][1]指 定了第三个维度上padding的数量，paddings[1][0]和paddings[1][1]指定了第四个维度上padding的数量。
输出：
- output，一个四维张量，数据类型和input一致。shape由input，blockShape和paddings共同决定，假设input shape为[n，c，h，w]，则有 output.shape[0] = n \* blockShape[0] \* blockShape[1] output.shape[1] = c output.shape[2] = (h + paddings[0][0] + paddings[0][1]) / blockShape[0] output.shape[3] = (w + paddings[1][0] + paddings[1][1]) / blockShape[1] 要求(h + paddings[0][0] + paddings[0][1])和(w + paddings[1][0] + paddings[1][1])能被 blockShape[0]和blockShape[1]整除。 | +| OH_NN_OPS_SPLIT | Split算子沿axis维度将input拆分成多个张量，张量数量由outputNum指定。
输入：
- input，n维张量。
参数：
- outputNum，long，输出张量的数量，output_num类型为int。
- size_splits，一维张量，指定张量沿axis轴拆分后，每个张量的大小，size_splits 类型为 int。 如果size_splits的数据为空，则张量被拆分成大小均等的张量，此时要求input.shape[axis]可以被outputNum整除； 如果size_splits不为空，则要求 size_splits所有元素之和等于input.shape[axis]。
- axis，指定拆分的维度，axis类型为int。
输出：
- outputs，一组n维张量，每一个张量类型和shape相同，每个张量的类型和input一致。 | +| OH_NN_OPS_SQRT | 给定一个张量，计算其平方根。
输入：
- input，一个n维张量。
输出：
- output，输入的平方根，一个n维张量，类型和shape和input一致。 | +| OH_NN_OPS_SQUARED_DIFFERENCE | 计算两个输入的差值并返回差值的平方。SquaredDifference算子支持张量和张量相减。 如果两个张量的TensorType不相同，Sub算子会将低精度的张量转成更高精度的类型。 如果两个张量的shape不同，要求两个张量可以通过broadcast拓展成相同shape的张量。
输入：
- input1，被减数，input1是一个张量，张量的类型可以是NN_FLOAT16、NN_FLOAT32、NN_INT32或NN_BOOL。
- input2，减数，input2是一个张量，张量的类型可以是NN_FLOAT16、NN_FLOAT32、NN_INT32或NN_BOOL。
输出：
- output，两个输入差值的平方。output的shape由input1和input2共同决定，input1和input2的shape相同时， output的shape和input1、input2相同；shape不同时，需要将input1或input2做broadcast操作后，相减得到output。 output的TensorType由两个输入中更高精度的TensorType决定。 | +| OH_NN_OPS_SQUEEZE | 去除axis中，长度为1的维度。支持int8量化输入假设input的shape为[2，1，1，2，2]，axis为[0,1]， 则output的shape为[2，1，2，2]。第0维到第一维之间，长度为0的维度被去除。
输入：
- input，n维张量。
参数：
- axis，指定删除的维度。axis可以是一个int64_t的整数或数组，整数的取值范围为[-n，n)。
输出：
- output，输出张量。 | +| OH_NN_OPS_STACK | 将一组张量沿axis维度进行堆叠，堆叠前每个张量的维数为n，则堆叠后output维数为n+1。
输入：
- input，Stack支持传入多个输入n维张量，每个张量要求shape相同且类型相同。
参数：
- axis，一个整数，指定张量堆叠的维度。axis可以是负数，axis取值范围为[-(n+1)，(n+1))。
输出：
- output，将input沿axis维度堆叠的输出，n+一维张量，TensorType和input相同。 | +| OH_NN_OPS_STRIDED_SLICE | 跨步截取张量。
输入：
- input，n维输入张量。
- begin，一维张量，begin的长度等于n，begin[i]指定第i维上截取的起点。
- end，一维张量，end的长度等于n，end[i]指定第i维上截取的终点。
- strides，一维张量，strides的长度等于n，strides[i]指定第i维上截取的步长。
参数：
- beginMask，一个整数，用于解除begin的限制。将beginMask转成二进制表示，如果binary(beginMask)[i]==1， 则对于第i维，从第一个元素开始，以strides[i]为步长截取元素直到第end[i]-1个元素。
- endMask，个整数，用于解除end的限制。将endMask转成二进制表示，如果binary(endMask)[i]==1，则对于第i维， 从第begin[i]个元素起，以strides[i]为步长截取元素直到张量边界。
- ellipsisMask，一个整数，用于解除begin和end的限制。将ellipsisMask转成二进制表示，如果binary(ellipsisMask)[i]==1， 则对于第i维，从第一个元素开始，以strides[i]为补偿，截取元素直到张量边界。binary(ellipsisMask)仅允许有一位不为0。
- newAxisMask，一个整数，用于新增维度。将newAxisMask转成二进制表示，如果binary(newAxisMask)[i]==1，则在第i维插入长度为1的新维度。
- shrinkAxisMask，一个整数，用于压缩指定维度。将shrinkAxisMask转成二进制表示，如果binary(shrinkAxisMask)[i]==1， 则舍去第i维所有元素，第i维长度压缩至1。
输出：
- 堆叠运算后的张量，数据类型与input相同。输出维度rank(input[0])+1 维。 | +| OH_NN_OPS_SUB | 计算两个输入的差值。
输入：
- input1，一个张量，作为减法中的被减数。
- input2，一个张量，作为减法中的减数。
参数：
- activationType，是一个整型常量，且必须是FuseType中含有的值。 在输出之前调用指定的激活。
输出：
- output，两个输入相减的差。output的shape由input1和input2共同决定，当input1和input2的shape相同时，output的shape和input1、input2相同； shape不同时，需要将input1或input2做broadcast操作后，相减得到output。output的TensorType由两个输入中更高精度的TensorType决定。 | +| OH_NN_OPS_TANH | 计算输入张量的双曲正切值。
输入：
- input，n维张量。
输出：
- output，input的双曲正切，TensorType和张量shape和input相同。 | +| OH_NN_OPS_TILE | 以multiples指定的次数拷贝输入。
输入：
- input，n维张量。
- multiples，一维张量，指定各个维度拷贝的次数。其长度m不小于input的维数n。
输出：
- 张量，m维张量，TensorType与input相同。如果input和multiples长度相同， 则output和input维数一致，都是n维张量；如果multiples长度大于n，则用1填充input的维度， 再在各个维度上拷贝相应的次数，得到m维张量。 | +| OH_NN_OPS_TRANSPOSE | 根据permutation对input进行数据重排。
输入：
- input，n维张量，待重排的张量。
- perm，一维张量，其长度和input的维数一致。
输出：
- output，n维张量，output的TensorType与input相同，shape由input的shape和permutation共同决定。 | +| OH_NN_OPS_REDUCE_MEAN | keepDims为false时，计算指定维度上的平均值，减少input的维数；当keepDims为true时，计算指定维度上的平均值，保留相应的维度。
输入：
- input，n维输入张量，n<8。
- axis，一维张量，指定计算均值的维度，axis中每个元素的取值范围为[-n，n)。
参数：
- keepDims，布尔值，是否保留维度的标志位。
输出：
- output，m维输出张量，数据类型和input相同。当keepDims为false时，m==n；当keepDims为true时，m<n。 | +| OH_NN_OPS_RESIZE_BILINEAR | 采用Bilinear方法，按给定的参数对input进行变形。
输入：
- input，四维输入张量，input中的每个元素不能小于0。input排布必须是[batchSize，height，width，channels]。
参数：
- newHeight，resize之后四维张量的height值。
- newWidth，resize之后四维张量的width值。
- preserveAspectRatio，一个布尔值，指示resize操作是否保持input的height/width比例。
- coordinateTransformMode，一个int32整数，指示Resize操作所使用的坐标变换方法，目前支持以下方法：
- excludeOutside，一个int64浮点数。当excludeOutside=1时，超出input边界的采样权重被置为0,其余权重重新归一化处理。
输出：
- output，n维输出张量，output的shape和数据类型和input相同。 | +| OH_NN_OPS_RSQRT | 求input平方根的倒数。
输入：
- input，n维输入张量，input中的每个元素不能小于0，n<8。
输出：
- output，n维输出张量，output的shape和数据类型和input相同。 | +| OH_NN_OPS_RESHAPE | 根据inputShape调整input的形状。
输入：
- input，一个n维输入张量。
- InputShape，一个一维张量，表示输出张量的shape，需要是一个常量张量。
输出：
- output，输出张量，数据类型和input一致，shape由inputShape决定。 | +| OH_NN_OPS_PRELU | 计算input和weight的PReLU激活值。
输入：
- input，一个n维张量，如果n>=2，则要求input的排布为[BatchSize，…，Channels]，第二个维度为通道数。
- output，input的PReLU激活值。形状和数据类型和input保持一致。 | +| OH_NN_OPS_RELU | 计算input的Relu激活值。
输入：
- input，一个n维输入张量。
输出：
- output，n维Relu输出张量，数据类型和shape和input一致。 | +| OH_NN_OPS_RELU6 | 计算input的Relu6激活值，即对input中每个元素x，计算min(max(x，0)，6)。
输入：
- input，一个n维输入张量。
输出：
- output，n维Relu6输出张量，数据类型和shape和input一致。 | +| OH_NN_OPS_LAYER_NORM | 对一个张量从某一axis开始做层归一化。
输入：
- input，一个n维输入张量。
- gamma，一个m维张量，gamma维度应该与input做归一化部分的shape一致。
- beta，一个m维张量，shape与gamma一样。
参数：
- beginAxis，是一个NN_INT32的标量，指定开始做归一化的轴，取值范围是[1，rank(input))。
- epsilon，是一个NN_FLOAT32的标量，是归一化公式中的微小量，常用值是1e-7。
输出：
- output，n维输出张量，数据类型和shape和input一致。 | +| OH_NN_OPS_REDUCE_PROD | 沿着axis指定的维度，计算input的累积。
输入：
- input，n维输入张量，n<8。
- axis，一维张量，指定计算乘的维度，axis中每个元素的取值范围为[-n，n)。
参数：
- keepDims，布尔值，是否保留维度的标志位。当keepDims为true时，output的维数和input保持一致；当keepDims为false时，output的维数缩减。
输出：
- output，m维输出张量，数据类型和input相同。当keepDims为false时，m==n；当keepDims为true时，m<n。 | +| OH_NN_OPS_REDUCE_ALL | 当keepDims为false时，计算指定维度上的逻辑与，减少input的维数；当keepDims为true时，计算指定维度上的逻辑与，保留相应的维度。
输入：
- input，n维输入张量，n<8。
- axis，一维张量，指定计算逻辑与的维度，axis中每个元素的取值范围为[-n，n)。
参数：
- keepDims，布尔值，是否保留维度的标志位。
输出：
- output，m维输出张量，数据类型和input相同。当keepDims为false时，m==n；当keepDims为true时，m<n。 | +| OH_NN_OPS_QUANT_DTYPE_CAST | 数据类型转换。
输入：
- input，n维张量。
参数：
- src_t，定义输入的数据类型。
- dst_t，定义输出的数据类型。
输出：
- output，n维张量，数据类型由input决定，输出的形状和输入相同。 | +| OH_NN_OPS_TOP_K | 查找沿最后一个维度的k个最大条目的值和索引。
输入：
- input，n维张量。
- k，指明是得到前k个数据以及其index。
参数：
- sorted，如果为True，按照大到小排序，如果为False，按照小到大排序。
输出：
- output0，最后一维的每个切片中的k个最大元素。
- output1，输入的最后一个维度内的值的索引。 | +| OH_NN_OPS_ARG_MAX | 返回跨轴的张量最大值的索引。
输入：
- input，n维张量，输入张量(N，∗)，其中∗意味着任意数量的附加维度。
参数：
- axis，指定求最大值索引的维度。
- keep_dims，bool值，是否维持输入张量维度。
输出：
- output，张量，轴上输入张量最大值的索引。 | +| OH_NN_OPS_UNSQUEEZE | 根据输入axis的值，增加一个维度。
输入：
- input，n维张量。
参数：
- axis，指定增加的维度。axis可以是一个整数或一组整数，整数的取值范围为[-n，n)。
输出：
- output，输出张量。 | +| OH_NN_OPS_GELU | 高斯误差线性单元激活函数。output=0.5∗input∗(1+tanh(input/2))，不支持int量化输入。
输入：
- input，一个n维输入张量。
输出：
- output，n维Relu输出张量，数据类型和shape和input一致。 | + + +### OH_NN_PerformanceMode + + +``` +enum OH_NN_PerformanceMode +``` + +**描述：** + +硬件的性能模式。 + +| 枚举值 | 描述 | +| -------- | -------- | +| OH_NN_PERFORMANCE_NONE | 无性能模式偏好。 | +| OH_NN_PERFORMANCE_LOW | 低能耗模式。 | +| OH_NN_PERFORMANCE_MEDIUM | 中性能模式。 | +| OH_NN_PERFORMANCE_HIGH | 高性能模式。 | +| OH_NN_PERFORMANCE_EXTREME | 极致性能模式。 | + + +### OH_NN_Priority + + +``` +enum OH_NN_Priority +``` + +**描述：** + +模型推理任务优先级。 + +| 枚举值 | 描述 | +| -------- | -------- | +| OH_NN_PRIORITY_NONE | 无优先级偏好。 | +| OH_NN_PRIORITY_LOW | 低优先级。 | +| OH_NN_PRIORITY_MEDIUM | 中优先级。 | +| OH_NN_PRIORITY_HIGH | 高优先级。 | + + +### OH_NN_ReturnCode + + +``` +enum OH_NN_ReturnCode +``` + +**描述：** + +Neural Network Runtime定义的错误码类型。 + +| 枚举值 | 描述 | +| -------- | -------- | +| OH_NN_SUCCESS | 操作成功。 | +| OH_NN_FAILED | 操作失败。 | +| OH_NN_INVALID_PARAMETER | 非法参数。 | +| OH_NN_MEMORY_ERROR | 内存相关的错误，包括：内存不足、内存数据拷贝失败、内存申请失败等。 | +| OH_NN_OPERATION_FORBIDDEN | 非法操作。 | +| OH_NN_NULL_PTR | 空指针异常。 | +| OH_NN_INVALID_FILE | 无效文件。 | +| OH_NN_UNAVALIDABLE_DEVICE | 硬件发生错误，错误可能包含：HDL服务崩溃。 | +| OH_NN_INVALID_PATH | 非法路径。 | + + +### OH_NN_TensorType + + +``` +enum OH_NN_TensorType +``` + +**描述：** + +张量的类型。 + +张量通常用于设置模型的输入、输出和算子参数。 + +作为模型（或算子）的输入和输出时，需要将张量类型设置为OH_NN_TENSOR；当张量作为算子参数时，需要选择除OH_NN_TENSOR以外合适的枚举值，作为张量的类型。 + +假设正在设置OH_NN_OPS_CONV2D算子的pad参数，则需要将 [OH_NN_Tensor](_o_h___n_n___tensor.md)实例的type属性设置为OH_NN_CONV2D_PAD。 + +其他算子参数的设置以此类推，枚举值的命名遵守OH\_NN\_{算子名称}\_{属性名}的格式。 + +| 枚举值 | 描述 | +| -------- | -------- | +| OH_NN_TENSOR | 当张量作为模型（或算子）的输入或输出时，使用本枚举值。 | +| OH_NN_ADD_ACTIVATIONTYPE | 当张量作为Add算子的activationType参数时，使用本枚举值。 | +| OH_NN_AVG_POOL_KERNEL_SIZE | 当张量作为AvgPool算子的kernel_size参数时，使用本枚举值。 | +| OH_NN_AVG_POOL_STRIDE | 当张量作为AvgPool算子的stride参数时，使用本枚举值。 | +| OH_NN_AVG_POOL_PAD_MODE | 当张量作为AvgPool算子的pad_mode参数时，使用本枚举值。 | +| OH_NN_AVG_POOL_PAD | 当张量作为AvgPool算子的pad参数时，使用本枚举值。 | +| OH_NN_AVG_POOL_ACTIVATION_TYPE | 当张量作为AvgPool算子的activation_type参数时，使用本枚举值。 | +| OH_NN_BATCH_NORM_EPSILON | 当张量作为BatchNorm算子的eosilon参数时，使用本枚举值。 | +| OH_NN_BATCH_TO_SPACE_ND_BLOCKSIZE | 当张量作为BatchToSpaceND算子的blockSize参数时，使用本枚举值。 | +| OH_NN_BATCH_TO_SPACE_ND_CROPS | 当张量作为BatchToSpaceND算子的crops参数时，使用本枚举值。 | +| OH_NN_CONCAT_AXIS | 当张量作为Concat算子的axis参数时，使用本枚举值。 | +| OH_NN_CONV2D_STRIDES | 当张量作为Conv2D算子的strides参数时，使用本枚举值。 | +| OH_NN_CONV2D_PAD | 当张量作为Conv2D算子的pad参数，使用本枚举值。 | +| OH_NN_CONV2D_DILATION | 当张量作为Conv2D算子的dilation参数时，使用本枚举值。 | +| OH_NN_CONV2D_PAD_MODE | 当张量作为Conv2D算子的padMode参数时，使用本枚举值。 | +| OH_NN_CONV2D_ACTIVATION_TYPE | 当张量作为Conv2D算子的activationType参数时，使用本枚举值。 | +| OH_NN_CONV2D_GROUP | 当张量作为Conv2D算子的group参数时，使用本枚举值。 | +| OH_NN_CONV2D_TRANSPOSE_STRIDES | 当张量作为Conv2DTranspose算子的strides参数时，使用本枚举值。 | +| OH_NN_CONV2D_TRANSPOSE_PAD | 当张量作为Conv2DTranspose算子的pad参数时，使用本枚举值。 | +| OH_NN_CONV2D_TRANSPOSE_DILATION | 当张量作为Conv2DTranspose算子的dilation参数时，使用本枚举值。 | +| OH_NN_CONV2D_TRANSPOSE_OUTPUT_PADDINGS | 当张量作为Conv2DTranspose算子的outputPaddings参数时，使用本枚举值。 | +| OH_NN_CONV2D_TRANSPOSE_PAD_MODE | 当张量作为Conv2DTranspose算子的padMode参数时，使用本枚举值。 | +| OH_NN_CONV2D_TRANSPOSE_ACTIVATION_TYPE | 当张量作为Conv2DTranspose算子的activationType参数时，使用本枚举值。 | +| OH_NN_CONV2D_TRANSPOSE_GROUP | 当张量作为Conv2DTranspose算子的group参数时，使用本枚举值。 | +| OH_NN_DEPTHWISE_CONV2D_NATIVE_STRIDES | 当张量作为DepthwiseConv2dNative算子的strides参数时，使用本枚举值。 | +| OH_NN_DEPTHWISE_CONV2D_NATIVE_PAD | 当张量作为DepthwiseConv2dNative算子的pad参数时，使用本枚举值。 | +| OH_NN_DEPTHWISE_CONV2D_NATIVE_DILATION | 当张量作为DepthwiseConv2dNative算子的dilation参数时，使用本枚举值。 | +| OH_NN_DEPTHWISE_CONV2D_NATIVE_PAD_MODE | 当张量作为DepthwiseConv2dNative算子的padMode参数时，使用本枚举值。 | +| OH_NN_DEPTHWISE_CONV2D_NATIVE_ACTIVATION_TYPE | 当张量作为DepthwiseConv2dNative算子的activationType参数时，使用本枚举值。 | +| OH_NN_DIV_ACTIVATIONTYPE | 当张量作为Div算子的activationType参数时，使用本枚举值。 | +| OH_NN_ELTWISE_MODE | 当张量作为Eltwise算子的mode参数时，使用本枚举值。 | +| OH_NN_FULL_CONNECTION_AXIS | 当张量作为FullConnection算子的axis参数时，使用本枚举值。 | +| OH_NN_FULL_CONNECTION_ACTIVATIONTYPE | 当张量作为FullConnection算子的activationType参数时，使用本枚举值。 | +| OH_NN_MATMUL_TRANSPOSE_A | 当张量作为Matmul算子的transposeA参数时，使用本枚举值。 | +| OH_NN_MATMUL_TRANSPOSE_B | 当张量作为Matmul算子的transposeB参数时，使用本枚举值。 | +| OH_NN_MATMUL_ACTIVATION_TYPE | 当张量作为Matmul算子的activationType参数时，使用本枚举值。 | +| OH_NN_MAX_POOL_KERNEL_SIZE | 当张量作为MaxPool算子的kernel_size参数时，使用本枚举值。 | +| OH_NN_MAX_POOL_STRIDE | 当张量作为MaxPool算子的stride参数时，使用本枚举值。 | +| OH_NN_MAX_POOL_PAD_MODE | 当张量作为MaxPool算子的pad_mode参数时，使用本枚举值。 | +| OH_NN_MAX_POOL_PAD | 当张量作为MaxPool算子的pad参数时，使用本枚举值。 | +| OH_NN_MAX_POOL_ACTIVATION_TYPE | 当张量作为MaxPool算子的activation_type参数时，使用本枚举值。 | +| OH_NN_MUL_ACTIVATION_TYPE | 当张量作为Mul算子的activationType参数时，使用本枚举值。 | +| OH_NN_ONE_HOT_AXIS | 当张量作为OneHot算子的axis参数时，使用本枚举值。 | +| OH_NN_PAD_CONSTANT_VALUE | 当张量作为Pad算子的constant_value参数时，使用本枚举值。 | +| OH_NN_SCALE_ACTIVATIONTYPE | 当张量作为Scale算子的activationType参数时，使用本枚举值。 | +| OH_NN_SCALE_AXIS | 当张量作为Scale算子的axis参数时，使用本枚举值。 | +| OH_NN_SOFTMAX_AXIS | 当张量作为Softmax算子的axis参数时，使用本枚举值。 | +| OH_NN_SPACE_TO_BATCH_ND_BLOCK_SHAPE | 当张量作为SpaceToBatchND算子的BlockShape参数时，使用本枚举值。 | +| OH_NN_SPACE_TO_BATCH_ND_PADDINGS | 当张量作为SpaceToBatchND算子的Paddings参数时，使用本枚举值。 | +| OH_NN_SPLIT_AXIS | 当张量作为Split算子的Axis参数时，使用本枚举值。 | +| OH_NN_SPLIT_OUTPUT_NUM | 当张量作为Split算子的OutputNum参数时，使用本枚举值。 | +| OH_NN_SPLIT_SIZE_SPLITS | 当张量作为Split算子的SizeSplits参数时，使用本枚举值。 | +| OH_NN_SQUEEZE_AXIS | 当张量作为Squeeze算子的Axis参数时，使用本枚举值。 | +| OH_NN_STACK_AXIS | 当张量作为Stack算子的Axis参数时，使用本枚举值。 | +| OH_NN_STRIDED_SLICE_BEGIN_MASK | 当张量作为StridedSlice算子的BeginMask参数时，使用本枚举值。 | +| OH_NN_STRIDED_SLICE_END_MASK | 当张量作为StridedSlice算子的EndMask参数时，使用本枚举值。 | +| OH_NN_STRIDED_SLICE_ELLIPSIS_MASK | 当张量作为StridedSlice算子的EllipsisMask参数时，使用本枚举值。 | +| OH_NN_STRIDED_SLICE_NEW_AXIS_MASK | 当张量作为StridedSlice算子的NewAxisMask参数时，使用本枚举值。 | +| OH_NN_STRIDED_SLICE_SHRINK_AXIS_MASK | 当张量作为StridedSlice算子的ShrinkAxisMask参数时，使用本枚举值。 | +| OH_NN_SUB_ACTIVATIONTYPE | 当张量作为Sub算子的ActivationType参数时，使用本枚举值。 | +| OH_NN_REDUCE_MEAN_KEEP_DIMS | 当张量作为ReduceMean算子的keep_dims参数时，使用本枚举值。 | +| OH_NN_RESIZE_BILINEAR_NEW_HEIGHT | 当张量作为ResizeBilinear算子的new_height参数时，使用本枚举值。 | +| OH_NN_RESIZE_BILINEAR_NEW_WIDTH | 当张量作为ResizeBilinear算子的new_width参数时，使用本枚举值。 | +| OH_NN_RESIZE_BILINEAR_PRESERVE_ASPECT_RATIO | 当张量作为ResizeBilinear算子的preserve_aspect_ratio参数时，使用本枚举值。 | +| OH_NN_RESIZE_BILINEAR_COORDINATE_TRANSFORM_MODE | 当张量作为ResizeBilinear算子的coordinate_transform_mode参数时，使用本枚举值。 | +| OH_NN_RESIZE_BILINEAR_EXCLUDE_OUTSIDE | 当张量作为ResizeBilinear算子的exclude_outside参数时，使用本枚举值。 | +| OH_NN_LAYER_NORM_BEGIN_NORM_AXIS | 当张量作为LayerNorm算子的beginNormAxis参数时，使用本枚举值。 | +| OH_NN_LAYER_NORM_EPSILON | 当张量作为LayerNorm算子的epsilon参数时，使用本枚举值。 | +| OH_NN_LAYER_NORM_BEGIN_PARAM_AXIS | 当张量作为LayerNorm算子的beginParamsAxis参数时，使用本枚举值。 | +| OH_NN_LAYER_NORM_ELEMENTWISE_AFFINE | 当张量作为LayerNorm算子的elementwiseAffine参数时，使用本枚举值。 | +| OH_NN_REDUCE_PROD_KEEP_DIMS | 当张量作为ReduceProd算子的keep_dims参数时，使用本枚举值。 | +| OH_NN_REDUCE_ALL_KEEP_DIMS | 当张量作为ReduceAll算子的keep_dims参数时，使用本枚举值。 | +| OH_NN_QUANT_DTYPE_CAST_SRC_T | 当张量作为QuantDTypeCast算子的src_t参数时，使用本枚举值。 | +| OH_NN_QUANT_DTYPE_CAST_DST_T | 当张量作为QuantDTypeCast算子的dst_t参数时，使用本枚举值。 | +| OH_NN_TOP_K_SORTED | 当张量作为Topk算子的Sorted参数时，使用本枚举值。 | +| OH_NN_ARG_MAX_AXIS | 当张量作为ArgMax算子的axis参数时，使用本枚举值。 | +| OH_NN_ARG_MAX_KEEPDIMS | 当张量作为ArgMax算子的keepDims参数时，使用本枚举值。 | +| OH_NN_UNSQUEEZE_AXIS | 当张量作为Unsqueeze算子的Axis参数时，使用本枚举值。 | + + +## **函数说明** + + +### OH_NNCompilation_Build() + + +``` +OH_NN_ReturnCode OH_NNCompilation_Build (OH_NNCompilation * compilation) +``` + +**描述：** + +进行模型编译。 + +完成编译配置后，调用本方法指示模型编译已完成。编译实例将模型和编译选项推送至硬件设备进行编译。 + +在调用本方法后，无法进行额外的编译操作，调用 [OH_NNCompilation_SetDevice](#oh_nncompilation_setdevice)、[OH_NNCompilation_SetCache](#oh_nncompilation_setcache)、 [OH_NNCompilation_SetPerformanceMode](#oh_nncompilation_setperformancemode)、 [OH_NNCompilation_SetPriority](#oh_nncompilation_setpriority)和[OH_NNCompilation_EnableFloat16](#oh_nncompilation_enablefloat16) 方法将返回OH_NN_OPERATION_FORBIDDEN。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| compilation | 指向[OH_NNCompilation](#oh_nncompilation)实例的指针。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNCompilation_Construct() + + +``` +OH_NNCompilation* OH_NNCompilation_Construct (const OH_NNModel * model) +``` + +**描述：** + +创建[OH_NNCompilation](#oh_nncompilation)类型的编译实例。 + +使用OH_NNModel模块完成模型的构造后，借助OH_NNCompilation模块提供的接口，将模型传递到底层硬件完成编译。本方法接受一个 [OH_NNModel](#oh_nnmodel)实例，创建出[OH_NNCompilation](#oh_nncompilation)实例；通过 [OH_NNCompilation_SetDevice](#oh_nncompilation_setdevice)方法，设置编译的设备，最后调用 [OH_NNCompilation_Build](#oh_nncompilation_build)完成编译。 + +除了计算硬件的选择，OH_NNCompilation模块支持模型缓存、性能偏好、优先级设置、float16计算等特性，参考以下方法： + +- [OH_NNCompilation_SetCache](#oh_nncompilation_setcache) + +- [OH_NNCompilation_SetPerformanceMode](#oh_nncompilation_setperformancemode) + +- [OH_NNCompilation_SetPriority](#oh_nncompilation_setpriority) + +- [OH_NNCompilation_EnableFloat16](#oh_nncompilation_enablefloat16) + +调用本方法创建[OH_NNCompilation](#oh_nncompilation)后，[OH_NNModel](#oh_nnmodel)实例可以释放。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| model | 指向[OH_NNModel](#oh_nnmodel)实例的指针。 | + +**返回:** + +返回一个指向[OH_NNCompilation](#oh_nncompilation)实例的指针。 + + +### OH_NNCompilation_Destroy() + + +``` +void OH_NNCompilation_Destroy (OH_NNCompilation ** compilation) +``` + +**描述：** + +释放Compilation对象。 + +调用[OH_NNCompilation_Construct](#oh_nncompilation_construct)创建的编译实例需要调用本方法主动释放，否则将造成内存泄漏。 + +如果compilation为空指针或者\*compilation为空指针，本方法只打印warning日志，不执行释放逻辑。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| compilation | 指向[OH_NNCompilation](#oh_nncompilation)实例的二级指针。编译实例销毁后，本方法将\*compilation主动设置为空指针。 | + + +### OH_NNCompilation_EnableFloat16() + + +``` +OH_NN_ReturnCode OH_NNCompilation_EnableFloat16 (OH_NNCompilation * compilation, bool enableFloat16 ) +``` + +**描述：** + +是否以float16的浮点数精度计算。 + +Neural Network Runtime目前仅支持构造float32浮点模型和int8量化模型。在支持float16精度的硬件上调用本方法， float32浮点数精度的模型将以float16的精度执行计算，以减少内存占用和执行时间。 + +在不支持float16精度计算的硬件上调用本方法，将返回OH_NN_UNAVALIDABLE_DEVICE错误码。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| compilation | 指向[OH_NNCompilation](#oh_nncompilation)实例的指针。 | +| enableFloat16 | Float16低精度计算标志位。设置为true时，执行Float16推理；设置为false时，执行float32推理。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNCompilation_SetCache() + + +``` +OH_NN_ReturnCode OH_NNCompilation_SetCache (OH_NNCompilation * compilation, const char * cachePath, uint32_t version ) +``` + +**描述：** + +设置编译后的模型缓存路径和缓存版本。 + +在支持缓存的硬件上，模型在硬件驱动层编译后可以保存为缓存文件，下次编译时直接从缓存文件读取模型，减少重新编译的耗时。本方法接受缓存路径和版本，根据缓存 路径中和版本的不同情况，本方法采取不同的行为： + +- 缓存路径指定的目录下没有文件： 将编译后的模型缓存到目录下，设置缓存版本等于version。 + +- 缓存路径指定的目录下存在完整的缓存文件，且版本号 == version： 读取路径下的缓存文件，传递到底层硬件中转换为可以执行的模型实例。 + +- 缓存路径指定的目录下存在完整的缓存文件，但版本号 < version： 路径下的缓存文件需要更新，模型在底层硬件完成编译后，覆写路径下的缓存文件，将版本号更新为version。 + +- 缓存路径指定的目录下存在完整的缓存文件，但版本号 > version： 路径下的缓存文件版本高于version，不读取缓存文件，同时返回OH_NN_INVALID_PARAMETER错误码。 + +- 缓存路径指定的目录下的缓存文件不完整或没有缓存文件的访问权限： 返回OH_NN_INVALID_FILE错误码。 + +- 缓存目录不存在，或者没有访问权限： 返回OH_NN_INVALID_PATH错误码。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| compilation | 指向[OH_NNCompilation](#oh_nncompilation)实例的指针。 | +| cachePath | 模型缓存文件目录，本方法在cachePath目录下为不同的硬件创建缓存目录。建议每个模型使用单独的缓存目录。 | +| version | 缓存版本。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNCompilation_SetDevice() + + +``` +OH_NN_ReturnCode OH_NNCompilation_SetDevice (OH_NNCompilation * compilation, size_t deviceID ) +``` + +**描述：** + +指定模型编译和计算的硬件。 + +编译阶段，需要指定模型编译和执行计算的硬件设备。先调用[OH_NNDevice_GetAllDevicesID](#oh_nndevice_getalldevicesid)获取可用的设备ID，通过[OH_NNDevice_GetType](#oh_nndevice_gettype)和[OH_NNDevice_GetType](#oh_nndevice_gettype)获取设备信息后，将期望编译执行的设备ID传入本方法进行设置。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| compilation | 指向[OH_NNCompilation](#oh_nncompilation)实例的指针。 | +| deviceID | 指定的硬件ID。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNCompilation_SetPerformanceMode() + + +``` +OH_NN_ReturnCode OH_NNCompilation_SetPerformanceMode (OH_NNCompilation * compilation, OH_NN_PerformanceMode performanceMode ) +``` + +**描述：** + +设置模型计算的性能模式。 + +Neural Network Runtime支持为模型计算设置性能模式，满足低功耗到极致性能的需求。 + +如果编译阶段没有调用本方法设置性能模式， 编译实例为模型默认分配OH_NN_PERFORMANCE_NONE模式。 + +在OH_NN_PERFORMANCE_NONE 模式下，硬件按默认的性能模式执行计算。 + +在不支持性能模式设置的硬件上调用本方法，将返回OH_NN_UNAVALIDABLE_DEVICE错误码。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| compilation | 指向[OH_NNCompilation](#oh_nncompilation)实例的指针。 | +| performanceMode | 指定性能模式，可选的性能模式参考[OH_NN_PerformanceMode](#oh_nn_performancemode)。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNCompilation_SetPriority() + + +``` +OH_NN_ReturnCode OH_NNCompilation_SetPriority (OH_NNCompilation * compilation, OH_NN_Priority priority ) +``` + +**描述：** + +设置模型计算的优先级。 + +Neural Network Runtime 支持为模型设置计算优先级，优先级仅作用于相同uid进程创建的模型，不同uid进程、不同设备的优先级不会 相互影响。 + +在不支持优先级设置的硬件上调用本方法，将返回OH_NN_UNAVALIDABLE_DEVICE错误码。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| compilation | 指向[OH_NNCompilation](#oh_nncompilation)实例的指针。 | +| priority | 指定优先级，可选的优先级参考[OH_NN_Priority](#oh_nn_priority)。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNDevice_GetAllDevicesID() + + +``` +OH_NN_ReturnCode OH_NNDevice_GetAllDevicesID (const size_t ** allDevicesID, uint32_t * deviceCount ) +``` + +**描述：** + +获取对接到 Neural Network Runtime 的硬件ID。 + +每个硬件在 Neural Network Runtime 中存在唯一且固定ID，本方法通过uin32_t数组返回当前设备上已经对接的硬件ID。 + +硬件ID通过size_t数组返回，数组的每个元素是单个硬件的ID值。数组内存由Neural Network Runtime管理。在下次调用本方法前， 数据指针有效。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| allDevicesID | 指向size_t数组的指针。要求传入的(\*allDevicesID)为空指针，否则返回OH_NN_INVALID_PARAMETER。 | +| deviceCount | uint32_t类型的指针，用于返回(\*allDevicesID)的长度。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNDevice_GetName() + + +``` +OH_NN_ReturnCode OH_NNDevice_GetName (size_t deviceID, const char ** name ) +``` + +**描述：** + +获取指定硬件的类型信息。 + +通过deviceID指定计算硬件，获取硬件的名称。硬件ID需要调用[OH_NNDevice_GetAllDevicesID](#oh_nndevice_getalldevicesid)获取。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| deviceID | 指定硬件ID。 | +| name | 指向char数组的指针，要求传入的(\*char)为空指针，否则返回OH_NN_INVALID_PARAMETER。
（\*name）以C风格字符串保存硬件名称，数组以'\0'结尾。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNDevice_GetType() + + +``` +OH_NN_ReturnCode OH_NNDevice_GetType (size_t deviceID, OH_NN_DeviceType * deviceType ) +``` + +**描述：** + +获取指定硬件的类别信息。 + +通过deviceID指定计算硬件，获取硬件的类别。目前 Neural Network Runtime 支持的设备类型有： + +- CPU设备：OH_NN_CPU + +- GPU设备：OH_NN_GPU + +- 机器学习专用加速器：OH_NN_ACCELERATOR + +- 不属于以上类型的其他硬件类型：OH_NN_OTHERS + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| deviceID | 指定硬件ID。 | +| deviceType | 指向[OH_NN_DeviceType](#oh_nn_devicetype)实例的指针，返回硬件的类别信息。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNExecutor_AllocateInputMemory() + + +``` +OH_NN_Memory* OH_NNExecutor_AllocateInputMemory (OH_NNExecutor * executor, uint32_t inputIndex, size_t length ) +``` + +**描述：** + +在硬件上为单个输入申请共享内存。 + +Neural Network Runtime 提供主动申请硬件共享内存的方法。通过指定执行器和输入索引值，本方法在单个输入关联的硬件 上，申请大小为length的共享内存，通过[OH_NN_Memory](_o_h___n_n___memory.md)实例返回。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 | +| inputIndex | 输入的索引值，与调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时输入数据的顺序一致。假设调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时，inputIndices为{1，5，9}， 则在申请输入内存时，三个输入的索引值分别为{0，1，2}。 | +| length | 申请的内存字节。 | + +**返回:** + +指向[OH_NN_Memory](_o_h___n_n___memory.md)实例的指针。 + + +### OH_NNExecutor_AllocateOutputMemory() + + +``` +OH_NN_Memory* OH_NNExecutor_AllocateOutputMemory (OH_NNExecutor * executor, uint32_t outputIndex, size_t length ) +``` + +**描述：** + +在硬件上为单个输出申请共享内存。 + +Neural Network Runtime提供主动申请硬件共享内存的方法。通过指定执行器和输出索引值，本方法在单个输出关联的硬件上，申请大小为length的共享内存，通过[OH_NN_Memory](_o_h___n_n___memory.md)实例返回。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 | +| outputIndex | 输出的索引值，与调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时输出数据的顺序一致。假设调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时，outputIndices为{4，6，8}， 则在申请输出内存时，三个输出的索引值分别为{0，1，2}。 | +| length | 申请的内存字节。 | + +**返回:** + +指向[OH_NN_Memory](_o_h___n_n___memory.md)实例的指针。 + + +### OH_NNExecutor_Construct() + + +``` +OH_NNExecutor* OH_NNExecutor_Construct (OH_NNCompilation * compilation) +``` + +**描述：** + +创建[OH_NNExecutor](#oh_nnexecutor)类型的执行器实例 + +本方法接受一个编译器，构造一个与硬件关联的模型推理执行器。通过[OH_NNExecutor_SetInput](#oh_nnexecutor_setinput)设置模型输入数据， 设置输入数据后，调用[OH_NNExecutor_Run](#oh_nnexecutor_run)方法执行推理，最后通过 [OH_NNExecutor_SetOutput](#oh_nnexecutor_setoutput)获取计算结果。 + +调用本方法创建[OH_NNExecutor](#oh_nnexecutor)实例后，如果不需要创建其他执行器，可以安全释放[OH_NNCompilation](#oh_nncompilation)实例。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| compilation | 指向[OH_NNCompilation](#oh_nncompilation)实例的指针。 | + +**返回:** + +返回指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 + + +### OH_NNExecutor_Destroy() + + +``` +void OH_NNExecutor_Destroy (OH_NNExecutor ** executor) +``` + +**描述：** + +销毁执行器实例，释放执行器占用的内存。 + +调用[OH_NNExecutor_Construct](#oh_nnexecutor_construct)创建的执行器实例需要调用本方法主动释放，否则将造成内存泄漏。 + +如果executor为空指针或者\*executor为空指针，本方法只打印warning日志，不执行释放逻辑。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的二级指针。 | + + +### OH_NNExecutor_DestroyInputMemory() + + +``` +void OH_NNExecutor_DestroyInputMemory (OH_NNExecutor * executor, uint32_t inputIndex, OH_NN_Memory ** memory ) +``` + +**描述：** + +释放[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的输入内存。 + +调用[OH_NNExecutor_AllocateInputMemory](#oh_nnexecutor_allocateinputmemory)创建的内存实例，需要主动调用本方法进行释放，否则将造成内存泄漏。 inputIndex和memory的对应关系需要和创建内存实例时保持一致。 + +如果memory或\*memory为空指针，本方法只打印warning日志，不执行释放逻辑。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 | +| inputIndex | 输入的索引值，与调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时输入数据的顺序一致。假设调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时，inputIndices为{1，5，9}， 则在执行释放输入内存时，三个输入的索引值分别为{0，1，2}。 | +| memory | 指向[OH_NN_Memory](_o_h___n_n___memory.md)实例的二级指针。共享内存销毁后，本方法将\*memory主动设置为空指针。 | + + +### OH_NNExecutor_DestroyOutputMemory() + + +``` +void OH_NNExecutor_DestroyOutputMemory (OH_NNExecutor * executor, uint32_t outputIndex, OH_NN_Memory ** memory ) +``` + +**描述：** + +释放[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的输出内存。 + +调用[OH_NNExecutor_AllocateOutputMemory](#oh_nnexecutor_allocateoutputmemory)创建的内存实例，需要主动调用本方法进行释放，否则将造成内存泄漏。 outputIndex和memory的对应关系需要和创建内存实例时保持一致。 + +如果memory或\*memory为空指针，本方法只打印warning日志，不执行释放逻辑。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 | +| outputIndex | 输出的索引值，与调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时输出数据的顺序一致。假设调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时，outputIndices为{4，6，8}， 则在执行释放输出内存时，三个输出的索引值分别为{0，1，2}。 | +| memory | 指向[OH_NN_Memory](_o_h___n_n___memory.md)实例的二级指针。共享内存销毁后，本方法将\*memory主动设置为空指针。 | + + +### OH_NNExecutor_GetOutputShape() + + +``` +OH_NN_ReturnCode OH_NNExecutor_GetOutputShape (OH_NNExecutor * executor, uint32_t outputIndex, int32_t ** shape, uint32_t * shapeLength ) +``` + +**描述：** + +获取输出张量的维度信息。 + +调用[OH_NNExecutor_Run](#oh_nnexecutor_run)完成单次推理后，本方法获取指定输出的维度信息和维数。在动态形状输入、输出的场景中常用。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 | +| outputIndex | 输出的索引值。与调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时输出数据的顺序一致。假设调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时，outputIndices为{4，6，8}， 则在获取输出张量维度信息的阶段，三个输出的索引值分别为{0，1，2}。 | +| shape | 指向int32_t数组的指针，数组中的每个元素值，是输出张量在每个维度上的长度。 | +| shapeLength | uint32_t类型的指针，返回输出的维数。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNExecutor_Run() + + +``` +OH_NN_ReturnCode OH_NNExecutor_Run (OH_NNExecutor * executor) +``` + +**描述：** + +执行推理。 + +在执行器关联的硬件上，执行模型的端到端推理计算。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNExecutor_SetInput() + + +``` +OH_NN_ReturnCode OH_NNExecutor_SetInput (OH_NNExecutor * executor, uint32_t inputIndex, const OH_NN_Tensor * tensor, const void * dataBuffer, size_t length ) +``` + +**描述：** + +设置模型单个输入的数据。 + +本方法将dataBuffer中，长度为length个字节的数据，拷贝到底层硬件的共享内存。inputIndex指定设置的输入，tensor用于设置输入的 形状、类型、量化参数等信息。 + +由于Neural Network Runtime支持动态输入形状的模型，在固定形状输入和动态形状输入的场景下，本方法采取不同的处理策略： + +- 固定形状输入的场景：tensor各属性必须和构图阶段调用[OH_NNModel_AddTensor](#oh_nnmodel_addtensor)添加的张量保持一致； + +- 动态形状输入的场景：在构图阶段，由于动态输入的形状不确定，调用本方法时，要求tensor.dimensions中的每个值必须大于0， 以确定执行计算阶段输入的形状。设置形状时，只允许调整数值为-1的维度。假设在构图阶段，输入A的维度为 [-1, 224, 224, 3]，调用本方法时，只能调整第一个维度的尺寸，如：[3, 224, 224, 3]。调整其他维度将返回OH_NN_INVALID_PARAMETER。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 | +| inputIndex | 输入的索引值，与调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时输入数据的顺序一致。假设调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时，inputIndices为{1，5，9}， 则在设置输入的阶段，三个输入的索引值分别为{0，1，2}。 | +| tensor | 设置输入数据对应的张量。 | +| dataBuffer | 指向输入数据的指针。 | +| length | 数据缓冲区的字节长度。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNExecutor_SetInputWithMemory() + + +``` +OH_NN_ReturnCode OH_NNExecutor_SetInputWithMemory (OH_NNExecutor * executor, uint32_t inputIndex, const OH_NN_Tensor * tensor, const OH_NN_Memory * memory ) +``` + +**描述：** + +将[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的硬件共享内存，指定为单个输入使用的共享内存。 + +在需要自行管理内存的场景下，本方法将执行输入和[OH_NN_Memory](_o_h___n_n___memory.md)内存实例绑定。执行计算时，底层硬件从内存实例指向的共享内存中读取 输入数据。通过本方法，可以实现设置输入、执行计算、读取输出的并发执行，提升数据流的推理效率。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 | +| inputIndex | 输入的索引值，与调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时输入数据的顺序一致。假设调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时，inputIndices为{1，5，9}， 则在指定输入的共享内存时，三个输入的索引值分别为{0，1，2}。 | +| tensor | 指向[OH_NN_Tensor](_o_h___n_n___tensor.md)的指针，设置单个输入所对应的张量。 | +| memory | 指向[OH_NN_Memory](_o_h___n_n___memory.md)的指针。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNExecutor_SetOutput() + + +``` +OH_NN_ReturnCode OH_NNExecutor_SetOutput (OH_NNExecutor * executor, uint32_t outputIndex, void * dataBuffer, size_t length ) +``` + +**描述：** + +设置模型单个输出的缓冲区。 + +本方法将dataBuffer指向的缓冲区与outputIndex指定的输出绑定，缓冲区的长度由length指定。 + +调用[OH_NNExecutor_Run](#oh_nnexecutor_run)完成单次模型推理后，Neural Network Runtime将比对dataBuffer指向的缓冲区与 输出数据的长度，根据不同情况，返回不同结果： + +- 如果缓冲区大于或等于数据长度：则推理后的结果将拷贝至缓冲区，并返回OH_NN_SUCCESS，可以通过访问dataBuffer读取推理结果。 + +- 如果缓冲区小于数据长度：则[OH_NNExecutor_Run](#oh_nnexecutor_run)将返回OH_NN_INVALID_PARAMETER， 并输出日志告知缓冲区太小的信息。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 指向[OH_NNExecutor](#oh_nnexecutor)实例的指针。 | +| outputIndex | 输出的索引值，与调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时输出数据的顺序一致。假设调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时，outputIndices为{4，6，8}， 则设置输出缓冲区时，三个输出的索引值分别为{0，1，2}。 | +| dataBuffer | 指向输出数据的指针。 | +| length | 数据缓冲区的字节长度。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNExecutor_SetOutputWithMemory() + + +``` +OH_NN_ReturnCode OH_NNExecutor_SetOutputWithMemory (OH_NNExecutor * executor, uint32_t outputIndex, const OH_NN_Memory * memory ) +``` + +**描述：** + +将[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的硬件共享内存，指定为单个输出使用的共享内存。 + +在需要自行管理内存的场景下，本方法将执行输出和[OH_NN_Memory](_o_h___n_n___memory.md)内存实例绑定。执行计算时，底层硬件将计算结果直接写入内存实例指向 的共享内存。通过本方法，可以实现设置输入、执行计算、读取输出的并发执行，提升数据流的推理效率。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| executor | 执行器。 | +| outputIndex | 输出的索引值，与调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时输出数据的顺序一致。假设调用[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)时，outputIndices为{4，6，8}， 则在指定输出的共享内存时，三个输出的索引值分别为{0，1，2}。 | +| memory | 指向[OH_NN_Memory](_o_h___n_n___memory.md)的指针。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNModel_AddOperation() + + +``` +OH_NN_ReturnCode OH_NNModel_AddOperation (OH_NNModel * model, OH_NN_OperationType op, const OH_NN_UInt32Array * paramIndices, const OH_NN_UInt32Array * inputIndices, const OH_NN_UInt32Array * outputIndices ) +``` + +**描述：** + +向模型实例中添加算子。 + +本方法向模型实例中添加算子，算子类型由op指定，算子的参数、输入和输出由paramIndices、inputIndices和 outputIndices指定。本方法将对算子参数的属性和输入输出的数量进行校验，这些属性需要在调用 [OH_NNModel_AddTensor](#oh_nnmodel_addtensor)添加张量的时候正确设置。每个算子期望的参数、输入和输出属性请参考 [OH_NN_OperationType](#oh_nn_operationtype)。 + +paramIndices、inputIndices和outputIndices中存储的是张量的索引值，每个索引值根据张量添加进模型的顺序决定，正确 设置并添加算子要求准确设置每个张量的索引值。张量的添加参考[OH_NNModel_AddTensor](#oh_nnmodel_addtensor)。 + +如果添加算子时，添加了额外的参数（非算子需要的参数），本方法返回OH_NN_INVALID_PARAMETER；如果没有设置算子参数， 则算子按默认值设置缺省的参数，默认值请参考[OH_NN_OperationType](#oh_nn_operationtype)。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| model | 指向[OH_NNModel](#oh_nnmodel)实例的指针。 | +| op | 指定添加的算子类型，取值请参考[OH_NN_OperationType](#oh_nn_operationtype)的枚举值。 | +| paramIndices | OH_NN_UInt32Array实例的指针，设置算子的参数。 | +| inputIndices | OH_NN_UInt32Array实例的指针，指定算子的输入。 | +| outputIndices | OH_NN_UInt32Array实例的指针，设置算子的输出。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNModel_AddTensor() + + +``` +OH_NN_ReturnCode OH_NNModel_AddTensor (OH_NNModel * model, const OH_NN_Tensor * tensor ) +``` + +**描述：** + +向模型实例中添加张量。 + +Neural Network Runtime模型中的数据节点和算子参数均由模型的张量构成。本方法根据tensor，向model实 例中添加张量。张量添加的顺序是模型中记录张量的索引值，[OH_NNModel_SetTensorData](#oh_nnmodel_settensordata)、 [OH_NNModel_AddOperation](#oh_nnmodel_addoperation)和[OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs) 方法根据该索引值，指定不同的张量。 + +Neural Network Runtime支持动态形状输入和输出。在添加动态形状的数据节点时，需要将tensor.dimensions中支持动态 变化的维度设置为-1。例如：一个四维tensor，将tensor.dimensions设置为[1, -1, 2, 2]，表示其第二个维度支持 动态变化。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| model | 指向[OH_NNModel](#oh_nnmodel)实例的指针。 | +| tensor | [OH_NN_Tensor](_o_h___n_n___tensor.md)张量的指针，tensor指定了添加到模型实例中张量的属性。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNModel_Construct() + + +``` +OH_NNModel* OH_NNModel_Construct (void ) +``` + +**描述：** + +创建[OH_NNModel](#oh_nnmodel)类型的模型实例，搭配OH_NNModel模块提供的其他接口，完成模型实例的构造。 + +在开始构图前，先调用[OH_NNModel_Construct](#oh_nnmodel_construct)创建模型实例，根据模型的拓扑结构，调用 [OH_NNModel_AddTensor](#oh_nnmodel_addtensor)、[OH_NNModel_AddOperation](#oh_nnmodel_addoperation)和 [OH_NNModel_SetTensorData](#oh_nnmodel_settensordata)方法，填充模型的数据节点和算子节点；然后调用 [OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)指定模型的输入和输出；当构造完模型的拓扑结构，调用 [OH_NNModel_Finish](#oh_nnmodel_finish)完成模型的构建。 + +模型实例使用完毕后，需要调用[OH_NNModel_Destroy](#oh_nnmodel_destroy)销毁模型实例，避免内存泄漏。 + +**返回:** + +返回一个指向[OH_NNModel](#oh_nnmodel)实例的指针。 + + +### OH_NNModel_Destroy() + + +``` +void OH_NNModel_Destroy (OH_NNModel ** model) +``` + +**描述：** + +释放模型实例。 + +调用[OH_NNModel_Construct](#oh_nnmodel_construct)创建的模型实例需要调用本方法主动释放，否则将造成内存泄漏。 + +如果model为空指针或者\*model为空指针，本方法只打印warning日志，不执行释放逻辑。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| model | 指向[OH_NNModel](#oh_nnmodel)实例的二级指针。模型实例销毁后，本方法将\*model主动设置为空指针。 | + + +### OH_NNModel_Finish() + + +``` +OH_NN_ReturnCode OH_NNModel_Finish (OH_NNModel * model) +``` + +**描述：** + +完成模型构图。 + +完成模型拓扑结构的搭建后，调用本方法指示构图已完成。 + +在调用本方法后，无法进行额外的构图操作，调用 [OH_NNModel_AddTensor](#oh_nnmodel_addtensor)、[OH_NNModel_AddOperation](#oh_nnmodel_addoperation)、 [OH_NNModel_SetTensorData](#oh_nnmodel_settensordata)和 [OH_NNModel_SpecifyInputsAndOutputs](#oh_nnmodel_specifyinputsandoutputs)将返回OH_NN_OPERATION_FORBIDDEN。 + +在调用[OH_NNModel_GetAvailableOperations](#oh_nnmodel_getavailableoperations)和[OH_NNCompilation_Construct](#oh_nncompilation_construct) 之前，必须先调用本方法完成构图。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| model | 指向[OH_NNModel](#oh_nnmodel)实例的指针。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNModel_GetAvailableOperations() + + +``` +OH_NN_ReturnCode OH_NNModel_GetAvailableOperations (OH_NNModel * model, size_t deviceID, const bool ** isSupported, uint32_t * opCount ) +``` + +**描述：** + +查询硬件对模型内所有算子的支持情况，通过布尔值序列指示支持情况。 + +查询底层硬件对模型实例内每个算子的支持情况，硬件由deviceID指定，结果将通过isSupported指向的数组表示。如果支持第i个算子，则 (\*isSupported)[i] == true，否则为 false。 + +本方法成功执行后，(\*isSupported)将指向记录算子支持情况的bool数组，数组长度和模型实例的算子数量相等。该数组对应的内存由 Neural Network Runtime管理，在模型实例销毁或再次调用本方法后自动销毁。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| model | 指向[OH_NNModel](#oh_nnmodel)实例的指针。 | +| deviceID | 指定查询的硬件ID，通过[OH_NNDevice_GetAllDevicesID](#oh_nndevice_getalldevicesid)获取。 | +| isSupported | 指向bool数组的指针。调用本方法时，要求(\*isSupported)为空指针，否则返回OH_NN_INVALID_PARAMETER。 | +| opCount | 模型实例中算子的数量，对应(\*isSupported)数组的长度。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNModel_SetTensorData() + + +``` +OH_NN_ReturnCode OH_NNModel_SetTensorData (OH_NNModel * model, uint32_t index, const void * dataBuffer, size_t length ) +``` + +**描述：** + +设置张量的数值。 + +对于具有常量值的张量（如模型的权重），需要在构图阶段使用本方法设置数值。张量的索引值根据张量添加进模型的顺序决定，张量的添加参考 [OH_NNModel_AddTensor](#oh_nnmodel_addtensor)。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| model | 指向[OH_NNModel](#oh_nnmodel)实例的指针。 | +| index | 张量的索引值。 | +| dataBuffer | 指向真实数据的指针。 | +| length | 数据缓冲区的长度。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 + + +### OH_NNModel_SpecifyInputsAndOutputs() + + +``` +OH_NN_ReturnCode OH_NNModel_SpecifyInputsAndOutputs (OH_NNModel * model, const OH_NN_UInt32Array * inputIndices, const OH_NN_UInt32Array * outputIndices ) +``` + +**描述：** + +指定模型的输入输出。 + +模型实例需要指定张量作为端到端的输入和输出，设置为输入和输出的张量不能使用[OH_NNModel_SetTensorData](#oh_nnmodel_settensordata)设置 数值，需要在执行阶段调用OH_NNExecutor的方法设置输入、输出数据。 + +张量的索引值根据张量添加进模型的顺序决定，张量的添加参考 [OH_NNModel_AddTensor](#oh_nnmodel_addtensor)。 + +暂时不支持异步设置模型输入输出。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| model | 指向[OH_NNModel](#oh_nnmodel)实例的指针。 | +| inputIndices | OH_NN_UInt32Array实例的指针，指定算子的输入。 | +| outputIndices | OH_NN_UInt32Array实例的指针，指定算子的输出。 | + +**返回:** + +函数执行的结果状态。执行成功返回OH_NN_SUCCESS；失败返回具体错误码，具体失败错误码可参考[OH_NN_ReturnCode](#oh_nn_returncode)。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___n_n___memory.md b/zh-cn/application-dev/reference/native-apis/_o_h___n_n___memory.md new file mode 100644 index 0000000000..9e662630ed --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h___n_n___memory.md @@ -0,0 +1,52 @@ +# OH_NN_Memory + + +## 概述 + +内存结构体。 + +**起始版本：** + +9 + +**相关模块：** + +[NeuralNeworkRuntime](_neural_nework_runtime.md) + + +## 汇总 + + +### 成员变量 + +| 成员变量名称 | 描述 | +| -------- | -------- | +| [data](#data) | 指向共享内存的指针，该共享内存通常由底层硬件驱动申请。 | +| [length](#length) | 记录共享内存的字节长度。 | + + +## 结构体成员变量说明 + + +### data + + +``` +void* const OH_NN_Memory::data +``` + +**描述：** + +指向共享内存的指针，该共享内存通常由底层硬件驱动申请。 + + +### length + + +``` +const size_t OH_NN_Memory::length +``` + +**描述：** + +记录共享内存的字节长度。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___n_n___quant_param.md b/zh-cn/application-dev/reference/native-apis/_o_h___n_n___quant_param.md new file mode 100644 index 0000000000..ec04d118de --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h___n_n___quant_param.md @@ -0,0 +1,94 @@ +# OH_NN_QuantParam + + +## 概述 + +量化信息。 + +在量化的场景中，32位浮点型数据根据以下公式量化为定点数据： + +![zh-cn_formulaimage_0000001405137102](figures/zh-cn_formulaimage_0000001405137102.png) + +其中s和z是量化参数，在OH_NN_QuanParam中通过scale和zeroPoint保存，r是浮点数，q是量化后的结果，q_min是量化后下界，q_max是量化后的上界，计算方式如下： + +![zh-cn_formulaimage_0000001459019845](figures/zh-cn_formulaimage_0000001459019845.png) + +![zh-cn_formulaimage_0000001408820090](figures/zh-cn_formulaimage_0000001408820090.png) + +clamp函数定义如下： + +![zh-cn_formulaimage_0000001455538697](figures/zh-cn_formulaimage_0000001455538697.png) + +**起始版本：** + +9 + +**相关模块：** + +[NeuralNeworkRuntime](_neural_nework_runtime.md) + + +## 汇总 + + +### 成员变量 + +| 成员变量名称 | 描述 | +| -------- | -------- | +| [quantCount](#quantcount) | 指定numBits、scale和zeroPoint数组的长度。
在per-layer量化的场景下，quantCount通常指定为1，即一个张量所有通道共享一套量化参数；在per-channel量化场景下，quantCount通常和张量通道数一致，每个通道使用自己的量化参数。 | +| [numBits](#numbits) | 量化位数。 | +| [scale](#scale) | 指向量化公式中量化参数s的指针。 | +| [zeroPoint](#zeropoint) | 指向量化公式中量化参数z的指针。 | + + +## 结构体成员变量说明 + + +### numBits + + +``` +const uint32_t* OH_NN_QuantParam::numBits +``` + +**描述：** + +量化位数。 + + +### quantCount + + +``` +uint32_t OH_NN_QuantParam::quantCount +``` + +**描述：** + +指定numBits、scale和zeroPoint数组的长度。 + +在per-layer量化的场景下，quantCount通常指定为1，即一个张量所有通道 共享一套量化参数；在per-channel量化场景下，quantCount通常和张量通道数一致，每个通道使用自己的量化参数。 + + +### scale + + +``` +const double* OH_NN_QuantParam::scale +``` + +**描述：** + +指向量化公式中scale数据的指针。 + + +### zeroPoint + + +``` +const int32_t* OH_NN_QuantParam::zeroPoint +``` + +**描述：** + +指向量化公式中zero point数据的指针。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___n_n___tensor.md b/zh-cn/application-dev/reference/native-apis/_o_h___n_n___tensor.md new file mode 100644 index 0000000000..43580162dd --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h___n_n___tensor.md @@ -0,0 +1,97 @@ +# OH_NN_Tensor + + +## 概述 + +张量结构体。 + +通常用于构造模型图中的数据节点和算子参数，在构造张量时需要明确数据类型、维数、维度信息和量化信息。 + +**起始版本：** + +9 + +**相关模块：** + +[NeuralNeworkRuntime](_neural_nework_runtime.md) + + +## 汇总 + + +### 成员变量 + +| 成员变量名称 | 描述 | +| -------- | -------- | +| [dataType](#datatype) | 指定张量的数据类型，要求从[OH_NN_DataType](_neural_nework_runtime.md#ohnndatatype)枚举类型中取值。 | +| [dimensionCount](#dimensioncount) | 指定张量的维数。 | +| [dimensions](#dimensions) | 指定张量的维度信息（形状）。 | +| [quantParam](#quantparam) | 指定张量的量化信息，数据类型要求为[OH_NN_QuantParam](_o_h___n_n___quant_param.md)。 | +| [type](#type) | 指定张量的类型，type的取值和张量的用途相关。
当张量作为模型的输入或输出，则要求type设置为OH_NN_TENSOR；
当张量作为算子参数，则要求从[OH_NN_TensorType](_neural_nework_runtime.md#ohnntensortype)枚举类型中选择除OH_NN_TENSOR之外的合适的枚举值。 | + + +## 结构体成员变量说明 + + +### dataType + + +``` +OH_NN_DataType OH_NN_Tensor::dataType +``` + +**描述：** + +指定张量的数据类型，要求从[OH_NN_DataType](_neural_nework_runtime.md#oh_nn_datatype)枚举类型中取值。 + + +### dimensionCount + + +``` +uint32_t OH_NN_Tensor::dimensionCount +``` + +**描述：** + +指定张量的维数。 + + +### dimensions + + +``` +const int32_t* OH_NN_Tensor::dimensions +``` + +**描述：** + +指定张量的维度信息（形状）。 + + +### quantParam + + +``` +const OH_NN_QuantParam* OH_NN_Tensor::quantParam +``` + +**描述：** + +指定张量的量化信息，数据类型要求为[OH_NN_QuantParam](_o_h___n_n___quant_param.md)。 + + +### type + + +``` +OH_NN_TensorType OH_NN_Tensor::type +``` + +**描述：** + +指定张量的类型，type的取值和张量的用途相关。 + +当张量作为模型的输入或输出，则要求type设置为OH_NN_TENSOR； + +当张量作为算子参数，则要求从[OH_NN_TensorType](_neural_nework_runtime.md#oh_nn_tensortype)枚举类型中选择除OH_NN_TENSOR之外的合适的枚举值。 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___n_n___u_int32_array.md b/zh-cn/application-dev/reference/native-apis/_o_h___n_n___u_int32_array.md new file mode 100644 index 0000000000..7b8ffb3d24 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h___n_n___u_int32_array.md @@ -0,0 +1,52 @@ +# OH_NN_UInt32Array + + +## 概述 + +该结构体用于存储32位无符号整型数组。 + +**起始版本：** + +9 + +**相关模块：** + +[NeuralNeworkRuntime](_neural_nework_runtime.md) + + +## 汇总 + + +### 成员变量 + +| 成员变量名称 | 描述 | +| -------- | -------- | +| [data](#data) | 无符号整型数组的指针。 | +| [size](#size) | 数组长度。 | + + +## 结构体成员变量说明 + + +### data + + +``` +uint32_t* OH_NN_UInt32Array::data +``` + +**描述：** + +无符号整型数组的指针。 + + +### size + + +``` +uint32_t OH_NN_UInt32Array::size +``` + +**描述：** + +数组长度。 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/neural__network__runtime_8h.md b/zh-cn/application-dev/reference/native-apis/neural__network__runtime_8h.md new file mode 100644 index 0000000000..7a0de6290c --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/neural__network__runtime_8h.md @@ -0,0 +1,54 @@ +# neural_network_runtime.h + + +## 概述 + +Neural Network Runtime部件接口定义，AI推理框架通过Neural Network Runtime提供的Native接口，完成模型构造与编译，并在加速硬件上执行推理计算。 + +**起始版本：** + +9 + +**相关模块：** + +[NeuralNeworkRuntime](_neural_nework_runtime.md) + + +## 汇总 + + +### 函数 + +| 函数名称 | 描述 | +| -------- | -------- | +| [OH_NNModel_Construct](_neural_nework_runtime.md#oh_nnmodel_construct) (void) | 创建[OH_NNModel](_neural_nework_runtime.md#oh_nnmodel)类型的模型实例，搭配OH_NNModel模块提供的其他接口，完成模型实例的构造。 | +| [OH_NNModel_AddTensor](_neural_nework_runtime.md#oh_nnmodel_addtensor) (OH_NNModel \*model, const OH_NN_Tensor \*tensor) | 向模型实例中添加张量。 | +| [OH_NNModel_SetTensorData](_neural_nework_runtime.md#oh_nnmodel_settensordata) (OH_NNModel \*model, uint32_t index, const void \*dataBuffer, size_t length) | 设置张量的数值。 | +| [OH_NNModel_AddOperation](_neural_nework_runtime.md#oh_nnmodel_addoperation) (OH_NNModel \*model, OH_NN_OperationType op, const OH_NN_UInt32Array \*paramIndices, const OH_NN_UInt32Array \*inputIndices, const OH_NN_UInt32Array \*outputIndices) | 向模型实例中添加算子。 | +| [OH_NNModel_SpecifyInputsAndOutputs](_neural_nework_runtime.md#oh_nnmodel_specifyinputsandoutputs) (OH_NNModel \*model, const OH_NN_UInt32Array \*inputIndices, const OH_NN_UInt32Array \*outputIndices) | 指定模型的输入输出。 | +| [OH_NNModel_Finish](_neural_nework_runtime.md#oh_nnmodel_finish) (OH_NNModel \*model) | 完成模型构图。 | +| [OH_NNModel_Destroy](_neural_nework_runtime.md#oh_nnmodel_destroy) (OH_NNModel \*\*model) | 释放模型实例。 | +| [OH_NNModel_GetAvailableOperations](_neural_nework_runtime.md#oh_nnmodel_getavailableoperations) (OH_NNModel \*model, size_t deviceID, const bool \*\*isSupported, uint32_t \*opCount) | 查询硬件对模型内所有算子的支持情况，通过布尔值序列指示支持情况。 | +| [OH_NNCompilation_Construct](_neural_nework_runtime.md#oh_nncompilation_construct) (const OH_NNModel \*model) | 创建[OH_NNCompilation](_neural_nework_runtime.md#oh_nncompilation)类型的编译实例。 | +| [OH_NNCompilation_SetDevice](_neural_nework_runtime.md#oh_nncompilation_setdevice) (OH_NNCompilation \*compilation, size_t deviceID) | 指定模型编译和计算的硬件。 | +| [OH_NNCompilation_SetCache](_neural_nework_runtime.md#oh_nncompilation_setcache) (OH_NNCompilation \*compilation, const char \*cachePath, uint32_t version) | 设置编译后的模型缓存路径和缓存版本。 | +| [OH_NNCompilation_SetPerformanceMode](_neural_nework_runtime.md#oh_nncompilation_setperformancemode) (OH_NNCompilation \*compilation, OH_NN_PerformanceMode performanceMode) | 设置模型计算的性能模式。 | +| [OH_NNCompilation_SetPriority](_neural_nework_runtime.md#oh_nncompilation_setpriority) (OH_NNCompilation \*compilation, OH_NN_Priority priority) | 设置模型计算的优先级。 | +| [OH_NNCompilation_EnableFloat16](_neural_nework_runtime.md#oh_nncompilation_enablefloat16) (OH_NNCompilation \*compilation, bool enableFloat16) | 是否以float16的浮点数精度计算。 | +| [OH_NNCompilation_Build](_neural_nework_runtime.md#oh_nncompilation_build) (OH_NNCompilation \*compilation) | 进行模型编译。 | +| [OH_NNCompilation_Destroy](_neural_nework_runtime.md#oh_nncompilation_destroy) (OH_NNCompilation \*\*compilation) | 释放Compilation对象。 | +| [OH_NNExecutor_Construct](_neural_nework_runtime.md#oh_nnexecutor_construct) (OH_NNCompilation \*compilation) | 创建[OH_NNExecutor](_neural_nework_runtime.md#oh_nnexecutor)类型的执行器实例。 | +| [OH_NNExecutor_SetInput](_neural_nework_runtime.md#oh_nnexecutor_setinput) (OH_NNExecutor \*executor, uint32_t inputIndex, const OH_NN_Tensor \*tensor, const void \*dataBuffer, size_t length) | 设置模型单个输入的数据。 | +| [OH_NNExecutor_SetOutput](_neural_nework_runtime.md#oh_nnexecutor_setoutput) (OH_NNExecutor \*executor, uint32_t outputIndex, void \*dataBuffer, size_t length) | 设置模型单个输出的缓冲区。 | +| [OH_NNExecutor_GetOutputShape](_neural_nework_runtime.md#oh_nnexecutor_getoutputshape) (OH_NNExecutor \*executor, uint32_t outputIndex, int32_t \*\*shape, uint32_t \*shapeLength) | 获取输出张量的维度信息。 | +| [OH_NNExecutor_Run](_neural_nework_runtime.md#oh_nnexecutor_run) (OH_NNExecutor \*executor) | 执行推理。 | +| [OH_NNExecutor_AllocateInputMemory](_neural_nework_runtime.md#oh_nnexecutor_allocateinputmemory) (OH_NNExecutor \*executor, uint32_t inputIndex, size_t length) | 在硬件上为单个输入申请共享内存。 | +| [OH_NNExecutor_AllocateOutputMemory](_neural_nework_runtime.md#oh_nnexecutor_allocateoutputmemory) (OH_NNExecutor \*executor, uint32_t outputIndex, size_t length) | 在硬件上为单个输出申请共享内存。 | +| [OH_NNExecutor_DestroyInputMemory](_neural_nework_runtime.md#oh_nnexecutor_destroyinputmemory) (OH_NNExecutor \*executor, uint32_t inputIndex, OH_NN_Memory \*\*memory) | 释放[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的输入内存。 | +| [OH_NNExecutor_DestroyOutputMemory](_neural_nework_runtime.md#oh_nnexecutor_destroyoutputmemory) (OH_NNExecutor \*executor, uint32_t outputIndex, OH_NN_Memory \*\*memory) | 释放[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的输出内存。 | +| [OH_NNExecutor_SetInputWithMemory](_neural_nework_runtime.md#oh_nnexecutor_setinputwithmemory) (OH_NNExecutor \*executor, uint32_t inputIndex, const OH_NN_Tensor \*tensor, const OH_NN_Memory \*memory) | 将[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的硬件共享内存，指定为单个输入使用的共享内存。 | +| [OH_NNExecutor_SetOutputWithMemory](_neural_nework_runtime.md#oh_nnexecutor_setoutputwithmemory) (OH_NNExecutor \*executor, uint32_t outputIndex, const OH_NN_Memory \*memory) | 将[OH_NN_Memory](_o_h___n_n___memory.md)实例指向的硬件共享内存，指定为单个输出使用的共享内存。 | +| [OH_NNExecutor_Destroy](_neural_nework_runtime.md#oh_nnexecutor_destroy) (OH_NNExecutor \*\*executor) | 销毁执行器实例，释放执行器占用的内存。 | +| [OH_NNDevice_GetAllDevicesID](_neural_nework_runtime.md#oh_nndevice_getalldevicesid) (const size_t \*\*allDevicesID, uint32_t \*deviceCount) | 获取对接到 Neural Network Runtime 的硬件ID。 | +| [OH_NNDevice_GetName](_neural_nework_runtime.md#oh_nndevice_getname) (size_t deviceID, const char \*\*name) | 获取指定硬件的类型信息。 | +| [OH_NNDevice_GetType](_neural_nework_runtime.md#oh_nndevice_gettype) (size_t deviceID, [OH_NN_DeviceType](_neural_nework_runtime.md#oh_nn_devicetype) \*deviceType) | 获取指定硬件的类别信息。 | diff --git a/zh-cn/application-dev/reference/native-apis/neural__network__runtime__type_8h.md b/zh-cn/application-dev/reference/native-apis/neural__network__runtime__type_8h.md new file mode 100644 index 0000000000..542c8fc8c0 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/neural__network__runtime__type_8h.md @@ -0,0 +1,55 @@ +# neural_network_runtime_type.h + + +## 概述 + +Neural Network Runtime定义的结构体和枚举值。 + +**起始版本：** + +9 + +**相关模块：** + +[NeuralNeworkRuntime](_neural_nework_runtime.md) + + +## 汇总 + + +### 结构体 + +| 结构体名称 | 描述 | +| -------- | -------- | +| [OH_NN_UInt32Array](_o_h___n_n___u_int32_array.md) | 自定义的32位无符号整型数组类型。 | +| [OH_NN_QuantParam](_o_h___n_n___quant_param.md) | 量化信息。 | +| [OH_NN_Tensor](_o_h___n_n___tensor.md) | 张量结构体。 | +| [OH_NN_Memory](_o_h___n_n___memory.md) | 内存结构体。 | + + +### 类型定义 + +| 类型定义名称 | 描述 | +| -------- | -------- | +| [OH_NNModel](_neural_nework_runtime.md#oh_nnmodel) | Neural Network Runtime的模型句柄。 | +| [OH_NNCompilation](_neural_nework_runtime.md#oh_nncompilation) | Neural Network Runtime的编译器句柄。 | +| [OH_NNExecutor](_neural_nework_runtime.md#oh_nnexecutor) | Neural Network Runtime的执行器句柄。 | +| [OH_NN_UInt32Array](_neural_nework_runtime.md#oh_nn_uint32array) | 自定义的32位无符号整型数组类型。 | +| [OH_NN_QuantParam](_neural_nework_runtime.md#oh_nn_quantparam) | 量化信息。 | +| [OH_NN_Tensor](_neural_nework_runtime.md#oh_nn_tensor) | 张量结构体。 | +| [OH_NN_Memory](_neural_nework_runtime.md#oh_nn_memory) | 内存结构体。 | + + +### 枚举 + +| 枚举名称 | 描述 | +| -------- | -------- | +| [OH_NN_PerformanceMode](_neural_nework_runtime.md#oh_nn_performancemode) { OH_NN_PERFORMANCE_NONE = 0, OH_NN_PERFORMANCE_LOW = 1, OH_NN_PERFORMANCE_MEDIUM = 2, OH_NN_PERFORMANCE_HIGH = 3, OH_NN_PERFORMANCE_EXTREME = 4 } | 硬件的性能模式。 | +| [OH_NN_Priority](_neural_nework_runtime.md#oh_nn_priority) { OH_NN_PRIORITY_NONE = 0, OH_NN_PRIORITY_LOW = 1, OH_NN_PRIORITY_MEDIUM = 2, OH_NN_PRIORITY_HIGH = 3 } | 模型推理任务优先级。 | +| [OH_NN_ReturnCode](_neural_nework_runtime.md#oh_nn_returncode) { OH_NN_SUCCESS = 0, OH_NN_FAILED = 1, OH_NN_INVALID_PARAMETER = 2, OH_NN_MEMORY_ERROR = 3, OH_NN_OPERATION_FORBIDDEN = 4, OH_NN_NULL_PTR = 5, OH_NN_INVALID_FILE = 6, OH_NN_UNAVALIDABLE_DEVICE = 7, OH_NN_INVALID_PATH = 8 } | Neural Network Runtime定义的错误码类型。 | +| [OH_NN_FuseType](_neural_nework_runtime.md#oh_nn_fusetype) : int8_t { OH_NN_FUSED_NONE = 0, OH_NN_FUSED_RELU = 1, OH_NN_FUSED_RELU6 = 2 } | Neural Network Runtime融合算子中激活函数的类型。 | +| [OH_NN_Format](_neural_nework_runtime.md#oh_nn_format) { OH_NN_FORMAT_NONE = 0, OH_NN_FORMAT_NCHW = 1, OH_NN_FORMAT_NHWC = 2 } | 张量数据的排布类型。 | +| [OH_NN_DeviceType](_neural_nework_runtime.md#oh_nn_devicetype) { OH_NN_OTHERS = 0, OH_NN_CPU = 1, OH_NN_GPU = 2, OH_NN_ACCELERATOR = 3 } | Neural Network Runtime支持的设备类型。 | +| [OH_NN_DataType](_neural_nework_runtime.md#oh_nn_datatype) { OH_NN_UNKNOWN = 0, OH_NN_BOOL = 1, OH_NN_INT8 = 2, OH_NN_INT16 = 3, OH_NN_INT32 = 4, OH_NN_INT64 = 5, OH_NN_UINT8 = 6, OH_NN_UINT16 = 7, OH_NN_UINT32 = 8, OH_NN_UINT64 = 9, OH_NN_FLOAT16 = 10, OH_NN_FLOAT32 = 11, OH_NN_FLOAT64 = 12 } | Neural Network Runtime支持的数据类型。 | +| [OH_NN_OperationType](_neural_nework_runtime.md#oh_nn_operationtype) { OH_NN_OPS_ADD = 1, OH_NN_OPS_AVG_POOL = 2, OH_NN_OPS_BATCH_NORM = 3, OH_NN_OPS_BATCH_TO_SPACE_ND = 4, OH_NN_OPS_BIAS_ADD = 5, OH_NN_OPS_CAST = 6, OH_NN_OPS_CONCAT = 7, OH_NN_OPS_CONV2D = 8, OH_NN_OPS_CONV2D_TRANSPOSE = 9, OH_NN_OPS_DEPTHWISE_CONV2D_NATIVE = 10, OH_NN_OPS_DIV = 11, OH_NN_OPS_ELTWISE = 12, OH_NN_OPS_EXPAND_DIMS = 13, OH_NN_OPS_FILL = 14, OH_NN_OPS_FULL_CONNECTION = 15, OH_NN_OPS_GATHER = 16, OH_NN_OPS_HSWISH = 17, OH_NN_OPS_LESS_EQUAL = 18, OH_NN_OPS_MATMUL = 19, OH_NN_OPS_MAXIMUM = 20, OH_NN_OPS_MAX_POOL = 21, OH_NN_OPS_MUL = 22, OH_NN_OPS_ONE_HOT = 23, OH_NN_OPS_PAD = 24, OH_NN_OPS_POW = 25, OH_NN_OPS_SCALE = 26, OH_NN_OPS_SHAPE = 27, OH_NN_OPS_SIGMOID = 28, OH_NN_OPS_SLICE = 29, OH_NN_OPS_SOFTMAX = 30, OH_NN_OPS_SPACE_TO_BATCH_ND = 31, OH_NN_OPS_SPLIT = 32, OH_NN_OPS_SQRT = 33, OH_NN_OPS_SQUARED_DIFFERENCE = 34, OH_NN_OPS_SQUEEZE = 35, OH_NN_OPS_STACK = 36, OH_NN_OPS_STRIDED_SLICE = 37, OH_NN_OPS_SUB = 38, OH_NN_OPS_TANH = 39, OH_NN_OPS_TILE = 40, OH_NN_OPS_TRANSPOSE = 41, OH_NN_OPS_REDUCE_MEAN = 42, OH_NN_OPS_RESIZE_BILINEAR = 43, OH_NN_OPS_RSQRT = 44, OH_NN_OPS_RESHAPE = 45, OH_NN_OPS_PRELU = 46, OH_NN_OPS_RELU = 47, OH_NN_OPS_RELU6 = 48, OH_NN_OPS_LAYER_NORM = 49, OH_NN_OPS_REDUCE_PROD = 50, OH_NN_OPS_REDUCE_ALL = 51, OH_NN_OPS_QUANT_DTYPE_CAST = 52, OH_NN_OPS_TOP_K = 53, OH_NN_OPS_ARG_MAX = 54, OH_NN_OPS_UNSQUEEZE = 55, OH_NN_OPS_GELU = 56 } | Neural Network Runtime支持算子的类型。 | +| [OH_NN_TensorType](_neural_nework_runtime.md#oh_nn_tensortype) { OH_NN_TENSOR = 0, OH_NN_ADD_ACTIVATIONTYPE = 1, OH_NN_AVG_POOL_KERNEL_SIZE = 2, OH_NN_AVG_POOL_STRIDE = 3, OH_NN_AVG_POOL_PAD_MODE = 4, OH_NN_AVG_POOL_PAD = 5, OH_NN_AVG_POOL_ACTIVATION_TYPE = 6, OH_NN_BATCH_NORM_EPSILON = 7, OH_NN_BATCH_TO_SPACE_ND_BLOCKSIZE = 8, OH_NN_BATCH_TO_SPACE_ND_CROPS = 9, OH_NN_CONCAT_AXIS = 10, OH_NN_CONV2D_STRIDES = 11, OH_NN_CONV2D_PAD = 12, OH_NN_CONV2D_DILATION = 13, OH_NN_CONV2D_PAD_MODE = 14, OH_NN_CONV2D_ACTIVATION_TYPE = 15, OH_NN_CONV2D_GROUP = 16, OH_NN_CONV2D_TRANSPOSE_STRIDES = 17, OH_NN_CONV2D_TRANSPOSE_PAD = 18, OH_NN_CONV2D_TRANSPOSE_DILATION = 19, OH_NN_CONV2D_TRANSPOSE_OUTPUT_PADDINGS = 20, OH_NN_CONV2D_TRANSPOSE_PAD_MODE = 21, OH_NN_CONV2D_TRANSPOSE_ACTIVATION_TYPE = 22, OH_NN_CONV2D_TRANSPOSE_GROUP = 23, OH_NN_DEPTHWISE_CONV2D_NATIVE_STRIDES = 24, OH_NN_DEPTHWISE_CONV2D_NATIVE_PAD = 25, OH_NN_DEPTHWISE_CONV2D_NATIVE_DILATION = 26, OH_NN_DEPTHWISE_CONV2D_NATIVE_PAD_MODE = 27, OH_NN_DEPTHWISE_CONV2D_NATIVE_ACTIVATION_TYPE = 28, OH_NN_DIV_ACTIVATIONTYPE = 29, OH_NN_ELTWISE_MODE = 30, OH_NN_FULL_CONNECTION_AXIS = 31, OH_NN_FULL_CONNECTION_ACTIVATIONTYPE = 32, OH_NN_MATMUL_TRANSPOSE_A = 33, OH_NN_MATMUL_TRANSPOSE_B = 34, OH_NN_MATMUL_ACTIVATION_TYPE = 35, OH_NN_MAX_POOL_KERNEL_SIZE = 36, OH_NN_MAX_POOL_STRIDE = 37, OH_NN_MAX_POOL_PAD_MODE = 38, OH_NN_MAX_POOL_PAD = 39, OH_NN_MAX_POOL_ACTIVATION_TYPE = 40, OH_NN_MUL_ACTIVATION_TYPE = 41, OH_NN_ONE_HOT_AXIS = 42, OH_NN_PAD_CONSTANT_VALUE = 43, OH_NN_SCALE_ACTIVATIONTYPE = 44, OH_NN_SCALE_AXIS = 45, OH_NN_SOFTMAX_AXIS = 46, OH_NN_SPACE_TO_BATCH_ND_BLOCK_SHAPE = 47, OH_NN_SPACE_TO_BATCH_ND_PADDINGS = 48, OH_NN_SPLIT_AXIS = 49, OH_NN_SPLIT_OUTPUT_NUM = 50, OH_NN_SPLIT_SIZE_SPLITS = 51, OH_NN_SQUEEZE_AXIS = 52, OH_NN_STACK_AXIS = 53, OH_NN_STRIDED_SLICE_BEGIN_MASK = 54, OH_NN_STRIDED_SLICE_END_MASK = 55, OH_NN_STRIDED_SLICE_ELLIPSIS_MASK = 56, OH_NN_STRIDED_SLICE_NEW_AXIS_MASK = 57, OH_NN_STRIDED_SLICE_SHRINK_AXIS_MASK = 58, OH_NN_SUB_ACTIVATIONTYPE = 59, OH_NN_REDUCE_MEAN_KEEP_DIMS = 60, OH_NN_RESIZE_BILINEAR_NEW_HEIGHT = 61, OH_NN_RESIZE_BILINEAR_NEW_WIDTH = 62, OH_NN_RESIZE_BILINEAR_PRESERVE_ASPECT_RATIO = 63, OH_NN_RESIZE_BILINEAR_COORDINATE_TRANSFORM_MODE = 64, OH_NN_RESIZE_BILINEAR_EXCLUDE_OUTSIDE = 65, OH_NN_LAYER_NORM_BEGIN_NORM_AXIS = 66, OH_NN_LAYER_NORM_EPSILON = 67, OH_NN_LAYER_NORM_BEGIN_PARAM_AXIS = 68, OH_NN_LAYER_NORM_ELEMENTWISE_AFFINE = 69, OH_NN_REDUCE_PROD_KEEP_DIMS = 70, OH_NN_REDUCE_ALL_KEEP_DIMS = 71, OH_NN_QUANT_DTYPE_CAST_SRC_T = 72, OH_NN_QUANT_DTYPE_CAST_DST_T = 73, OH_NN_TOP_K_SORTED = 74, OH_NN_ARG_MAX_AXIS = 75, OH_NN_ARG_MAX_KEEPDIMS = 76, OH_NN_UNSQUEEZE_AXIS = 77 } | 张量的类型。 | 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