1# HdiEffect
2
3
4## 概述
5
6Effect模块接口定义。
7
8音效接口涉及数据类型、音效模型接口、音效控制器接口等。
9
10**起始版本：** 4.0
11
12
13## 汇总
14
15
16### 文件
17
18| 名称 | 描述 |
19| -------- | -------- |
20| [EffectTypes.idl](_effect_types_8idl.md) | Effect模块接口定义中使用的数据类型。 |
21| [IEffectControl.idl](_i_effect_control_8idl.md) | 音效控制器的接口定义文件。 |
22| [IEffectModel.idl](_i_effect_model_8idl.md) | 音效模型的接口定义文件。 |
23
24
25### 类
26
27| 名称 | 描述 |
28| -------- | -------- |
29| struct  [EffectInfo](_effect_info.md) | 定义effect加载的音效信息。 |
30| struct  [ControllerId](_controller_id.md) | 定义效果控制器信息，包括其所属的库及其effectId。 |
31| struct  [EffectControllerDescriptor](_effect_controller_descriptor.md) | 定义音效控制器描述 |
32| struct  [AudioEffectBuffer](_audio_effect_buffer.md) | 定义音效进程输入输出buffer。 |
33| interface  [IEffectControl](interface_i_effect_control.md) | 音效控制器接口。 |
34| interface  [IEffectModel](interface_i_effect_model.md) | 音效模型接口。 |
35
36
37### 枚举
38
39| 名称 | 描述 |
40| -------- | -------- |
41| [AudioEffectBufferTag](#audioeffectbuffertag) {<br/>EFFECT_BUFFER_VOID_TYPE = 0 , EFFECT_BUFFER_FLOAT_SIGNED_32 = 1 &lt;&lt; 0 , EFFECT_BUFFER_SINGED_32 = 1 &lt;&lt; 1 , EFFECT_BUFFER_SIGNED_16 = 1 &lt;&lt; 2 , EFFECT_BUFFER_UNSIGNED_8 = 1 &lt;&lt; 3<br/>} | 数据点类型标记，该类型正在按需使用。 |
42| [EffectCommandTableIndex](#effectcommandtableindex) {<br/>AUDIO_EFFECT_COMMAND_INIT_CONTOLLER , AUDIO_EFFECT_COMMAND_SET_CONFIG , AUDIO_EFFECT_COMMAND_GET_CONFIG , AUDIO_EFFECT_COMMAND_RESET , AUDIO_EFFECT_COMMAND_ENABLE , AUDIO_EFFECT_COMMAND_DISABLE , AUDIO_EFFECT_COMMAND_SET_PARAM , AUDIO_EFFECT_COMMAND_GET_PARAM<br/>} | 定义音效控制器命令索引。 |
43
44
45## 枚举类型说明
46
47
48### AudioEffectBufferTag
49
50```
51enum AudioEffectBufferTag
52```
53
54**描述**
55
56数据点类型标记，该类型正在按需使用。
57
58**起始版本：** 4.0
59
60| 枚举值 | 描述 |
61| -------- | -------- |
62| EFFECT_BUFFER_VOID_TYPE | raw模式音频数据指向缓冲区的起点 |
63| EFFECT_BUFFER_FLOAT_SIGNED_32 | 32bit浮点型音频数据指向缓冲区的起点 |
64| EFFECT_BUFFER_SINGED_32 | 32bit整型音频数据指向缓冲区的起点 |
65| EFFECT_BUFFER_SIGNED_16 | 16bit整型音频数据指向缓冲区的起点 |
66| EFFECT_BUFFER_UNSIGNED_8 | 8bit无符号整型音频数据指向缓冲区的起点 |
67
68
69### EffectCommandTableIndex
70
71```
72enum EffectCommandTableIndex
73```
74
75**描述**
76
77定义音效控制器命令索引。
78
79**起始版本：** 4.0
80
81| 枚举值 | 描述 |
82| -------- | -------- |
83| AUDIO_EFFECT_COMMAND_INIT_CONTOLLER | 初始化音效控制器 |
84| AUDIO_EFFECT_COMMAND_SET_CONFIG | 设置配置参数 |
85| AUDIO_EFFECT_COMMAND_GET_CONFIG | 获取配置参数 |
86| AUDIO_EFFECT_COMMAND_RESET | 重启音效控制器 |
87| AUDIO_EFFECT_COMMAND_ENABLE | 使能音效 |
88| AUDIO_EFFECT_COMMAND_DISABLE | 禁用音效 |
89| AUDIO_EFFECT_COMMAND_SET_PARAM | 设置参数 |
90| AUDIO_EFFECT_COMMAND_GET_PARAM | 获取参数 |
91