Classes
class	IAudioEngineCallback

class	IAudioIMCallback

class	IAudioLivePlayerCallback

class	IAudioLivePublisherCallback

class	IAudioRoomCallback

struct	ZegoPlayQuality

struct	ZegoPublishQuality

Functions
ZEGO_API bool	SetAudioIMCallback (IAudioIMCallback *pCB)

ZEGO_API int	SendRoomMessage (ROOM::ZegoMessageType type, ROOM::ZegoMessageCategory category, const char *messageContent)

ZEGO_API bool	StartPlay (const char *pszStreamID)

ZEGO_API void	StopPlay (const char *pszStreamID)

ZEGO_API int	GetMaxPlayChannelCount ()

ZEGO_API bool	SetAudioLivePlayerCallback (IAudioLivePlayerCallback *pCB)

ZEGO_API bool	EnableSpeaker (bool bEnable)

ZEGO_API bool	SetBuiltInSpeakerOn (bool bOn)

ZEGO_API bool	SetPlayVolume (int volume)

ZEGO_API float	GetSoundLevel (const char *pszStreamID)

ZEGO_API void	SetAudioPostpCallback (AVE::OnPostpCallback callback, const AVE::ExtPostpSet &config)

ZEGO_API void	EnableAudioPostp (bool enable, const char *streamID)

ZEGO_API bool	EnableSelectedAudioRecord (unsigned int uMask, int nSampleRate=44100, int nChannels=1)

ZEGO_API bool	SetAudioRecordCallback (AV::IZegoAudioRecordCallback *pCB)

ZEGO_API bool	RestartPlayStream (const char *streamID)

ZEGO_API bool	SetRecvBufferLevelLimit (int minBufferLevel, int maxBufferLevel, const char *streamID)

ZEGO_API bool	SetAudioLivePublisherCallback (IAudioLivePublisherCallback *pCB)

ZEGO_API bool	StartPublish ()

ZEGO_API bool	StartPublish (const char *pszStreamID)

ZEGO_API void	StopPublish ()

ZEGO_API bool	StartAudioCapture ()

ZEGO_API bool	StopAudioCapture ()

ZEGO_API bool	SetPublishStreamExtraInfo (const char *pszStreamExtraInfo)

ZEGO_API bool	EnableMic (bool bEnable)

ZEGO_API bool	SetAudioBitrate (int bitrate)

ZEGO_API void	SetAudioDeviceMode (AV::ZegoAVAPIAudioDeviceMode mode)

ZEGO_API bool	EnableAGC (bool bEnable)

ZEGO_API bool	EnableAEC (bool bEnable)

ZEGO_API bool	EnableLoopback (bool bEnable)

ZEGO_API void	SetLoopbackVolume (int volume)

ZEGO_API void	SetCaptureVolume (int volume)

ZEGO_API float	GetCaptureSoundLevel ()

ZEGO_API void	SetAudioPrepCallback (AVE::OnPrepCallback callback, const AVE::ExtPrepSet &config)

ZEGO_API void	SetAudioPrepAfterLoopbackCallback (AVE::OnAudioProcCallback callback, const AVE::ExtPrepSet &config)

ZEGO_API void	SetLatencyMode (AV::ZegoAVAPILatencyMode mode)

ZEGO_API void	SetAudioChannelCount (int count)

ZEGO_API void	EnableDTX (bool bEnable)

ZEGO_API void	EnableVAD (bool bEnable)

ZEGO_API bool	RestartPublishStream ()

ZEGO_API void	EnableAudioTrafficControl (bool bEnable)

ZEGO_API bool	EnableNoiseSuppress (bool bEnable)

ZEGO_API bool	SetNoiseSuppressMode (AV::ZegoANSMode mode)

ZEGO_API void	EnableMixSystemPlayout (bool bEnable)

ZEGO_API bool	SetSystemPlayoutVolumeBeforeMixing (int volume)

ZEGO_API int	GetMicDeviceVolume (const char *deviceId)

ZEGO_API void	SetMicDeviceVolume (const char *deviceId, int volume)

ZEGO_API int	GetSpeakerDeviceVolume (const char *deviceId)

ZEGO_API void	SetSpeakerDeviceVolume (const char *deviceId, int volume)

ZEGO_API int	GetSpeakerSimpleVolume (const char *deviceId)

ZEGO_API void	SetSpeakerSimpleVolume (const char *deviceId, int volume)

ZEGO_API bool	GetSpeakerDeviceMute (const char *deviceId)

ZEGO_API void	SetSpeakerDeviceMute (const char *deviceId, bool mute)

ZEGO_API bool	GetSpeakerSimpleMute (const char *deviceId)

