AVDAudio Class Reference
| Inherits from | AVDModule : NSObject |
|---|---|
| Declared in | AVDAudio.h AVDAudio.mm |
mixerDataDelegate
< 语音回调代理
@property (nonatomic, weak) id<AVDAudioMixerDataDelegate> mixerDataDelegateDiscussion
< 语音回调代理
Declared In
AVDAudio.h
+ getAudio:
获取音频功能模块对象
+ (AVDAudio *)getAudio:(AVDRoom *)roomReturn Value
返回音频模块对象。
Discussion
获取音频功能模块对象
@param[in] room 房间对象指针
Declared In
AVDAudio.h
– openMicrophone
打开本地麦克风发布到房间中
- (AVDResult)openMicrophoneReturn Value
返回错误代码。
Discussion
打开本地麦克风发布到房间中
Note: 为异步操作，操作结果在 onOpenMicrophoneResult 中返回。
Declared In
AVDAudio.h
– closeMicrophone
关闭本地麦克风发布到房间中
- (AVDResult)closeMicrophoneReturn Value
返回错误代码。
Discussion
关闭本地麦克风发布到房间中
Note: 为异步操作，操作结果在 onCloseMicrophoneResult 中返回。
Declared In
AVDAudio.h
– getMicrophoneStatus
获取本地麦克风状态
- (enum AVDDeviceStatus)getMicrophoneStatusReturn Value
返回麦克风状态。
Discussion
获取本地麦克风状态
Declared In
AVDAudio.h
– muteMicrophone
本地麦克风静默
- (AVDResult)muteMicrophoneReturn Value
返回错误代码。
Discussion
本地麦克风静默
Note: 麦克风静默表示本地没有声音发布到房间中，房间中用户不会听到本地的任何声音。
Declared In
AVDAudio.h
– unmuteMicrophone
本地麦克风取消静默
- (AVDResult)unmuteMicrophoneReturn Value
返回错误代码。
Discussion
本地麦克风取消静默
Declared In
AVDAudio.h
– ismuteMicrophone
判断本地麦克风是否静默
- (BOOL)ismuteMicrophoneDiscussion
判断本地麦克风是否静默
Declared In
AVDAudio.h
– muteSpeaker
本地扬声器静默
- (AVDResult)muteSpeakerReturn Value
返回错误代码。
Discussion
本地扬声器静默
Note: 扬声器静默表示房间中的声音不会在本地扬声器播放，本用户不会听到任何房间中的声音。
Declared In
AVDAudio.h
– unmuteSpeaker
本地扬声器取消静默
- (AVDResult)unmuteSpeakerReturn Value
返回错误代码。
Discussion
本地扬声器取消静默
Declared In
AVDAudio.h
– monitorAudioLevel
开启语音激励功能
- (AVDResult)monitorAudioLevelReturn Value
返回错误代码。
Discussion
开启语音激励功能
Declared In
AVDAudio.h
– unmonitorAudioLevel
关闭语音激励
- (AVDResult)unmonitorAudioLevelReturn Value
返回错误代码。
Discussion
关闭语音激励
Declared In
AVDAudio.h
– ismonitorAudioLevel
判断是否开启语音激励
- (BOOL)ismonitorAudioLevelDiscussion
判断是否开启语音激励
Declared In
AVDAudio.h
– getRemoteMicrophoneStatus:
获取远端麦克风状态 @param[in] userId 关联用户Id。
- (enum AVDDeviceStatus)getRemoteMicrophoneStatus:(AVDUserId)userIdReturn Value
返回麦克风状态。
Discussion
获取远端麦克风状态 @param[in] userId 关联用户Id。
Declared In
AVDAudio.h
– remotecmdOpenMicrophone:
命令远端用户打开麦克风 @param[in] userId 关联用户Id。
- (AVDResult)remotecmdOpenMicrophone:(AVDUserId)userIdReturn Value
返回错误代码。
Discussion
命令远端用户打开麦克风 @param[in] userId 关联用户Id。
Declared In
AVDAudio.h
– remotecmdCloseMicrophone:
命令远端用户关闭麦克风 @param[in] userId 关联用户Id。
- (AVDResult)remotecmdCloseMicrophone:(AVDUserId)userIdReturn Value
返回错误代码。
Discussion
命令远端用户关闭麦克风 @param[in] userId 关联用户Id。
Declared In
AVDAudio.h
– remotecmdMuteMicrophone:
命令远端用户静默麦克风 @param[in] userId 关联用户Id。
- (AVDResult)remotecmdMuteMicrophone:(AVDUserId)userIdReturn Value
返回错误代码。
Discussion
命令远端用户静默麦克风 @param[in] userId 关联用户Id。
Declared In
AVDAudio.h
– remotecmdUnmuteMicrophone:
命令远端用户取消静默麦克风 @param[in] userId 关联用户Id。
- (AVDResult)remotecmdUnmuteMicrophone:(AVDUserId)userIdReturn Value
返回错误代码。
Discussion
命令远端用户取消静默麦克风 @param[in] userId 关联用户Id。
Declared In
AVDAudio.h
– setSpeakerMode:
设置耳麦模式 @param[in] mode 耳麦模式。
- (AVDResult)setSpeakerMode:(enum AVDSpeakerMode)modeReturn Value
返回错误代码。
Discussion
设置耳麦模式 @param[in] mode 耳麦模式。
Declared In
AVDAudio.h
– getSpeakerMode
获取耳麦模式
- (enum AVDSpeakerMode)getSpeakerModeDiscussion
获取耳麦模式
Declared In
AVDAudio.h
– playVoice:
开始播放声音文件 @param[in] file 本地音频文件。
- (AVDResult)playVoice:(NSString *)fileReturn Value
返回错误代码。
Discussion
开始播放声音文件 @param[in] file 本地音频文件。
Note: 用于测试扬声器是否工作正常。
Declared In
AVDAudio.h
– stopVoice
停止播放声音文件
- (AVDResult)stopVoiceReturn Value
返回错误代码。
Discussion
停止播放声音文件
Declared In
AVDAudio.h
– setMixerDataListener:sampleRate:
设置获取混音数据回调接口 @param[in] listener 混音数据回调指针。 @param[in] sampleRate 导出混音数据的采样率：16000,44100,48000。 @param[in] channels 导出混音数据的通道数：1，2。
- (AVDResult)setMixerDataListener:(id<AVDAudioMixerDataDelegate>)listener sampleRate:(NSInteger)sampleRateReturn Value
返回错误代码。
Discussion
设置获取混音数据回调接口 @param[in] listener 混音数据回调指针。 @param[in] sampleRate 导出混音数据的采样率：16000,44100,48000。 @param[in] channels 导出混音数据的通道数：1，2。
Note: 如果音视频同时混合出流，建议先设置视频，再设置音频的回调接口，有助于音视频时间戳对齐。
Declared In
AVDAudio.h
– muteAudio:
静默指定参会者在会议中的声音
- (AVDResult)muteAudio:(AVDUserId)userIdParameters
userId |
userid |
|---|
Return Value
错误代码
Discussion
静默指定参会者在会议中的声音
Declared In
AVDAudio.h
– unmuteAudio:
取消静默指定参会者在会议中的声音
- (AVDResult)unmuteAudio:(AVDUserId)userIdParameters
userId |
userid |
|---|
Return Value
错误代码
Discussion
取消静默指定参会者在会议中的声音
Declared In
AVDAudio.h
– ismuteAudio:
获取指定参会者在会议中的声音是否静默
- (BOOL)ismuteAudio:(AVDUserId)userIdParameters
userId |
userid |
|---|
Return Value
错误代码
Discussion
获取指定参会者在会议中的声音是否静默
Declared In
AVDAudio.h
– setPublishAudioKeepAliveTime:
设置当前音频流推送的保活时长
- (void)setPublishAudioKeepAliveTime:(NSInteger)timeParameters
time |
保活时长(单位为毫秒) |
|---|
Discussion
设置当前音频流推送的保活时长
Declared In
AVDAudio.h
– registerPCMDataListener:sampleRate:channels:userId:
注册某一路音频数据回调接口 @param[in] userId 音频对应的用户ID。 @param[in] listener 混音数据回调指针。 @param[in] sampleRate 采样频率 8000，16000 ，44100，48000 @param[in] channels 通道数 1，2
- (AVDResult)registerPCMDataListener:(id<AVDAudioMixerDataDelegate>)listener sampleRate:(NSInteger)sampleRate channels:(NSInteger)channels userId:(AVDUserId)userIdReturn Value
返回错误代码。
Discussion
注册某一路音频数据回调接口 @param[in] userId 音频对应的用户ID。 @param[in] listener 混音数据回调指针。 @param[in] sampleRate 采样频率 8000，16000 ，44100，48000 @param[in] channels 通道数 1，2
Declared In
AVDAudio.h
– unregisterPCMDataListener:
取消某一路音频数据回调接口 @param[in] userId 音频对应的用户ID。
- (AVDResult)unregisterPCMDataListener:(AVDUserId)userIdReturn Value
返回错误代码。
Discussion
取消某一路音频数据回调接口 @param[in] userId 音频对应的用户ID。
Declared In
AVDAudio.h