房间中音频模块接口. 更多...
类 AVDAudio 继承关系图:
类方法 | |
| (AVDAudio *) | + getAudio: |
| 获取音频功能模块对象 更多... | |
| (AVDResult) | + setSpeakerMode: |
| 设置耳麦模式 更多... | |
| (enum AVDSpeakerMode) | + getSpeakerMode |
| 获取耳麦模式 更多... | |
属性 | |
| id< AVDAudioDelegate > | delegate |
| 语音回调代理 更多... | |
| id< AVDAudioMixerDataDelegate > | mixerDataDelegate |
| 语音数据回调代理 更多... | |
 属性 继承自 AVDModule | |
| AVDRoom * | room |
| 房间对象指针 更多... | |
| AVDUserManager * | usermanager |
| 用户管理模块指针 更多... | |
| enum AVDModuleType | type |
| 模块类型 更多... | |
详细描述
房间中音频模块接口.
房间音频模块定义房间音频相关如麦克风、扬声器相关操作功能接口。
函数文档
◆ __attribute__()
| - (( unavailable("init is not a supported initializer for this class.") __attribute__ |
◆ closeMicrophone()
| - (AVDResult) closeMicrophone |
关闭本地麦克风发布到房间中
- 返回
- 返回错误代码。
- 注解
- 为异步操作，操作结果在 onCloseMicrophoneResult 中返回。
- 参见
- onCloseMicrophoneResult
◆ getAudio:()
◆ getMicrophoneStatus()
| - (enum AVDDeviceStatus) getMicrophoneStatus |
获取本地麦克风状态
- 返回
- 返回麦克风状态。
◆ getRemoteMicrophoneStatus:()
| - (enum AVDDeviceStatus) getRemoteMicrophoneStatus: | (AVDUserId) | userId |
remote microphone control
获取远端麦克风状态
- 参数
-
[in] userId 关联用户Id。
- 返回
- 返回麦克风状态。
◆ getSpeakerMode()
| + (enum AVDSpeakerMode) getSpeakerMode |
获取耳麦模式
◆ ismonitorAudioLevel()
| - (BOOL) ismonitorAudioLevel |
判断是否开启语音激励
◆ ismuteMicrophone()
| - (BOOL) ismuteMicrophone |
判断本地麦克风是否静默
◆ ismuteSpeaker()
| - (BOOL) ismuteSpeaker |
判断本地扬声器是否静默
◆ isOpenMicrophone()
| - (BOOL) isOpenMicrophone |
◆ monitorAudioLevel()
| - (AVDResult) monitorAudioLevel |
开启语音激励功能
- 返回
- 返回错误代码。
◆ muteMicrophone()
| - (AVDResult) muteMicrophone |
本地麦克风静默
- 返回
- 返回错误代码。
- 注解
- 麦克风静默表示本地没有声音发布到房间中，房间中用户不会听到本地的任何声音。
◆ muteSpeaker()
| - (AVDResult) muteSpeaker |
本地扬声器静默
- 返回
- 返回错误代码。
- 注解
- 扬声器静默表示房间中的声音不会在本地扬声器播放，本用户不会听到任何房间中的声音。
◆ openMicrophone()
| - (AVDResult) openMicrophone |
打开本地麦克风发布到房间中
- 返回
- 返回错误代码。
- 注解
- 为异步操作，操作结果在 onOpenMicrophoneResult 中返回。
- 参见
- onOpenMicrophoneResult
◆ playVoice:()
| - (AVDResult) playVoice: | (NSString *) | file |
开始播放声音文件
- 参数
-
[in] *file 本地音频文件。
- 返回
- 返回错误代码。
- 注解
- 用于测试扬声器是否工作正常。
◆ remotecmdCloseMicrophone:()
命令远端用户关闭麦克风
- 参数
-
[in] userId 关联用户Id。
- 返回
- 返回错误代码。
◆ remotecmdOpenMicrophone:()
命令远端用户打开麦克风
- 参数
-
[in] userId 关联用户Id。
- 返回
- 返回错误代码。
◆ setMixerDataListener:sampleRate:()
| - (AVDResult) setMixerDataListener: | (id< AVDAudioMixerDataDelegate >) | listener | |
| sampleRate: | (NSInteger) | sampleRate | |
设置获取混音数据回调接口
- 参数
-
[in] listener 混音数据回调指针。 [in] sampleRate 导出混音数据的采样率：16000,44100,48000。
- 返回
- 返回错误代码。
- 参见
- IMixerDataListener
- ro_audio_mixerdata_callback_buffered 单次混音数据回调“10ms数据”还是“1024samples数据”
- 注解
- 如果音视频同时混合出流，建议先设置视频，再设置音频的回调接口，有助于音视频时间戳对齐。
◆ setSpeakerMode:()
| + (AVDResult) setSpeakerMode: | (enum AVDSpeakerMode) | mode |
◆ stopVoice()
| - (AVDResult) stopVoice |
停止播放声音文件
- 返回
- 返回错误代码。
◆ unmonitorAudioLevel()
| - (AVDResult) unmonitorAudioLevel |
关闭语音激励
- 返回
- 返回错误代码。
◆ unmuteMicrophone()
| - (AVDResult) unmuteMicrophone |
本地麦克风取消静默
- 返回
- 返回错误代码。
◆ unmuteSpeaker()
| - (AVDResult) unmuteSpeaker |
本地扬声器取消静默
- 返回
- 返回错误代码。
属性说明
◆ delegate
|
readwritenonatomicweak |
语音回调代理
◆ mixerDataDelegate
|
readwritenonatomicweak |
语音数据回调代理
该类的文档由以下文件生成:
