• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# IEffectControl
2
3
4## 概述
5
6音效控制器接口。
7
8提供音效控制器支持的驱动能力,包括音效数据处理、音效命令发送、获取当前音效描述符等。
9
10**起始版本:** 4.0
11
12**相关模块:**[HdiEffect](_hdi_effect.md)
13
14
15## 汇总
16
17
18### Public 成员函数
19
20| 名称 | 描述 |
21| -------- | -------- |
22| [EffectProcess](#effectprocess) ([in] struct [AudioEffectBuffer](_audio_effect_buffer.md) input, [out] struct [AudioEffectBuffer](_audio_effect_buffer.md) output) | 处理音频原始数据。必须指定输入和输出buffer,如果未指定,则进程必须使用命令提供的数据处理功能。 |
23| [SendCommand](#sendcommand) ([in] unsigned int cmdId, [in] byte[] cmdData, [out] byte[] replyData) | 发送音效处理命令 |
24| [GetEffectDescriptor](#geteffectdescriptor) ([out] struct [EffectControllerDescriptor](_effect_controller_descriptor.md) desc) | 获取音效的描述符 |
25| [EffectReverse](#effectreverse) ([in] struct [AudioEffectBuffer](_audio_effect_buffer.md) input, [out] struct [AudioEffectBuffer](_audio_effect_buffer.md) output) | 反转音频处理后的数据。必须指定输入和输出缓冲区,如果未指定,则反转必须使用命令提供的数据反转功能。 |
26
27
28## 成员函数说明
29
30
31### EffectProcess()
32
33```
34IEffectControl::EffectProcess ([in] struct AudioEffectBuffer input, [out] struct AudioEffectBuffer output )
35```
36
37**描述**
38
39处理音频原始数据。必须指定输入和输出buffer,如果未指定,则进程必须使用命令提供的数据处理功能。
40
41**起始版本:** 4.0
42
43**参数:**
44
45| 名称 | 描述 |
46| -------- | -------- |
47| control | 指向要操作的音效控件的指针 |
48| input | 输入数据的buffer |
49| output | 输出数据的buffer |
50
51**返回:**
52
53执行成功返回0,执行失败返回其他值
54
55
56### EffectReverse()
57
58```
59IEffectControl::EffectReverse ([in] struct AudioEffectBuffer input, [out] struct AudioEffectBuffer output )
60```
61
62**描述**
63
64反转音频处理后的数据。必须指定输入和输出缓冲区,如果未指定,则反转必须使用命令提供的数据反转功能。
65
66**起始版本:** 4.0
67
68**参数:**
69
70| 名称 | 描述 |
71| -------- | -------- |
72| control | 指向要操作的音效控件的指针 |
73| input | 输入数据buffer |
74| output | 输出数据buffer |
75
76**返回:**
77
78执行成功返回0,执行失败返回其他值
79
80
81### GetEffectDescriptor()
82
83```
84IEffectControl::GetEffectDescriptor ([out] struct EffectControllerDescriptor desc)
85```
86
87**描述**
88
89获取音效的描述符
90
91**起始版本:** 4.0
92
93**参数:**
94
95| 名称 | 描述 |
96| -------- | -------- |
97| control | 指向要操作的音效控件的指针 |
98| desc | 指定的音效描述符 |
99
100**返回:**
101
102执行成功返回0,执行失败返回其他值
103
104
105### SendCommand()
106
107```
108IEffectControl::SendCommand ([in] unsigned int cmdId, [in] byte[] cmdData, [out] byte[] replyData )
109```
110
111**描述**
112
113发送音效处理命令
114
115**起始版本:** 4.0
116
117**参数:**
118
119| 名称 | 描述 |
120| -------- | -------- |
121| control | 指向要操作的音效控件的指针 |
122| cmdId | 用于匹配命令表中的命令选项的命令索引 |
123| cmdData | 系统服务的数据 |
124| cmdDataLen | 数据长度 |
125| replyData | 返回的数据 |
126| replyDataLen | 数据长度 |
127
128**返回:**
129
130执行成功返回0,执行失败返回其他值
131