ZegoLiveRoom
Classes | Enumerations | Functions
ZEGO::AUDIO_OBSERVER Namespace Reference

Classes

class  IZegoAudioObserverCallback
 

Enumerations

enum  ZegoAudioObserverSource {
  ZEGOAPI_AUDIO_OBSERVER_CAPTURE = 0x01 , ZEGOAPI_AUDIO_OBSERVER_PLAYBACK = 0x02 , ZEGOAPI_AUDIO_OBSERVER_MIX = 0x04 , ZEGOAPI_AUDIO_OBSERVER_SYSPLAY_AND_MIC = 0x08 ,
  ZEGOAPI_AUDIO_OBSERVER_SYSPLAY_NO_STREAM = 0x10
}
 

Functions

ZEGOAVKIT_API bool SetAudioObserverCallback (IZegoAudioObserverCallback *cb)
 
ZEGOAVKIT_API bool StartAudioObserver (int source, int sampleRate=44100, int numOfChannels=1)
 
ZEGOAVKIT_API void StopAudioObserver ()
 

Enumeration Type Documentation

◆ ZegoAudioObserverSource

Enumerator
ZEGOAPI_AUDIO_OBSERVER_CAPTURE 

采集音频

ZEGOAPI_AUDIO_OBSERVER_PLAYBACK 

播放音频

ZEGOAPI_AUDIO_OBSERVER_MIX 

采集与播放混音音频

ZEGOAPI_AUDIO_OBSERVER_SYSPLAY_AND_MIC 

系统播放和麦克采集的混音,仅支持Windows

ZEGOAPI_AUDIO_OBSERVER_SYSPLAY_NO_STREAM 

系统播放(不含拉流)的声音,仅支持 Windows

Function Documentation

◆ SetAudioObserverCallback()

ZEGOAVKIT_API bool ZEGO::AUDIO_OBSERVER::SetAudioObserverCallback ( IZegoAudioObserverCallback cb)

设置音频观察器回调

Parameters
cb音频观察器回调
Returns
true 表示设置回调成功;false 表示设置回调失败。
Note
调用StartAudioObserver成功后才会有回调
必须在初始化 SDK 后调用

◆ StartAudioObserver()

ZEGOAVKIT_API bool ZEGO::AUDIO_OBSERVER::StartAudioObserver ( int  source,
int  sampleRate = 44100,
int  numOfChannels = 1 
)

启动音频观察器,旁路回调相应的音频数据,该数据已经过3A处理,方便用户对相关音频数据进行录制、分析等自定义处理

Parameters
source关注的音频源类型,只有关注了该类型的音频才会有相应的回调,详见ZegoAudioObserverSource
sampleRate音频采样率,包括8000, 16000, 22050, 24000, 32000, 44100, 48000
numOfChannels声道数,1:单声道,2:双声道
Returns
true 表示调用成功,能收到音频观察器回调;false 表示调用失败,不能收到音频观察器回调。
Note
1. 必须在初始化 SDK 后调用
2. 该模块与AV::EnableSelectedAudioRecord不兼容
3. 当source包含 ZEGOAPI_AUDIO_OBSERVER_CAPTURE 时,对应音频数据通过 OnCapturedAudioData 获取
4. 当source包含 ZEGOAPI_AUDIO_OBSERVER_PLAYBACK 时,对应音频数据通过 OnPlaybackAudioData 获取
5. 当source包含 ZEGOAPI_AUDIO_OBSERVER_MIX 时,对应音频数据通过 OnMixAudioData 获取
6. Windows下,当source包含 ZEGOAPI_AUDIO_OBSERVER_SYSPLAY_AND_MIC 时,对应音频数据通过 OnSysplayAndMicData 获取
7. Windows下,当source包含 ZEGOAPI_AUDIO_OBSERVER_SYSPLAY_NO_STREAM 时,对应音频数据通过 OnSysplayNoStreamData 获取
8. Windows下,ZEGOAPI_AUDIO_OBSERVER_SYSPLAY_AND_MIC、ZEGOAPI_AUDIO_OBSERVER_SYSPLAY_NO_STREAM 仅能开启一种

◆ StopAudioObserver()

ZEGOAVKIT_API void ZEGO::AUDIO_OBSERVER::StopAudioObserver ( )

停止音频观察器,不会再回调相应的音频数据

Note
必须在初始化 SDK 后调用