native_audio_suite_engine.h
概述
声明与音频编创相关的接口。（包括引擎、管线、节点）。
引用文件： <ohaudiosuite/native_audio_suite_engine.h>
库： libohaudiosuite.so
系统能力： SystemCapability.Multimedia.Audio.SuiteEngine
起始版本： 22
相关模块： OHAudioSuite
汇总
函数
函数说明
OH_AudioSuiteEngine_Create()
OH_AudioSuite_Result OH_AudioSuiteEngine_Create(OH_AudioSuiteEngine** audioSuiteEngine)
描述
创建音频编创引擎。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuiteEngine** audioSuiteEngine | 音频编创引擎句柄，指向接收audioSuiteEngine变量的指针。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数audioSuiteEngine为空指针。 AUDIOSUITE_ERROR_INVALID_STATE：引擎已经被初始化。 AUDIOSUITE_ERROR_MEMORY_ALLOC_FAILED：内存申请失败。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_Destroy()
OH_AudioSuite_Result OH_AudioSuiteEngine_Destroy(OH_AudioSuiteEngine* audioSuiteEngine)
描述
销毁音频编创引擎句柄。
说明： 销毁引擎时会同时销毁该引擎下的所有管线。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuiteEngine* audioSuiteEngine | 音频编创引擎句柄，通过OH_AudioSuiteEngine_Create获取句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数audioSuiteEngine为空指针。 AUDIOSUITE_ERROR_INVALID_STATE：引擎已被去初始化、引擎未创建或未初始化引擎。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_CreatePipeline()
OH_AudioSuite_Result OH_AudioSuiteEngine_CreatePipeline(OH_AudioSuiteEngine* audioSuiteEngine, OH_AudioSuitePipeline** audioSuitePipeline, OH_AudioSuite_PipelineWorkMode workMode)
描述
在当前音频编创引擎中创建1个管线。管线是引擎内负责音频编创的执行单元，1个引擎可创建多个管线。
支持最多创建10条管线，其中至多有1条实时渲染管线。
每个管线必须至少包含1个输入节点，有且只有1个输出节点。
当管线在OH_AudioSuite_PipelineWorkMode.AUDIOSUITE_PIPELINE_EDIT_MODE模式下工作时，支持所有的效果节点。
当管线在OH_AudioSuite_PipelineWorkMode.AUDIOSUITE_PIPELINE_REALTIME_MODE模式下工作时，仅支持OH_AudioNode_Type.EFFECT_NODE_TYPE_EQUALIZER效果节点。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuiteEngine* audioSuiteEngine | 音频编创引擎句柄。通过OH_AudioSuiteEngine_Create获取句柄。 |
| OH_AudioSuitePipeline** audioSuitePipeline | 音频编创管线句柄。 |
| OH_AudioSuite_PipelineWorkMode workMode | 管线工作模式。 1. AUDIOSUITE_PIPELINE_EDIT_MODE: 支持所有效果节点； 2. AUDIOSUITE_PIPELINE_REALTIME_MODE：支持均衡器等节点。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数audioSuiteEngine为空指针或参数audioSuitePipeline为空指针。 AUDIOSUITE_ERROR_ENGINE_NOT_EXIST：未初始化引擎。 AUDIOSUITE_ERROR_CREATED_EXCEED_SYSTEM_LIMITS：创建管线数量超过系统最大数量限制（引擎最多创建10条管线）。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_MEMORY_ALLOC_FAILED：内存申请失败。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_DestroyPipeline()
OH_AudioSuite_Result OH_AudioSuiteEngine_DestroyPipeline(OH_AudioSuitePipeline* audioSuitePipeline)
描述
销毁音频编创管线句柄。
说明： 销毁管线时会同时销毁该管线下的所有节点。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuitePipeline* audioSuitePipeline | 音频编创管线句柄。通过OH_AudioSuiteEngine_CreatePipeline获取需要销毁的句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数audioSuitePipeline为空指针。 AUDIOSUITE_ERROR_PIPELINE_NOT_EXIST：管线不存在或已经被销毁。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_StartPipeline()
OH_AudioSuite_Result OH_AudioSuiteEngine_StartPipeline(OH_AudioSuitePipeline* audioSuitePipeline)
描述
开始运行该管线，管线会进入OH_AudioSuite_PipelineState.AUDIOSUITE_PIPELINE_RUNNING运行状态。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuitePipeline* audioSuitePipeline | 音频编创管线句柄。通过OH_AudioSuiteEngine_CreatePipeline获取句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数audioSuitePipeline为空指针。 AUDIOSUITE_ERROR_PIPELINE_NOT_EXIST：管线不存在或已经被销毁。 AUDIOSUITE_ERROR_INVALID_STATE：管线已在运行或节点连接异常。 可能的原因如下： 1. 管线已经在运行状态； 2. 当前管线中不存在输出类型节点； 3. 起始节点不是输入类型节点。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_StopPipeline()
OH_AudioSuite_Result OH_AudioSuiteEngine_StopPipeline(OH_AudioSuitePipeline* audioSuitePipeline)
描述
停止运行该管线，管线会进入OH_AudioSuite_PipelineState.AUDIOSUITE_PIPELINE_STOPPED停止状态。该函数不会改变管线中节点之间的连接关系，管线一旦被停止，OH_AudioSuiteEngine_RenderFrame就不能再进行音频处理。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuitePipeline* audioSuitePipeline | 音频编创管线句柄。通过OH_AudioSuiteEngine_CreatePipeline获取句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数audioSuitePipeline为空指针。 AUDIOSUITE_ERROR_PIPELINE_NOT_EXIST：管线不存在或已经被销毁。 AUDIOSUITE_ERROR_INVALID_STATE：管线已在停止状态。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetPipelineState()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetPipelineState(OH_AudioSuitePipeline* audioSuitePipeline, OH_AudioSuite_PipelineState* pipelineState)
描述
获取当前管线的状态。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuitePipeline* audioSuitePipeline | 音频编创管线句柄。通过OH_AudioSuiteEngine_CreatePipeline获取句柄。 |
| OH_AudioSuite_PipelineState* pipelineState | 管线状态的输出参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioSuitePipeline为空指针等。 AUDIOSUITE_ERROR_PIPELINE_NOT_EXIST：管线不存在或已经被销毁。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_RenderFrame()
OH_AudioSuite_Result OH_AudioSuiteEngine_RenderFrame(OH_AudioSuitePipeline* audioSuitePipeline, void* audioData, int32_t requestFrameSize, int32_t* responseSize, bool* finishedFlag)
描述
应用调用此接口获取管线处理后的音频数据（针对单输出效果节点）。
说明：
应用程序需调用此接口获取经过效果处理后的音频数据。
- 调用后，管线会从输出节点向前依次拉取数据、应用效果处理，
- 最终将处理后的数据填充到应用程序传入的audioData指针中。
- 系统会尝试按requestFrameSize请求的大小填充数据，实际处理的数据大小通过responseSize返回给应用程序。
- 当应用程序为所有输入节点准备好数据并通过回调提交最后一次数据时，应在回调中设置finish标志位。
- 当管线中所有输入都传递了finish标志后，处理完成后会通过finishedFlag通知应用程序。
- 若finishedFlag为true，应用程序不应再调用此接口。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuitePipeline* audioSuitePipeline | 音频编创管线句柄。通过OH_AudioSuiteEngine_CreatePipeline获取句柄。 |
| void* audioData | 获取音频需要写入的数据地址。 |
| int32_t requestFrameSize | audioData的内存字节大小，需大于0。 |
| int32_t* responseSize | 管线写入audioData的音频数据大小，不会大于requestFrameSize，单位为字节。 |
| bool* finishedFlag | 标识当前管线是否渲染完成。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数为空指针或无效值。 可能的原因如下： 1. 参数audioSuitePipeline为空指针； 2. 参数audioData为空指针； 3. 参数requestFrameSize小于等于0； 4. 参数responseSize为空指针； 5. 参数finishedFlag为空指针。 AUDIOSUITE_ERROR_PIPELINE_NOT_EXIST：管线不存在或已经被销毁。 AUDIOSUITE_ERROR_INVALID_STATE：管线不在运行状态。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：管线渲染已完成（之前调用该接口时finishedFlag已写入为true）。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_MultiRenderFrame()
OH_AudioSuite_Result OH_AudioSuiteEngine_MultiRenderFrame(OH_AudioSuitePipeline* audioSuitePipeline, OH_AudioDataArray* audioDataArray, int32_t* responseSize, bool* finishedFlag)
描述
渲染该管线，获取管线处理后的音频数据。针对多输出效果节点，比如包含音源分离节点的管线，audioDataArray的大小需与效果节点的输出数量一一对应（例如：音源分离节点需两个：第1个为人声，第2个为背景声）。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuitePipeline* audioSuitePipeline | 音频编创管线句柄。通过OH_AudioSuiteEngine_CreatePipeline获取句柄。 |
| OH_AudioDataArray* audioDataArray | 用户读取音频数据时所使用的数组指针，每个一维数组大小需一致。 |
| int32_t* responseSize | 管线写入audioData的音频数据大小。系统会确保每个一维数组被填充的数据大小一致，单位为字节。 |
| bool* finishedFlag | 标记当前管线是否渲染完成。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数为空指针或无效值。 可能的原因如下： 1. 参数audioSuitePipeline为空指针； 2. 参数audioDataArray为空指针； 3. 参数audioDataArray中的某个成员为空指针； 4. 参数audioDataArray中的requestFrameSize小于等于0； 5. 参数responseSize为空指针； 6. 参数finishedFlag为空指针。 AUDIOSUITE_ERROR_PIPELINE_NOT_EXIST：管线不存在或已经被销毁。 AUDIOSUITE_ERROR_INVALID_STATE：管线不在运行状态。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：管线渲染已完成（之前调用该接口时finishedFlag已写入为true）。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteNodeBuilder_Create()
OH_AudioSuite_Result OH_AudioSuiteNodeBuilder_Create(OH_AudioNodeBuilder** builder)
描述
获取一个音频编创节点构造器，用于配置并创建音频节点。构建器可复用，但若新节点属性与之前不同，必须使用OH_AudioSuiteNodeBuilder_Reset重置。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNodeBuilder** builder | 音频编创节点构造器句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，builder为空指针。 AUDIOSUITE_ERROR_MEMORY_ALLOC_FAILED：内存申请失败。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteNodeBuilder_Destroy()
OH_AudioSuite_Result OH_AudioSuiteNodeBuilder_Destroy(OH_AudioNodeBuilder* builder)
描述
销毁一个音频编创节点构造器。使用完构造器后必须调用此函数进行销毁。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNodeBuilder* builder | 音频编创节点构造器句柄。通过OH_AudioSuiteNodeBuilder_Create获取句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，builder为空指针。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteNodeBuilder_Reset()
OH_AudioSuite_Result OH_AudioSuiteNodeBuilder_Reset(OH_AudioNodeBuilder* builder)
描述
重置一个音频编创节点构造器，同时将之前使用接口设置参数重置。若需复用构建器创建属性不同的新节点，必须调用此接口清除所有属性（如节点类型等）。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNodeBuilder* builder | 音频编创节点构造器句柄。通过OH_AudioSuiteNodeBuilder_Create获取句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，builder为空指针。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteNodeBuilder_SetNodeType()
OH_AudioSuite_Result OH_AudioSuiteNodeBuilder_SetNodeType(OH_AudioNodeBuilder* builder, OH_AudioNode_Type type)
描述
设置当前节点构造器需要构造的节点类型。创建节点时会根据类型验证其他参数，所有节点类型的创建均需设置此属性。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNodeBuilder* builder | 音频编创节点构造器句柄。通过OH_AudioSuiteNodeBuilder_Create获取句柄。 |
| OH_AudioNode_Type type | 节点类型。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：配置节点类型成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效，例如，builder为空指针。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteNodeBuilder_SetFormat()
OH_AudioSuite_Result OH_AudioSuiteNodeBuilder_SetFormat(OH_AudioNodeBuilder* builder, OH_AudioFormat audioFormat)
描述
配置输入/输出节点的音频格式。其余节点不配置，且只能在创建节点之前使用。对于输入节点，此函数可使应用指定写入数据的音频格式；
对于输出节点，此函数可使应用指定其期望获取数据的音频格式；
对于其他类型的节点则不支持调用此函数进行音频格式设置。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNodeBuilder* builder | 音频编创节点构造器句柄。通过OH_AudioSuiteNodeBuilder_Create获取句柄。 |
| OH_AudioFormat audioFormat | 音频流格式。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效，例如，builder为空指针。 AUDIOSUITE_ERROR_UNSUPPORTED_FORMAT：audioFormat中的channelCount不支持。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_InputNode_RequestDataCallback()
typedef int32_t (*OH_InputNode_RequestDataCallback)(OH_AudioNode* audioNode, void* userData, void* audioData, int32_t audioDataSize, bool* finished)
描述
配置输入节点的请求数据回调函数。
说明：
用户把需要处理的PCM音频数据写入到audioData，OHAudioSuite从audioData拿到数据进行音频编创。
- 应用程序在此回调中向audioData写入不超过audioDataSize大小的数据。
- 当所有数据通过回调传递给管线后，应用程序应在最后一次回调中将finished设为true，此后管线不再调用此接口。
- 只有输入节点需要配置，其余节点不配置。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| void* userData | 用户使用的数据指针。系统调用此回调函数时，将使用OH_AudioSuiteNodeBuilder_SetRequestDataCallback接口传入的userData。 |
| void* audioData | 系统提供的内存地址，用于将需要处理的音频数据流写入（需由用户填充）。 |
| int32_t audioDataSize | audioData内存地址的字节大小。 |
| bool* finished | 标记audioNode节点需要处理的音频数据流是否已经写入完成。true表示已完成，false表示未完成。 |
返回：
| 类型 | 说明 |
|---|---|
| int32_t | 写入audioData缓冲区的有效数据长度（单位为字节）。 返回值范围必须在[0, audioDataSize]范围内，如果返回值小于0，系统会将其修改为0， 如果返回值大于audioDataSize，系统会将其修改为audioDataSize。 |
OH_AudioSuiteNodeBuilder_SetRequestDataCallback()
OH_AudioSuite_Result OH_AudioSuiteNodeBuilder_SetRequestDataCallback(OH_AudioNodeBuilder* builder, OH_InputNode_RequestDataCallback callback, void* userData)
描述
配置当前输入节点构造器的写入音频数据回调函数。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNodeBuilder* builder | 音频编创节点构造器句柄。通过OH_AudioSuiteNodeBuilder_Create获取句柄。 |
| OH_InputNode_RequestDataCallback callback | 写入当前节点音频数据的回调接口。 |
| void* userData | 用户自定义数据，会在callback函数中将地址传入给用户，如果不使用，可以传入空指针。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM： 可能的原因如下： 1. 参数builder为空指针； 2. 参数callback为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_CreateNode()
OH_AudioSuite_Result OH_AudioSuiteEngine_CreateNode(OH_AudioSuitePipeline* audioSuitePipeline, OH_AudioNodeBuilder* builder, OH_AudioNode** audioNode)
描述
根据音频编创构造器在音频管线中构造一个音频节点。当执行此函数，系统会基于builder中设置的节点类型校验参数的合法性。
应用可以通过返回值确定错误发生的原因。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioSuitePipeline* audioSuitePipeline | 音频编创管线句柄。通过OH_AudioSuiteEngine_CreatePipeline获取句柄。 |
| OH_AudioNodeBuilder* builder | 音频编创节点构造器句柄。通过OH_AudioSuiteNodeBuilder_Create获取句柄。 |
| OH_AudioNode** audioNode | 音频编创节点句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数为空指针或无效值。 可能的原因如下： 1. 参数audioSuitePipeline为空指针； 2. 参数builder为空指针； 3. 参数audioNode为空指针。 AUDIOSUITE_ERROR_CREATED_EXCEED_SYSTEM_LIMITS：当构建当前类型的节点数量超过管线限制。 例如，创建效果类节点超过5个。 AUDIOSUITE_ERROR_REQUIRED_PARAMETERS_MISSING：构建builder中type类型的节点时缺少必要参数。 例如，builder未设置节点类型。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：当前构造器节点类型为输出节点但设置了回调函数， 或构造器节点类型为效果节点但设置了音频格式或回调函数。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_MEMORY_ALLOC_FAILED：内存申请失败。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_DestroyNode()
OH_AudioSuite_Result OH_AudioSuiteEngine_DestroyNode(OH_AudioNode* audioNode)
描述
销毁一个音频编创节点。节点是否可以被销毁取决于它所属管线的状态，如果管线不处于OH_AudioSuite_PipelineState.AUDIOSUITE_PIPELINE_STOPPED停止状态，而节点处于管线处理路径中，将销毁失败。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数audioNode为空指针。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_INVALID_STATE：管线不在停止状态。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetNodeBypassStatus()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetNodeBypassStatus(OH_AudioNode* audioNode, bool* bypassStatus)
描述
获取当前节点的效果使能状态。仅效果节点支持获取。
若对输入或输出节点调用此接口，将返回AUDIOSUITE_ERROR_INVALID_PARAM错误码。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| bool* bypassStatus | 获取当前效果类节点使能状态，false表示未跳过节点处理，true表示已跳过节点处理。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM： 参数audioNode或bypassStatus为空指针。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非效果类节点。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_BypassEffectNode()
OH_AudioSuite_Result OH_AudioSuiteEngine_BypassEffectNode(OH_AudioNode* audioNode, bool bypass)
描述
设置当前节点的效果使能状态（仅效果节点支持）。当bypass为true时，效果节点仅透传数据，不进行任何效果处理。
当bypass为false时，效果节点进行对应的效果处理。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| bool bypass | 当前效果类节点使能状态。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数audioNode为空指针。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode为非效果节点。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetAudioFormat()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetAudioFormat(OH_AudioNode* audioNode, OH_AudioFormat *audioFormat)
描述
配置输入/输出节点的音频格式，在创建节点之后使用，只有输入和输出节点能够设置。输入节点指定音源格式，输出节点指定目标格式。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioFormat *audioFormat | 音频流格式。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数audioNode或audioFormat为空指针。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode是效果节点。 AUDIOSUITE_ERROR_INVALID_STATE：管线不在停止状态。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_ConnectNodes()
OH_AudioSuite_Result OH_AudioSuiteEngine_ConnectNodes(OH_AudioNode* sourceAudioNode, OH_AudioNode* destAudioNode)
描述
连接两个节点，数据流走向从sourceAudioNode到destAudioNode。连接节点将改变管道拓扑，可能导致部分数据丢失，建议在引擎停止状态下执行此操作。
节点连接顺序：输入节点 -> 效果节点 -> 输出节点。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* sourceAudioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioNode* destAudioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数sourceAudioNode或destAudioNode为空指针。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_CONNECT：节点之间不支持连接。 可能的原因如下： 1. 参数sourceAudioNode类型为输出类型节点； 2. 参数destAudioNode为类型为输入类型节点； 3. 参数sourceAudioNode和destAudioNode为同一个节点； 4. 参数sourceAudioNode为音源分离类型，但是destAudioNode类型不为输出类型接节点； 5. 参数sourceAudioNode和destAudioNode不为同一个管线中的节点； 6. 管线状态为运行状态，但是destAudioNode不为mix类型节点； 7. 管线状态为运行状态，destAudioNode为mix类型节点，但是sourceAudioNode节点未连接输入类型节点。 AUDIOSUITE_ERROR_INVALID_STATE：管线为无效状态。例如，无法找到输出节点。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_DisconnectNodes()
OH_AudioSuite_Result OH_AudioSuiteEngine_DisconnectNodes(OH_AudioNode* sourceAudioNode, OH_AudioNode* destAudioNode)
描述
断开连接两个节点。此操作将改变管道拓扑并可能导致数据丢失，建议在引擎停止状态下执行。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* sourceAudioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioNode* destAudioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：参数sourceAudioNode或destAudioNode为空指针。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：不支持操作。 可能的原因如下： 1. 参数sourceAudioNode类型为输出类型节点； 2. 参数destAudioNode为类型为输入类型节点； 3. 参数sourceAudioNode和destAudioNode为同一个节点； 4. 参数sourceAudioNode和destAudioNode不为同一个管线中的节点； 5. 管线状态为运行状态，但是destAudioNode不为mix类型节点； 6. 管线状态为运行状态，destAudioNode为mix类型节点，但是mix节点当前只连接了sourceAudioNode一个输入。 AUDIOSUITE_ERROR_INVALID_STATE：管线为无效状态。例如，无法找到输出节点。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetEqualizerFrequencyBandGains()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetEqualizerFrequencyBandGains(OH_AudioNode* audioNode, OH_EqualizerFrequencyBandGains frequencyBandGains)
描述
设置当前均衡器节点的频段增益效果。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_EqualizerFrequencyBandGains frequencyBandGains | 均衡器节点的均衡参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非均衡器节点。 AUDIOSUITE_ERROR_INVALID_PARAM： 可能的原因如下： 1. 参数audioNode为空指针； 2. 参数frequencyBandGains每个成员的值范围不在[-10, 10]。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetEqualizerFrequencyBandGains()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetEqualizerFrequencyBandGains(OH_AudioNode* audioNode, OH_EqualizerFrequencyBandGains* frequencyBandGains)
描述
获取当前均衡器节点的频段增益效果。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_EqualizerFrequencyBandGains* frequencyBandGains | 均衡器节点的均衡参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非均衡器节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode或frequencyBandGains为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetSoundFieldType()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetSoundFieldType(OH_AudioNode* audioNode, OH_SoundFieldType soundFieldType)
描述
设置声场效果节点的配置参数。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_SoundFieldType soundFieldType | 声场效果节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非声场节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetSoundFieldType()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetSoundFieldType(OH_AudioNode* audioNode, OH_SoundFieldType* soundFieldType)
描述
获取声场效果节点的配置参数。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_SoundFieldType* soundFieldType | 声场效果节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非soundFieldType节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode或soundFieldType为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetEnvironmentType()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetEnvironmentType(OH_AudioNode* audioNode, OH_EnvironmentType environmentType)
描述
设置环境效果节点的配置参数。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_EnvironmentType environmentType | 环境效果节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非环境节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetEnvironmentType()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetEnvironmentType(OH_AudioNode* audioNode, OH_EnvironmentType* environmentType)
描述
获取环境效果节点的配置参数。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_EnvironmentType* environmentType | 环境效果节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非环境效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode或environmentType为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetVoiceBeautifierType()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetVoiceBeautifierType(OH_AudioNode* audioNode, OH_VoiceBeautifierType voiceBeautifierType)
描述
设置声音美化效果节点的配置参数。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_VoiceBeautifierType voiceBeautifierType | 声音美化效果节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非声音美化效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetVoiceBeautifierType()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetVoiceBeautifierType(OH_AudioNode* audioNode, OH_VoiceBeautifierType* voiceBeautifierType)
描述
获取声音美化效果节点的配置参数。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_VoiceBeautifierType* voiceBeautifierType | 声音美化效果节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非声音美化效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。 例如，audioNode或voiceBeautifierType为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_IsNodeTypeSupported()
OH_AudioSuite_Result OH_AudioSuiteEngine_IsNodeTypeSupported(OH_AudioNode_Type nodeType, bool* isSupported)
描述
查询当前系统是否支持创建指定的节点类型，避免节点创建失败。调用该接口时不依赖引擎及管线状态，仅跟系统相关，无需创建引擎及管线。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode_Type nodeType | 待查的节点类型。 |
| bool* isSupported | 表示是否支持当前节点的创建。false表示未支持，true表示已支持。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：查询函数执行成功。 AUDIOSUITE_ERROR_INVALID_PARAM：传入非法参数。 例如，入参nodeType不在OH_AudioNode_Type枚举类型范围内、isSupported为空指针等。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetSpaceRenderPositionParams()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetSpaceRenderPositionParams(OH_AudioNode* audioNode, OH_AudioSuite_SpaceRenderPositionParams position)
描述
设置空间渲染效果节点固定摆位模式的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_SpaceRenderPositionParams position | 空间渲染效果节点固定摆位模式的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非空间渲染效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetSpaceRenderPositionParams()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetSpaceRenderPositionParams(OH_AudioNode* audioNode, OH_AudioSuite_SpaceRenderPositionParams* position)
描述
获取空间渲染效果节点固定摆位模式的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_SpaceRenderPositionParams* position | 空间渲染效果节点固定摆位模式的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非空间渲染效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetSpaceRenderRotationParams()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetSpaceRenderRotationParams(OH_AudioNode* audioNode, OH_AudioSuite_SpaceRenderRotationParams rotation)
描述
设置空间渲染效果节点旋转模式的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_SpaceRenderRotationParams rotation | 空间渲染效果节点旋转模式的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非空间渲染效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetSpaceRenderRotationParams()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetSpaceRenderRotationParams(OH_AudioNode* audioNode, OH_AudioSuite_SpaceRenderRotationParams* rotation)
描述
获取空间渲染效果节点旋转模式的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_SpaceRenderRotationParams* rotation | 空间渲染效果节点旋转模式的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非空间渲染效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetSpaceRenderExtensionParams()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetSpaceRenderExtensionParams(OH_AudioNode* audioNode, OH_AudioSuite_SpaceRenderExtensionParams extension)
描述
设置空间渲染效果节点扩展模式的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_SpaceRenderExtensionParams extension | 空间渲染效果节点扩展模式的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非空间渲染效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetSpaceRenderExtensionParams()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetSpaceRenderExtensionParams(OH_AudioNode* audioNode, OH_AudioSuite_SpaceRenderExtensionParams* extension)
描述
获取空间渲染效果节点扩展模式的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_SpaceRenderExtensionParams* extension | 空间渲染效果节点扩展模式的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非空间渲染效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetTempoAndPitch()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetTempoAndPitch(OH_AudioNode* audioNode, float speed, float pitch)
描述
设置变速变调效果节点的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| float speed | 变速参数。取值范围为[0.5, 10.0]。 |
| float pitch | 变调参数。取值范围为[0.1, 5.0]。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非变速变调效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetTempoAndPitch()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetTempoAndPitch(OH_AudioNode* audioNode, float* speed, float* pitch)
描述
获取变速变调效果节点的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| float* speed | 变速参数。取值范围为[0.5, 10.0]。 |
| float* pitch | 变调参数。取值范围为[0.1, 5.0]。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非变速变调效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetPureVoiceChangeOption()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetPureVoiceChangeOption(OH_AudioNode* audioNode, OH_AudioSuite_PureVoiceChangeOption option)
描述
设置传统变声节点的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_PureVoiceChangeOption option | 传统变声效果节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非传统变声效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetPureVoiceChangeOption()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetPureVoiceChangeOption(OH_AudioNode* audioNode, OH_AudioSuite_PureVoiceChangeOption* option)
描述
获取传统变声节点的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_PureVoiceChangeOption* option | 传统变声效果节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非传统变声效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_SetGeneralVoiceChangeType()
OH_AudioSuite_Result OH_AudioSuiteEngine_SetGeneralVoiceChangeType(OH_AudioNode* audioNode, OH_AudioSuite_GeneralVoiceChangeType type)
描述
设置通用变声节点的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_GeneralVoiceChangeType type | 通用变声节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非通用变声效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
OH_AudioSuiteEngine_GetGeneralVoiceChangeType()
OH_AudioSuite_Result OH_AudioSuiteEngine_GetGeneralVoiceChangeType(OH_AudioNode* audioNode, OH_AudioSuite_GeneralVoiceChangeType* type)
描述
获取通用变声节点的配置参数。
起始版本： 23
参数：
| 参数项 | 描述 |
|---|---|
| OH_AudioNode* audioNode | 音频编创节点句柄。通过OH_AudioSuiteEngine_CreateNode获取句柄。 |
| OH_AudioSuite_GeneralVoiceChangeType* type | 通用变声节点的配置参数。 |
返回：
| 类型 | 说明 |
|---|---|
| OH_AudioSuite_Result | AUDIOSUITE_SUCCESS：函数执行成功。 AUDIOSUITE_ERROR_NODE_NOT_EXIST：节点不存在或者当前节点已经被销毁。 AUDIOSUITE_ERROR_UNSUPPORTED_OPERATION：audioNode节点类型为非通用变声效果节点。 AUDIOSUITE_ERROR_INVALID_PARAM：参数无效。例如，audioNode为空指针。 AUDIOSUITE_ERROR_TIMEOUT：操作处理超时。 AUDIOSUITE_ERROR_SYSTEM：系统发生其他异常。 |
你可能感兴趣的鸿蒙文章
openharmony 鸿蒙 capi-native-audiostreambuilder-h
openharmony 鸿蒙 capi-ohaudiosuite
openharmony 鸿蒙 js-apis-inner-multimedia-systemSoundPlayer
openharmony 鸿蒙 arkts-apis-audio-i
openharmony 鸿蒙 arkts-apis-audio-AudioManager
openharmony 鸿蒙 capi-ohaudiosuite-oh-audiosuite-spacerenderpositionparams