ZEGO_API void	SetSpeakerSimpleMute (const char *deviceId, bool mute)

ZEGO_API void	GetDefaultAudioDeviceId (AV::AudioDeviceType deviceType, char deviceId, unsigned int deviceIdLength)

ZEGO_API bool	SetAudioVolumeNotify (AV::AudioDeviceType deviceType, const char *deviceId)

ZEGO_API bool	StopAudioVolumeNotify (AV::AudioDeviceType deviceType, const char *deviceId)

ZEGO_API const char *	GetSDKVersion ()

ZEGO_API const char *	GetSDKVersion2 ()

ZEGO_API bool	SetLogDir (const char *pszLogDir)

ZEGO_API void	UploadLog ()

ZEGO_API void	SetVerbose (bool bVerbose)

ZEGO_API void	SetUseTestEnv (bool bTestEnv)

ZEGO_API bool	SetUser (const char pszUserID, const char pszUserName)

ZEGO_API bool	InitSDK (unsigned int uiAppID, unsigned char *pBufAppSignature, int nSignatureSize)

ZEGO_API bool	UnInitSDK ()

ZEGO_API void	SetManualPublish (bool bManual)

ZEGO_API void	SetManualPlay (bool bManual)

ZEGO_API void	SetUserStateUpdate (bool bUserStateUpdate)

ZEGO_API bool	SetAudioRoomCallback (IAudioRoomCallback *pCB)

ZEGO_API bool	LoginRoom (const char *pszRoomID)

ZEGO_API bool	SwitchRoom (const char *pszRoomID)

ZEGO_API bool	LogoutRoom ()

ZEGO_API void	SetAudioLiveEventCallback (AV::IZegoLiveEventCallback *pCB)

ZEGO_API void	SetAudioDeviceStateCallback (AV::IZegoDeviceStateCallback *pCB)

ZEGO_API AV::DeviceInfo *	GetAudioDeviceList (AV::AudioDeviceType deviceType, int &device_count)

ZEGO_API bool	SetAudioDevice (AV::AudioDeviceType deviceType, const char *pszDeviceID)

ZEGO_API void	FreeDeviceList (AV::DeviceInfo *parrDeviceList)

ZEGO_API bool	SetAudioEngineCallback (IAudioEngineCallback *pCB)

ZEGO_API void	SetConfig (const char *pConfig)

ZEGO_API int	SendCustomCommand (ROOM::ZegoUser memberList, unsigned int memberCount, const char content)

ZEGO_API bool	SetCustomToken (const char *thirdPartyToken)

Function Documentation

◆ EnableAEC()

ZEGO_API bool ZEGO::AUDIOROOM::EnableAEC ( bool bEnable )

回声消除开关

Parameters

bEnable true 开启，false 关闭

Returns: true 成功，false 失败

◆ EnableAGC()

ZEGO_API bool ZEGO::AUDIOROOM::EnableAGC ( bool bEnable )

音频采集自动增益开关。windows默认开启；android/ios默认关闭；mac默认音频设备模式为ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION或ZEGO_AUDIO_DEVICE_MODE_COMMUNICATION2时开启，否则关闭

Parameters

bEnable true 开启，false 关闭

Returns: true 成功，false 失败

◆ EnableAudioPostp()

ZEGO_API void ZEGO::AUDIOROOM::EnableAudioPostp	(	bool	enable,
		const char *	streamID
	)

开启/关闭音频后处理特性

Parameters

enable	true: 开启拉流音频后处理特性；false: 关闭拉流音频后处理特性
streamID	流 ID, 当 streamID 为空串时，表明需要混音后的音频数据

Attention: streamID不为空串时，必须在拉流后调用，本次拉流有效; 当拉流音频后处理特性开启时，待渲染音频数据通过 SetAudioPostpCallback 设置的回调函数指针返回

◆ EnableAudioTrafficControl()

ZEGO_API void ZEGO::AUDIOROOM::EnableAudioTrafficControl ( bool bEnable )

设置是否开启音频流量控制

Parameters

bEnable true 开启; false 关闭

◆ EnableDTX()

ZEGO_API void ZEGO::AUDIOROOM::EnableDTX ( bool bEnable )

是否开启离散音频包发送

Parameters

bEnable true 开启，推流中检测为静音的数据包不发送；false 关闭，推流中的静音数据包照常发送。默认是 false。

Attention: 推流前调用有效。以 RTC 方式推流，此接口才会生效。; SDK 默认关闭该特性。

Note: 可以和 EnableVAD 配合使用。; 开启离散音频包发送可以在关闭麦克风或者静音的状态下，停止音频包的发送，节省用户流量。; 如果为音频单流(非混流)转推 CDN，开启此选项将导致 CDN 在设定时间内未收到数据包认为流关闭而断开连接，所以此种情况不建议开启。

◆ EnableLoopback()

ZEGO_API bool ZEGO::AUDIOROOM::EnableLoopback ( bool bEnable )

开启采集监听

Parameters

bEnable true 打开，false 关闭。默认 false

Returns: true 成功，false 失败

Attention: 推流时可调用本 API 进行参数配置。连接耳麦时设置才实际生效。开启采集监听，主播方讲话后，会听到自己的声音。; 耳返默认是在采集之后、前处理之前返回，如果需要在前处理之后返回请咨询技术支持。

◆ EnableMic()

ZEGO_API bool ZEGO::AUDIOROOM::EnableMic ( bool bEnable )

开启麦克风

Parameters

bEnable true 打开，false 关闭。默认 false

Returns: true 成功，false 失败

Attention: 推流时可调用本 API 进行参数配置

◆ EnableMixSystemPlayout()

ZEGO_API void ZEGO::AUDIOROOM::EnableMixSystemPlayout ( bool bEnable )

系统声卡声音采集开关，开启会将第三方播放器的声音混入推流中的声音。单独开启此功能不会将 sdk播放的声音如：拉流的声音和媒体播放器的声音混入调用时机为initSDK后调用，可以在推流过程中更改设置

Parameters

bEnable true 打开，false 失败

◆ EnableNoiseSuppress()

ZEGO_API bool ZEGO::AUDIOROOM::EnableNoiseSuppress ( bool bEnable )

音频采集噪声抑制开关

Parameters

bEnalbe true 开启，false 关闭

Returns: true 调用成功，false 调用失败

◆ EnableSelectedAudioRecord()

ZEGO_API bool ZEGO::AUDIOROOM::EnableSelectedAudioRecord	(	unsigned int	uMask,
		int	nSampleRate = `44100`,
		int	nChannels = `1`
	)

音频录制回调开关

Parameters

uMask	启用音频源选择，参考 ZegoAVAPIAudioRecordMask
nSampleRate	采样率 8000, 16000, 22050, 24000, 32000, 44100, 48000
nChannels	声道数 1(单声道) 或 2(双声道) 默认1

Returns: true 成功，false 失败

◆ EnableSpeaker()

ZEGO_API bool ZEGO::AUDIOROOM::EnableSpeaker ( bool bEnable )

（声音输出）静音开关

Parameters

bEnable true 不静音，false 静音。默认 true

Returns: true 成功，false 失败

Attention: 设置为关闭后，默认扬声器和耳机均无声音输出

◆ EnableVAD()

ZEGO_API void ZEGO::AUDIOROOM::EnableVAD ( bool bEnable )

是否开启语音活动检测

Parameters

enable true 开启; false 关闭, 默认关闭

Attention: 确保在推流前调用，只有纯 UDP 方案才可以调用此接口

◆ FreeDeviceList()

ZEGO_API void ZEGO::AUDIOROOM::FreeDeviceList ( AV::DeviceInfo * parrDeviceList )

释放设备列表

Parameters

parrDeviceList 设备列表

◆ GetAudioDeviceList()

ZEGO_API AV::DeviceInfo * ZEGO::AUDIOROOM::GetAudioDeviceList	(	AV::AudioDeviceType	deviceType,
		int &	device_count
	)

获取音频设备列表

Parameters

deviceType	设备类型
device_count	设备数量

Returns: 音频设备列表

◆ GetCaptureSoundLevel()

ZEGO_API float ZEGO::AUDIOROOM::GetCaptureSoundLevel ( )

获取当前采集的音量

Returns: 当前采集音量大小

◆ GetDefaultAudioDeviceId()

ZEGO_API void ZEGO::AUDIOROOM::GetDefaultAudioDeviceId	(	AV::AudioDeviceType	deviceType,
		char *	deviceId,
		unsigned int *	deviceIdLength
	)

获取默认的音频设备

Parameters

deviceType	音频类型
deviceId	设备 Id
deviceIdLength	deviceId 字符串分配的长度

Note: 如果传入的字符串 buffer 长度小于默认 deviceId 的长度，则 deviceIdLength 返回实际需要的字符串长度

◆ GetMaxPlayChannelCount()

ZEGO_API int ZEGO::AUDIOROOM::GetMaxPlayChannelCount ( )

获取 SDK 支持的最大同时播放流数

Returns: 最大支持播放流数

◆ GetMicDeviceVolume()

ZEGO_API int ZEGO::AUDIOROOM::GetMicDeviceVolume ( const char * deviceId )

获取麦克风音量

Parameters

deviceId 麦克风 deviceId

Returns: -1: 获取失败，0~100 麦克风音量

Note: 切换麦克风后需要重新获取麦克风音量

◆ GetSDKVersion()

ZEGO_API const char * ZEGO::AUDIOROOM::GetSDKVersion ( )

◆ GetSDKVersion2()

ZEGO_API const char * ZEGO::AUDIOROOM::GetSDKVersion2 ( )

◆ GetSoundLevel()

ZEGO_API float ZEGO::AUDIOROOM::GetSoundLevel ( const char * pszStreamID )

获取当前播放视频的音量

Parameters

pszStreamID 播放流 ID

Returns: 视频的音量值

Attention: 直播时通过此 API 获取当前音量。

◆ GetSpeakerDeviceMute()

ZEGO_API bool ZEGO::AUDIOROOM::GetSpeakerDeviceMute ( const char * deviceId )

获取扬声器是否静音

Parameters

deviceId 扬声器 deviceId

Returns: true 静音，false 不静音

◆ GetSpeakerDeviceVolume()

ZEGO_API int ZEGO::AUDIOROOM::GetSpeakerDeviceVolume ( const char * deviceId )

获取扬声器音量

Parameters

deviceId 扬声器 deviceId

Returns: -1: 获取失败，0~100 扬声器音量

Note: 切换扬声器后需要重新获取音量

◆ GetSpeakerSimpleMute()

ZEGO_API bool ZEGO::AUDIOROOM::GetSpeakerSimpleMute ( const char * deviceId )

获取 App 中扬声器是否静音

Parameters

deviceId 扬声器 deviceId

Returns: true 静音，false 不静音

◆ GetSpeakerSimpleVolume()

ZEGO_API int ZEGO::AUDIOROOM::GetSpeakerSimpleVolume ( const char * deviceId )

获取 App 中扬声器音量

Parameters

deviceId 扬声器 deviceId

Returns: -1: 获取失败，0~100 扬声器音量

◆ InitSDK()

ZEGO_API bool ZEGO::AUDIOROOM::InitSDK	(	unsigned int	uiAppID,
		unsigned char *	pBufAppSignature,
		int	nSignatureSize
	)

初始化 SDK

Parameters

uiAppID	Zego 派发的数字 ID, 各个开发者的唯一标识
pBufAppSignature	Zego 派发的签名, 用来校验对应 appID 的合法性
nSignatureSize	签名长度（字节）

Returns: true 成功，false 失败

Note: 初始化 SDK 失败可能导致 SDK 功能异常

◆ LoginRoom()

ZEGO_API bool ZEGO::AUDIOROOM::LoginRoom ( const char * pszRoomID )

登录房间

Parameters

pszRoomID	房间 ID
role	成员角色
pszRoomName	房间名称

Returns: true 成功，false 失败

◆ LogoutRoom()

ZEGO_API bool ZEGO::AUDIOROOM::LogoutRoom ( )

退出房间

Returns: 成功，false 失败

Attention: 退出登录后，等待 IRoomCallback::OnLogoutRoom 回调

Note: 退出房间会停止所有的推拉流

◆ RestartPlayStream()

ZEGO_API bool ZEGO::AUDIOROOM::RestartPlayStream ( const char * streamID )

onPlayStateUpdate返回拉流失败时，可以尝试再次拉流

Parameters

streamID 重新拉流流ID

Returns: true 调用成功，false 调用失败

◆ RestartPublishStream()

ZEGO_API bool ZEGO::AUDIOROOM::RestartPublishStream ( )

OnPublishStateUpdate回调推流失败时，可以调用此函数再次进行推流

Returns: true 调用推流成功，false 调用失败

◆ SendCustomCommand()

ZEGO_API int ZEGO::AUDIOROOM::SendCustomCommand	(	ROOM::ZegoUser *	memberList,
		unsigned int	memberCount,
		const char *	content
	)

发送自定义信令

Parameters

memberList	信令发送成员列表
memberCount	成员个数
content	信令内容

Returns: 消息 seq

◆ SendRoomMessage()

ZEGO_API int ZEGO::AUDIOROOM::SendRoomMessage	(	ROOM::ZegoMessageType	type,
		ROOM::ZegoMessageCategory	category,
		const char *	messageContent
	)

发送聊天室消息

Parameters

type	消息类型
category	消息分类
messageContent	消息内容

Returns: 消息 seq

◆ SetAudioBitrate()

ZEGO_API bool ZEGO::AUDIOROOM::SetAudioBitrate ( int bitrate )

设置音频码率

Parameters

bitrate 码率

Returns: true 成功，false 失败

