• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# native_audio_stream_manager.h
2<!--Kit: Audio Kit-->
3<!--Subsystem: Multimedia-->
4<!--Owner: @songshenke-->
5<!--Designer: @caixuejiang; @hao-liangfei; @zhanganxiang-->
6<!--Tester: @Filger-->
7<!--Adviser: @zengyawen-->
8
9## 概述
10
11声明与音频流管理器相关的接口。<br> 该文件接口用于创建audioStreamManager以及音频流设置和管理。
12
13**引用文件:** <ohaudio/native_audio_stream_manager.h>
14
15**库:** libohaudio.so
16
17**系统能力:** SystemCapability.Multimedia.Audio.Core
18
19**起始版本:** 19
20
21**相关模块:** [OHAudio](capi-ohaudio.md)
22
23## 汇总
24
25### 结构体
26
27| 名称 | typedef关键字 | 描述 |
28| -- | -- | -- |
29| [OH_AudioStreamManager](capi-ohaudio-oh-audiostreammanager.md) | OH_AudioStreamManager | 声明音频流管理器,用于管理音频流相关功能。 |
30
31### 函数
32
33| 名称 | 描述 |
34| -- | -- |
35| [OH_AudioCommon_Result OH_AudioManager_GetAudioStreamManager(OH_AudioStreamManager **streamManager)](#oh_audiomanager_getaudiostreammanager) | 获取音频流管理器句柄。 |
36| [OH_AudioCommon_Result OH_AudioStreamManager_GetDirectPlaybackSupport(OH_AudioStreamManager *audioStreamManager, OH_AudioStreamInfo *streamInfo, OH_AudioStream_Usage usage, OH_AudioStream_DirectPlaybackMode *directPlaybackMode)](#oh_audiostreammanager_getdirectplaybacksupport) | 获取当前音频流支持的direct通路播放模式。 |
37| [OH_AudioCommon_Result OH_AudioStreamManager_IsAcousticEchoCancelerSupported(OH_AudioStreamManager *streamManager, OH_AudioStream_SourceType sourceType, bool *supported)](#oh_audiostreammanager_isacousticechocancelersupported) | 查询指定的录音流类型使用场景是否支持回声消除。 |
38| [bool OH_AudioStreamManager_IsFastPlaybackSupported(OH_AudioStreamManager *streamManager, OH_AudioStreamInfo *streamInfo, OH_AudioStream_Usage usage)](#oh_audiostreammanager_isfastplaybacksupported) | 查询当前设备在特定音频流信息和使用场景下是否支持低时延播放。 |
39| [bool OH_AudioStreamManager_IsFastRecordingSupported(OH_AudioStreamManager *streamManager, OH_AudioStreamInfo *streamInfo, OH_AudioStream_SourceType source)](#oh_audiostreammanager_isfastrecordingsupported) | 查询当前设备在特定音频流信息和使用场景下是否支持低时延录制。 |
40
41## 函数说明
42
43### OH_AudioManager_GetAudioStreamManager()
44
45```
46OH_AudioCommon_Result OH_AudioManager_GetAudioStreamManager(OH_AudioStreamManager **streamManager)
47```
48
49**描述**
50
51获取音频流管理器句柄。
52
53**起始版本:** 19
54
55
56**参数:**
57
58| 参数项 | 描述 |
59| -- | -- |
60| [OH_AudioStreamManager](capi-ohaudio-oh-audiostreammanager.md) **streamManager | 音频流管理器句柄。 |
61
62**返回:**
63
64| 类型 | 说明 |
65| -- | -- |
66| [OH_AudioCommon_Result](capi-native-audio-common-h.md#oh_audiocommon_result) | AUDIOCOMMON_RESULT_SUCCESS = 0:函数执行成功。<br>         AUDIOCOMMON_RESULT_ERROR_SYSTEM = 6800301:系统状态错误。 |
67
68### OH_AudioStreamManager_GetDirectPlaybackSupport()
69
70```
71OH_AudioCommon_Result OH_AudioStreamManager_GetDirectPlaybackSupport(OH_AudioStreamManager *audioStreamManager, OH_AudioStreamInfo *streamInfo, OH_AudioStream_Usage usage, OH_AudioStream_DirectPlaybackMode *directPlaybackMode)
72```
73
74**描述**
75
76获取当前音频流支持的direct通路播放模式。
77
78**起始版本:** 19
79
80
81**参数:**
82
83| 参数项 | 描述 |
84| -- | -- |
85| [OH_AudioStreamManager](capi-ohaudio-oh-audiostreammanager.md) *audioStreamManager | 音频流管理器句柄。通过 [OH_AudioManager_GetAudioStreamManager](capi-native-audio-stream-manager-h.md#oh_audiomanager_getaudiostreammanager)获取句柄。 |
86| [OH_AudioStreamInfo](capi-ohaudio-oh-audiostreaminfo.md) *streamInfo | 音频流信息指针。 |
87| [OH_AudioStream_Usage](capi-native-audiostream-base-h.md#oh_audiostream_usage) usage | 音频流使用场景。 |
88| [OH_AudioStream_DirectPlaybackMode](capi-native-audiostream-base-h.md#oh_audiostream_directplaybackmode) *directPlaybackMode | 指向 [OH_AudioStream_DirectPlaybackMode](capi-native-audiostream-base-h.md#oh_audiostream_directplaybackmode),用于获取当前音频流支持的direct通路播放模式。 |
89
90**返回:**
91
92| 类型 | 说明 |
93| -- | -- |
94| [OH_AudioCommon_Result](capi-native-audio-common-h.md#oh_audiocommon_result) | AUDIOCOMMON_RESULT_SUCCESS = 0:函数执行成功。<br>         AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM = 6800101:<br>                                                        1. 参数audioStreamManager为nullptr;<br>                                                        2. 参数streamInfo为nullptr;<br>                                                        3. 参数usage无效;<br>                                                        4. 参数directPlaybackMode为nullptr。 |
95
96### OH_AudioStreamManager_IsAcousticEchoCancelerSupported()
97
98```
99OH_AudioCommon_Result OH_AudioStreamManager_IsAcousticEchoCancelerSupported(OH_AudioStreamManager *streamManager, OH_AudioStream_SourceType sourceType, bool *supported)
100```
101
102**描述**
103
104查询指定的录音流类型使用场景是否支持回声消除。
105
106**起始版本:** 20
107
108
109**参数:**
110
111| 参数项 | 描述 |
112| -- | -- |
113| [OH_AudioStreamManager](capi-ohaudio-oh-audiostreammanager.md) *streamManager | 音频流管理器句柄。通过 [OH_AudioManager_GetAudioStreamManager](capi-native-audio-stream-manager-h.md#oh_audiomanager_getaudiostreammanager)获取句柄。 |
114| [OH_AudioStream_SourceType](capi-native-audiostream-base-h.md#oh_audiostream_sourcetype) sourceType | 指向[OH_AudioStream_SourceType](capi-native-audiostream-base-h.md#oh_audiostream_sourcetype),用于设置音频输入流的使用场景。 |
115| bool *supported | 查询指定的source type是否支持回声消除的结果。true表示支持回声消除,false表示不支持回声消除。 |
116
117**返回:**
118
119| 类型 | 说明 |
120| -- | -- |
121| [OH_AudioCommon_Result](capi-native-audio-common-h.md#oh_audiocommon_result) | AUDIOCOMMON_RESULT_SUCCESS = 0 :函数执行成功。<br>          AUDIOCOMMON_RESULT_ERROR_INVALID_PARAM = 6800101 :<br>                                                    1.参数audioStreamManager为nullptr;<br>                                                    2.参数sourceType无效;<br>                                                    3.参数supported为nullptr。 |
122
123### OH_AudioStreamManager_IsFastPlaybackSupported()
124
125```
126bool OH_AudioStreamManager_IsFastPlaybackSupported(OH_AudioStreamManager *streamManager, OH_AudioStreamInfo *streamInfo, OH_AudioStream_Usage usage)
127```
128
129**描述**
130
131查询当前设备在特定音频流信息和使用场景下是否支持低时延播放。
132
133**起始版本:** 20
134
135
136**参数:**
137
138| 参数项 | 描述 |
139| -- | -- |
140| [OH_AudioStreamManager](capi-ohaudio-oh-audiostreammanager.md) *streamManager | 音频流管理器句柄。通过[OH_AudioManager_GetAudioStreamManager](capi-native-audio-stream-manager-h.md#oh_audiomanager_getaudiostreammanager)获取句柄。 |
141| [OH_AudioStreamInfo](capi-ohaudio-oh-audiostreaminfo.md) *streamInfo | 音频流信息指针。 |
142| [OH_AudioStream_Usage](capi-native-audiostream-base-h.md#oh_audiostream_usage) usage | 音频流使用场景。 |
143
144**返回:**
145
146| 类型 | 说明 |
147| -- | -- |
148| bool | 返回true时表示支持低时延播放,返回false时表示不支持。 |
149
150### OH_AudioStreamManager_IsFastRecordingSupported()
151
152```
153bool OH_AudioStreamManager_IsFastRecordingSupported(OH_AudioStreamManager *streamManager, OH_AudioStreamInfo *streamInfo, OH_AudioStream_SourceType source)
154```
155
156**描述**
157
158查询当前设备在特定音频流信息和使用场景下是否支持低时延录制。
159
160**起始版本:** 20
161
162
163**参数:**
164
165| 参数项 | 描述 |
166| -- | -- |
167| [OH_AudioStreamManager](capi-ohaudio-oh-audiostreammanager.md) *streamManager | 音频流管理器句柄。通过[OH_AudioManager_GetAudioStreamManager](capi-native-audio-stream-manager-h.md#oh_audiomanager_getaudiostreammanager)获取句柄。 |
168| [OH_AudioStreamInfo](capi-ohaudio-oh-audiostreaminfo.md) *streamInfo | 音频流信息指针。 |
169| [OH_AudioStream_SourceType](capi-native-audiostream-base-h.md#oh_audiostream_sourcetype) source | 音频流使用场景。 |
170
171**返回:**
172
173| 类型 | 说明 |
174| -- | -- |
175| bool | 返回true时表示支持低时延录制,返回false时表示不支持。 |
176
177
178