AVDAudio

Superclass:
AVDModule
Declared In:

Introduction

房间中音频模块接口.

房间音频模块定义房间音频相关如麦克风、扬声器相关操作功能接口。



Methods

-closeMicrophone
+getAudio:
+getAudio:
-getMicrophoneStatus
-getRemoteMicrophoneStatus:
+getSpeakerMode
-ismonitorAudioLevel
-ismuteMicrophone
-ismuteSpeaker
-monitorAudioLevel
-muteMicrophone
-muteSpeaker
-openMicrophone
-playVoice:
-remotecmdCloseMicrophone:
-remotecmdOpenMicrophone:
-setMixerDataListener:sampleRate:
+setSpeakerMode:
-stopVoice
-unmonitorAudioLevel
-unmuteMicrophone
-unmuteSpeaker

closeMicrophone


- (AVDResult) closeMicrophone; 
Return Value

返回错误代码。

为异步操作,操作结果在 onCloseMicrophoneResult 中返回。:

@sa onCloseMicrophoneResult

Discussion

关闭本地麦克风发布到房间中


getAudio:


+ (AVDAudio* ) getAudio:(AVDRoom*)room; 
Discussion

< 语音数据回调代理


getAudio:


+ (AVDAudio* ) getAudio:(AVDRoom*)room; 
Return Value

返回音频模块对象。

Discussion

获取音频功能模块对象

@param[in] room 房间对象指针


getMicrophoneStatus


- (enum AVDDeviceStatus) getMicrophoneStatus; 
Return Value

返回麦克风状态。

Discussion

获取本地麦克风状态


getRemoteMicrophoneStatus:


- (enum AVDDeviceStatus) getRemoteMicrophoneStatus:(AVDUserId)userId; 
Return Value

返回麦克风状态。

Discussion

获取远端麦克风状态 @param[in] userId 关联用户Id。


getSpeakerMode


+ (enum AVDSpeakerMode) getSpeakerMode; 
Discussion

获取耳麦模式


ismonitorAudioLevel


- (BOOL) ismonitorAudioLevel; 
Discussion

判断是否开启语音激励


ismuteMicrophone


- (BOOL) ismuteMicrophone; 
Discussion

判断本地麦克风是否静默


ismuteSpeaker


- (BOOL) ismuteSpeaker; 
Discussion

判断本地扬声器是否静默


monitorAudioLevel


- (AVDResult) monitorAudioLevel; 
Return Value

返回错误代码。

Discussion

开启语音激励功能


muteMicrophone


- (AVDResult) muteMicrophone; 
Return Value

返回错误代码。

麦克风静默表示本地没有声音发布到房间中,房间中用户不会听到本地的任何声音。:

Discussion

本地麦克风静默


muteSpeaker


- (AVDResult) muteSpeaker; 
Return Value

返回错误代码。

扬声器静默表示房间中的声音不会在本地扬声器播放,本用户不会听到任何房间中的声音。:

Discussion

本地扬声器静默


openMicrophone


- (AVDResult) openMicrophone; 
Return Value

返回错误代码。

为异步操作,操作结果在 onOpenMicrophoneResult 中返回。:

@sa onOpenMicrophoneResult

Discussion

打开本地麦克风发布到房间中


playVoice:


- (AVDResult) playVoice:(NSString *)file; 
Return Value

返回错误代码。

用于测试扬声器是否工作正常。:

Discussion

开始播放声音文件 @param[in] file 本地音频文件。


remotecmdCloseMicrophone:


- (AVDResult) remotecmdCloseMicrophone:(AVDUserId)userId; 
Return Value

返回错误代码。

Discussion

命令远端用户关闭麦克风 @param[in] userId 关联用户Id。


remotecmdOpenMicrophone:


- (AVDResult) remotecmdOpenMicrophone:(AVDUserId)userId; 
Return Value

返回错误代码。

Discussion

命令远端用户打开麦克风 @param[in] userId 关联用户Id。


setMixerDataListener:sampleRate:


- (AVDResult) setMixerDataListener:(id <AVDAudioMixerDataDelegate>)listener 
        sampleRate:(NSInteger)sampleRate; 
Return Value

返回错误代码。 @sa IMixerDataListener @sa ro_audio_mixerdata_callback_buffered 单次混音数据回调“10ms数据”还是“1024samples数据”

如果音视频同时混合出流,建议先设置视频,再设置音频的回调接口,有助于音视频时间戳对齐。:

Discussion

设置获取混音数据回调接口 @param[in] listener 混音数据回调指针。 @param[in] sampleRate 导出混音数据的采样率:16000,44100,48000。 @param[in] channels 导出混音数据的通道数:1,2。


setSpeakerMode:


+ (AVDResult) setSpeakerMode:(enum AVDSpeakerMode)mode; 
Return Value

返回错误代码。 @sa AVDSpeakerMode

Discussion

设置耳麦模式 @param[in] mode 耳麦模式。


stopVoice


- (AVDResult) stopVoice; 
Return Value

返回错误代码。

Discussion

停止播放声音文件


unmonitorAudioLevel


- (AVDResult) unmonitorAudioLevel; 
Return Value

返回错误代码。

Discussion

关闭语音激励


unmuteMicrophone


- (AVDResult) unmuteMicrophone; 
Return Value

返回错误代码。

Discussion

本地麦克风取消静默


unmuteSpeaker


- (AVDResult) unmuteSpeaker; 
Return Value

返回错误代码。

Discussion

本地扬声器取消静默


Properties

mixerDataDelegate

mixerDataDelegate


@property (nonatomic,
    weak) id <AVDAudioMixerDataDelegate> mixerDataDelegate; 
Discussion

< 语音回调代理