• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AudioControl
2
3
4## **概述**
5
6AudioControl音频控制接口。
7
8提供音频播放(Render)或录音(Capture)需要的公共控制驱动能力,包括Start、Stop、Pause、Resume、Flush等。
9
10**Since:**
11
121.0
13
14**Version:**
15
161.0
17
18**相关模块:**
19
20[Audio](_audio.md)
21
22
23## **汇总**
24
25
26### Public 属性
27
28  | 名称 | 描述 |
29| -------- | -------- |
30| ([Start](#start))(AudioHandle handle) | 启动一个音频播放(Render)或录音(Capture)处理。 |
31| ([Stop](#stop))(AudioHandle handle) | 停止一个音频播放(Render)或录音(Capture)处理。 |
32| ([Pause](#pause))(AudioHandle handle) | 暂停一个音频播放(Render)或录音(Capture)处理。 |
33| ([Resume](#resume))(AudioHandle handle) | 恢复一个音频播放(Render)或录音(Capture)处理。 |
34| ([Flush](#flush))(AudioHandle handle) | 刷新音频缓冲区buffer中的数据。 |
35| ([TurnStandbyMode](#turnstandbymode))(AudioHandle handle) | 设置或去设置设备的待机模式。 |
36| ([AudioDevDump](#audiodevdump))(AudioHandle handle, int32_t range, int32_t fd) | Dump音频设备信息。 |
37
38
39## **类成员变量说明**
40
41
42### AudioDevDump
43
44
45```
46int32_t(* AudioControl::AudioDevDump) (AudioHandle handle, int32_t range, int32_t fd)
47```
48
49**描述:**
50
51Dump音频设备信息。
52
53**参数:**
54
55  | 名称 | 描述 |
56| -------- | -------- |
57| handle | 待操作的音频句柄 |
58| range | Dump信息范围,分为简要信息、全量信息 |
59| fd | 指定Dump目标文件 |
60
61**返回:**
62
63成功返回值0,失败返回负值。
64
65
66### Flush
67
68
69```
70int32_t(* AudioControl::Flush) (AudioHandle handle)
71```
72
73**描述:**
74
75刷新音频缓冲区buffer中的数据。
76
77**参数:**
78
79  | 名称 | 描述 |
80| -------- | -------- |
81| handle | 待操作的音频句柄 |
82
83**返回:**
84
85成功返回值0,失败返回负值。
86
87
88### Pause
89
90
91```
92int32_t(* AudioControl::Pause) (AudioHandle handle)
93```
94
95**描述:**
96
97暂停一个音频播放(Render)或录音(Capture)处理。
98
99**参数:**
100
101  | 名称 | 描述 |
102| -------- | -------- |
103| handle | 待操作的音频句柄 |
104
105**返回:**
106
107成功返回值0,失败返回负值。
108
109**参见:**
110
111[Resume](#resume)
112
113
114### Resume
115
116
117```
118int32_t(* AudioControl::Resume) (AudioHandle handle)
119```
120
121**描述:**
122
123恢复一个音频播放(Render)或录音(Capture)处理。
124
125**参数:**
126
127  | 名称 | 描述 |
128| -------- | -------- |
129| handle | 待操作的音频句柄 |
130
131**返回:**
132
133成功返回值0,失败返回负值。
134
135**参见:**
136
137[Pause](#pause)
138
139
140### Start
141
142
143```
144int32_t(* AudioControl::Start) (AudioHandle handle)
145```
146
147**描述:**
148
149启动一个音频播放(Render)或录音(Capture)处理。
150
151**参数:**
152
153  | 名称 | 描述 |
154| -------- | -------- |
155| handle | 待操作的音频句柄 |
156
157**返回:**
158
159成功返回值0,失败返回负值。
160
161**参见:**
162
163[Stop](#stop)
164
165
166### Stop
167
168
169```
170int32_t(* AudioControl::Stop) (AudioHandle handle)
171```
172
173**描述:**
174
175停止一个音频播放(Render)或录音(Capture)处理。
176
177**参数:**
178
179  | 名称 | 描述 |
180| -------- | -------- |
181| handle | 待操作的音频句柄 |
182
183**返回:**
184
185成功返回值0,失败返回负值。
186
187**参见:**
188
189[Start](#start)
190
191
192### TurnStandbyMode
193
194
195```
196int32_t(* AudioControl::TurnStandbyMode) (AudioHandle handle)
197```
198
199**描述:**
200
201设置或去设置设备的待机模式。
202
203**参数:**
204
205  | 名称 | 描述 |
206| -------- | -------- |
207| handle | 待操作的音频句柄 |
208
209**返回:**
210
211设置设备待机模式成功返回值0,再次执行后去设置待机模式成功返回正值,失败返回负值。
212