◆ SetAudioChannelCount()

ZEGO_API void ZEGO::AUDIOROOM::SetAudioChannelCount ( int count )

设置推流音频声道数

Parameters

count 声道数，1 或 2，默认为 1（单声道）

Attention: 必须在InitSDK之后，推流前设置

Note: SetLatencyMode 设置为 ZEGO_LATENCY_MODE_NORMAL, ZEGO_LATENCY_MODE_NORMAL2, ZEGO_LATENCY_MODE_LOW3 才能设置双声道; 在移动端双声道通常需要配合音频前处理才能体现效果。

◆ SetAudioDevice()

ZEGO_API bool ZEGO::AUDIOROOM::SetAudioDevice	(	AV::AudioDeviceType	deviceType,
		const char *	pszDeviceID
	)

设置选用音频设备

Parameters

deviceType	设备类型
pszDeviceID	设备 ID

Returns: true 成功，false 失败

◆ SetAudioDeviceMode()

ZEGO_API void ZEGO::AUDIOROOM::SetAudioDeviceMode ( AV::ZegoAVAPIAudioDeviceMode mode )

设置音频设备模式

Parameters

mode	模式，默认 ZEGO_AUDIO_DEVICE_MODE_AUTO

Attention: 在推流预览前后调用均有效，调用该接口会触发设备的启动切换，建议不要频繁调用，避免不必要的开销与硬件问题; 用本接口可能导致音量模式在通话/媒体间切换，若媒体音量和通话音量不一致，可能导致音量变化

◆ SetAudioDeviceStateCallback()

ZEGO_API void ZEGO::AUDIOROOM::SetAudioDeviceStateCallback ( AV::IZegoDeviceStateCallback * pCB )

设置音频视频设备变化的回调

Parameters

pCB 回调对象指针

◆ SetAudioEngineCallback()

ZEGO_API bool ZEGO::AUDIOROOM::SetAudioEngineCallback ( IAudioEngineCallback * pCB )

设置“音视频引擎状态通知”的回调

Parameters

pCB 回调对象指针

Returns: true 成功，false 失败

◆ SetAudioIMCallback()

ZEGO_API bool ZEGO::AUDIOROOM::SetAudioIMCallback ( IAudioIMCallback * pCB )

设置 IM 信息通知的回调对象

Parameters

pCB 回调对象指针

Returns: true 成功，false 失败

◆ SetAudioLiveEventCallback()

ZEGO_API void ZEGO::AUDIOROOM::SetAudioLiveEventCallback ( AV::IZegoLiveEventCallback * pCB )

设置直播事件回调

Parameters

pCB 回调对象指针

◆ SetAudioLivePlayerCallback()

ZEGO_API bool ZEGO::AUDIOROOM::SetAudioLivePlayerCallback ( IAudioLivePlayerCallback * pCB )

设置直播观众相关信息通知的回调

Parameters

pCB 回调对象指针

Returns: true 成功，false 失败

◆ SetAudioLivePublisherCallback()

ZEGO_API bool ZEGO::AUDIOROOM::SetAudioLivePublisherCallback ( IAudioLivePublisherCallback * pCB )

设置直播主播相关信息通知的回调

Parameters

pCB 回调对象指针

Returns: true 成功，false 失败

◆ SetAudioPostpCallback()

ZEGO_API void ZEGO::AUDIOROOM::SetAudioPostpCallback	(	AVE::OnPostpCallback	callback,
		const AVE::ExtPostpSet &	config
	)

设置音频后处理函数

Parameters

callback	音频后处理函数指针
config	预处理的采样率等参数设置

Attention: 必须在InitSDK后，在调用预览，拉流，推流，启动播放器接口前设置; 仅在使用 EnableAudioPostp 开启了音频后处理特性后才会回调; 请确保在当前线程完成，且不要做耗时操作

◆ SetAudioPrepAfterLoopbackCallback()

ZEGO_API void ZEGO::AUDIOROOM::SetAudioPrepAfterLoopbackCallback	(	AVE::OnAudioProcCallback	callback,
		const AVE::ExtPrepSet &	config
	)

设置音频(耳返后)处理函数, 并开启/关闭音频处理特性

Parameters

callback	音频处理函数指针
config	预处理的采样率等参数设置

Attention: 必须在 InitSDK 后且在推流前调用; 使用该回调处理音频不影响耳返效果

◆ SetAudioPrepCallback()

ZEGO_API void ZEGO::AUDIOROOM::SetAudioPrepCallback	(	AVE::OnPrepCallback	callback,
		const AVE::ExtPrepSet &	config
	)

设置音频前(3A处理后、耳返前)处理函数, 并开启/关闭音频前处理特性

Parameters

callback	音频前处理函数指针
config	预处理的采样率等参数设置

Attention: 必须在InitSDK后，在调用预览，拉流，推流，启动播放器接口前设置; 使用该回调处理音频影响耳返效果

◆ SetAudioRecordCallback()

ZEGO_API bool ZEGO::AUDIOROOM::SetAudioRecordCallback ( AV::IZegoAudioRecordCallback * pCB )

设置音频录制回调

Parameters

pCB 回调实现实例

Returns: true 成功，false 失败

◆ SetAudioRoomCallback()

ZEGO_API bool ZEGO::AUDIOROOM::SetAudioRoomCallback ( IAudioRoomCallback * pCB )

设置直播房间相关信息通知的回调

Parameters

pCB 回调对象指针

Returns: true 成功，false 失败

◆ SetAudioVolumeNotify()

ZEGO_API bool ZEGO::AUDIOROOM::SetAudioVolumeNotify	(	AV::AudioDeviceType	deviceType,
		const char *	deviceId
	)

监听设备的音量变化

Parameters

deviceType	音频类型
deviceId	设备 Id

Returns: true 成功，false 失败

Note: 设置后如果有音量变化（包括 app 音量）通过 IZegoDeviceStateCallback::OnAudioVolumeChanged 回调

◆ SetBuiltInSpeakerOn()

ZEGO_API bool ZEGO::AUDIOROOM::SetBuiltInSpeakerOn ( bool bOn )

默认扬声器开关

Parameters

bOn	true 打开，false 关闭。默认 true

Returns: true 成功，false 失败

Attention: 设置为关闭后，扬声器无声音，耳机仍有声音输出

◆ SetCaptureVolume()

ZEGO_API void ZEGO::AUDIOROOM::SetCaptureVolume ( int volume )

设置采集音量

Parameters

volume 音量大小，取值范围 [0, 200], 默认 100

Attention: InitSDK成功之后调用

◆ SetConfig()

ZEGO_API void ZEGO::AUDIOROOM::SetConfig ( const char * pConfig )

设置配置信息

Parameters

config config 配置信息

Attention: 确保在 Init SDK 前调用; 具体配置信息请咨询技术支持

◆ SetCustomToken()

ZEGO_API bool ZEGO::AUDIOROOM::SetCustomToken ( const char * thirdPartyToken )

设置房间的自定义token信息

Parameters

thirdPartyToken 第三方传入的token

Returns: true 成功，false 失败 @discussion 使用此函数验证登录及推流时用户的合法性，登录房间前调用，token的生成规则请联系即构。若不需要验证用户合法性，不需要调用此函数 @discussion 在登录房间前调用有效，支持登录后重置，退出房间后失效。

◆ SetLatencyMode()

ZEGO_API void ZEGO::AUDIOROOM::SetLatencyMode ( AV::ZegoAVAPILatencyMode mode )

设置延迟模式

Parameters

mode	延迟模式，默认 ZEGO_LATENCY_MODE_NORMAL

Attention: 确保在InitSDK之后，推流前调用

◆ SetLogDir()

ZEGO_API bool ZEGO::AUDIOROOM::SetLogDir ( const char * pszLogDir )

◆ SetLoopbackVolume()

ZEGO_API void ZEGO::AUDIOROOM::SetLoopbackVolume ( int volume )

设置监听音量

Parameters

volume 音量大小，取值范围 [0, 200], 默认 60

Attention: 推流时可调用本 API 进行参数配置

◆ SetManualPlay()

ZEGO_API void ZEGO::AUDIOROOM::SetManualPlay ( bool bManual )

设置登录房间成功后是否需要手动播放直播

Parameters

bManual 手动播放直播

◆ SetManualPublish()

ZEGO_API void ZEGO::AUDIOROOM::SetManualPublish ( bool bManual )

设置登录房间成功后是否需要手动发布直播

Parameters

bManual 手动发布直播

◆ SetMicDeviceVolume()

ZEGO_API void ZEGO::AUDIOROOM::SetMicDeviceVolume	(	const char *	deviceId,
		int	volume
	)

设置麦克风音量

Parameters

deviceId	麦克风 deviceId
volume	音量，取值(0,100)

◆ SetNoiseSuppressMode()

ZEGO_API bool ZEGO::AUDIOROOM::SetNoiseSuppressMode ( AV::ZegoANSMode mode )

设置音频采集降噪等级

Parameters

mode	降噪等级，详见 ZegoANSMode 定义

Returns: true 成功，false 失败

Note: 仅在 EnableNoiseSuppress 为 true 时有效, 默认为 MEDIUM

◆ SetPlayVolume()

ZEGO_API bool ZEGO::AUDIOROOM::SetPlayVolume ( int volume )

设置播放音量

Parameters

volume 音量大小, 取值范围[0, 200], 默认 100

Attention: 直播时通过此 API 软件调整音量

◆ SetPublishStreamExtraInfo()

ZEGO_API bool ZEGO::AUDIOROOM::SetPublishStreamExtraInfo ( const char * pszStreamExtraInfo )

设置或更新推流的附加信息

Parameters

pszStreamExtraInfo 流附加信息, 最大为 1024 字节

Returns: 更新流附加信息成功后，同一房间内的其他人会收到 OnStreamExtraInfoUpdated 通知

◆ SetRecvBufferLevelLimit()

ZEGO_API bool ZEGO::AUDIOROOM::SetRecvBufferLevelLimit	(	int	minBufferLevel,
		int	maxBufferLevel,
		const char *	streamID
	)

设置拉流播放缓存自适应调整的区间范围（上下限）

Parameters

minBufferLevel	缓存自适应区间下限, 单位毫秒. 当 minBufferLevel <= 0 表示未设置下限.
maxBufferLevel	缓存自适应区间上限, 单位毫秒. 当 maxBufferLevel <= 0 表示未设置上限. 当设置的上限超过4000时，会取值4000.
streamID	流 ID

Returns: true 设置成功, false 设置失败

Note: 调用时机为拉流前或者拉流中, 每次拉流都需要重新设置; 上下限在未设置时, 内部默认区间范围 [0, 4000]; 当设置的上限小于下限时，会自动将上限取值为下限

◆ SetSpeakerDeviceMute()

ZEGO_API void ZEGO::AUDIOROOM::SetSpeakerDeviceMute	(	const char *	deviceId,
		bool	mute
	)

设置扬声器静音

Parameters

deviceId	扬声器 deviceId
mute	true 静音，false 不静音

◆ SetSpeakerDeviceVolume()

ZEGO_API void ZEGO::AUDIOROOM::SetSpeakerDeviceVolume	(	const char *	deviceId,
		int	volume
	)

设置扬声器音量

Parameters

deviceId	扬声器 deviceId
volume	音量，取值 (0，100)

◆ SetSpeakerSimpleMute()

ZEGO_API void ZEGO::AUDIOROOM::SetSpeakerSimpleMute	(	const char *	deviceId,
		bool	mute
	)

设置 App 中扬声器静音

Parameters

deviceId	扬声器 deviceId
mute	true 静音，false 不静音

◆ SetSpeakerSimpleVolume()

ZEGO_API void ZEGO::AUDIOROOM::SetSpeakerSimpleVolume	(	const char *	deviceId,
		int	volume
	)

设置 App 中扬声器音量

Parameters

deviceId	扬声器 deviceId
volume	音量，取值 (0，100)

◆ SetSystemPlayoutVolumeBeforeMixing()

ZEGO_API bool ZEGO::AUDIOROOM::SetSystemPlayoutVolumeBeforeMixing ( int volume )

设置系统声卡采集的音量

Parameters

volume 音量, 有效范围[0, 200], 默认为 100

Returns: true 代表成功，false表示失败

Note: 在 InitSDK 后设置有效, 在 UnInitSDK 后还原

◆ SetUser()

ZEGO_API bool ZEGO::AUDIOROOM::SetUser	(	const char *	pszUserID,
		const char *	pszUserName
	)

设置用户信息

Parameters

pszUserID	用户唯一 ID
pszUserName	用户名字

Returns: true 成功，false 失败

◆ SetUserStateUpdate()

ZEGO_API void ZEGO::AUDIOROOM::SetUserStateUpdate ( bool bUserStateUpdate )

设置用户进入/退出房间是否通知其他用户

Parameters

bUserStateUpdate 用户状态是否通知

Note: 在InitSDK之后调用

◆ SetUseTestEnv()

ZEGO_API void ZEGO::AUDIOROOM::SetUseTestEnv ( bool bTestEnv )

◆ SetVerbose()

ZEGO_API void ZEGO::AUDIOROOM::SetVerbose ( bool bVerbose )

◆ StartAudioCapture()

ZEGO_API bool ZEGO::AUDIOROOM::StartAudioCapture ( )

启动本地预览

◆ StartPlay()

ZEGO_API bool ZEGO::AUDIOROOM::StartPlay ( const char * pszStreamID )

开始播放流

Parameters

pszStreamID 播放流流 ID

Attention: 设置手动播放时有效

Returns: true 成功，false 失败

◆ StartPublish() [1/2]

ZEGO_API bool ZEGO::AUDIOROOM::StartPublish ( )

◆ StartPublish() [2/2]

ZEGO_API bool ZEGO::AUDIOROOM::StartPublish ( const char * pszStreamID )

◆ StopAudioCapture()

ZEGO_API bool ZEGO::AUDIOROOM::StopAudioCapture ( )

结束本地预览

◆ StopAudioVolumeNotify()

ZEGO_API bool ZEGO::AUDIOROOM::StopAudioVolumeNotify	(	AV::AudioDeviceType	deviceType,
		const char *	deviceId
	)

停止监听设备的音量变化

Parameters

deviceType	设备类型
deviceId	设备 Id

Returns: true 成功，false 失败

◆ StopPlay()

ZEGO_API void ZEGO::AUDIOROOM::StopPlay ( const char * pszStreamID )

停止播放流

Parameters

pszStreamID 流 ID

Attention: 设置手动播放时有效

◆ StopPublish()

ZEGO_API void ZEGO::AUDIOROOM::StopPublish ( )

◆ SwitchRoom()

ZEGO_API bool ZEGO::AUDIOROOM::SwitchRoom ( const char * pszRoomID )

切换房间接口调用成功会停止调用该接口之前的推拉流 (登录房间成功后，需要快速切换到其它房间时使用，切换结果回调OnLoginRoom)

Parameters

pszRoomID	房间 ID
role	成员角色
pszRoomName	房间名称

Returns: true 成功，false 失败

◆ UnInitSDK()

ZEGO_API bool ZEGO::AUDIOROOM::UnInitSDK ( )

反初始化 SDK

Returns: true 成功，false 失败

◆ UploadLog()

ZEGO_API void ZEGO::AUDIOROOM::UploadLog ( )

Classes

Functions

Function Documentation

◆ EnableAEC()

◆ EnableAGC()

◆ EnableAudioPostp()

◆ EnableAudioTrafficControl()

◆ EnableDTX()

◆ EnableLoopback()

◆ EnableMic()

◆ EnableMixSystemPlayout()

◆ EnableNoiseSuppress()

◆ EnableSelectedAudioRecord()

◆ EnableSpeaker()

◆ EnableVAD()

◆ FreeDeviceList()

◆ GetAudioDeviceList()

◆ GetCaptureSoundLevel()

◆ GetDefaultAudioDeviceId()

◆ GetMaxPlayChannelCount()

◆ GetMicDeviceVolume()

◆ GetSDKVersion()

◆ GetSDKVersion2()

◆ GetSoundLevel()

◆ GetSpeakerDeviceMute()

◆ GetSpeakerDeviceVolume()

◆ GetSpeakerSimpleMute()

◆ GetSpeakerSimpleVolume()

◆ InitSDK()

◆ LoginRoom()

◆ LogoutRoom()

◆ RestartPlayStream()

◆ RestartPublishStream()

◆ SendCustomCommand()

◆ SendRoomMessage()

◆ SetAudioBitrate()

◆ SetAudioChannelCount()

◆ SetAudioDevice()

◆ SetAudioDeviceMode()

◆ SetAudioDeviceStateCallback()

◆ SetAudioEngineCallback()

◆ SetAudioIMCallback()

◆ SetAudioLiveEventCallback()

◆ SetAudioLivePlayerCallback()

◆ SetAudioLivePublisherCallback()

◆ SetAudioPostpCallback()

◆ SetAudioPrepAfterLoopbackCallback()

◆ SetAudioPrepCallback()

◆ SetAudioRecordCallback()

◆ SetAudioRoomCallback()

◆ SetAudioVolumeNotify()

◆ SetBuiltInSpeakerOn()

◆ SetCaptureVolume()

◆ SetConfig()

◆ SetCustomToken()

◆ SetLatencyMode()

◆ SetLogDir()

◆ SetLoopbackVolume()

◆ SetManualPlay()

◆ SetManualPublish()

◆ SetMicDeviceVolume()

◆ SetNoiseSuppressMode()

◆ SetPlayVolume()

◆ SetPublishStreamExtraInfo()

◆ SetRecvBufferLevelLimit()

◆ SetSpeakerDeviceMute()

◆ SetSpeakerDeviceVolume()

◆ SetSpeakerSimpleMute()

◆ SetSpeakerSimpleVolume()

◆ SetSystemPlayoutVolumeBeforeMixing()

◆ SetUser()

◆ SetUserStateUpdate()

◆ SetUseTestEnv()

◆ SetVerbose()

◆ StartAudioCapture()

◆ StartPlay()

◆ StartPublish() [1/2]

◆ StartPublish() [2/2]

◆ StopAudioCapture()

◆ StopAudioVolumeNotify()