ZegoAudioRoomApi Class Reference

Inherits from NSObject
Declared in ZegoAudioRoomApi.h

+ setUseTestEnv:

是否启用测试环境

+ (void)setUseTestEnv:(bool)useTestEnv

Parameters

useTestEnv

是否使用测试环境

Declared In

ZegoAudioRoomApi.h

+ setVerbose:

调试信息开关

+ (void)setVerbose:(bool)bOnVerbose

Parameters

bOnVerbose

是否使用测试环境

Discussion

建议在调试阶段打开此开关,方便调试。默认关闭

Declared In

ZegoAudioRoomApi.h

+ uploadLog

触发日志上报

+ (void)uploadLog

Discussion

在初始化 SDK 成功后调用

Declared In

ZegoAudioRoomApi.h

+ setUserID:userName:

设置用户ID及用户名

+ (bool)setUserID:(NSString *)userID userName:(NSString *)userName

Parameters

userID

用户ID

userName

用户名

Return Value

设置结果

Declared In

ZegoAudioRoomApi.h

+ setLogSize:

设置SDK日志大小

+ (void)setLogSize:(unsigned int)size

Parameters

size

日志大小,单位为字节。取值范围[510241024, 10010241024]

Discussion

在初始化 SDK 之前调用有效

Declared In

ZegoAudioRoomApi.h

+ setLogDir:size:subFolder:

设置SDK日志存储目录及大小

+ (void)setLogDir:(NSString *)logDir size:(unsigned int)size subFolder:(NSString *)subFolder

Parameters

logDir

日志文件存储路径,如果为空,则存储到默认路径

size

日志大小,单位为字节。取值范围[510241024, 10010241024]

subFolder

日志存储子文件夹,当为空时,不创建子文件夹。该文件夹是 logDir 的子目录。

Discussion

在初始化 SDK 之前调用有效

Declared In

ZegoAudioRoomApi.h

– initWithAppID:appSignature:

初始化SDK

- (instancetype)initWithAppID:(unsigned int)appID appSignature:(NSData *)appSignature

Parameters

appID

Zego派发的数字ID, 各个开发者的唯一标识

appSignature

Zego派发的签名, 用来校验对应appID的合法性

Return Value

api 实例,nil 表示初始化失败

Declared In

ZegoAudioRoomApi.h

– setAudioRoomDelegate:

设置房间的 delegate

- (void)setAudioRoomDelegate:(id<ZegoAudioRoomDelegate>)roomDelegate

Parameters

roomDelegate

房间 delegate

Declared In

ZegoAudioRoomApi.h

– setManualPublish:

设置是否需要手动发布直播

- (void)setManualPublish:(bool)manual

Parameters

manual

是否手动发布直播,YES:手动发布直播,NO:进入房间后自动发布直播。默认为 NO

Discussion

必须在登录房间前调用

Declared In

ZegoAudioRoomApi.h

– setManualPlay:

设置是否需要手动播放

- (void)setManualPlay:(bool)manual

Parameters

manual

是否手动播放,YES:手动播放,NO:收到流更新后自动播放。默认为 NO

Discussion

必须在登录房间前调用

Declared In

ZegoAudioRoomApi.h

– setCustomToken:

设置自定义token信息

- (void)setCustomToken:(NSString *)thirdPartyToken

Parameters

thirdPartyToken

第三方传入的token

Discussion

使用此方法验证登录时用户的合法性,登录房间前调用,token的生成规则请联系即构。若不需要验证用户合法性,不需要调用此函数。

在登录房间前调用有效,退出房间后失效

Declared In

ZegoAudioRoomApi.h

– loginRoom:completionBlock:

登录房间

- (bool)loginRoom:(NSString *)roomID completionBlock:(ZegoAudioRoomBlock)block

Parameters

roomID

房间唯一ID

block

房间登录结果回调

Return Value

调用登录房间的结果

Declared In

ZegoAudioRoomApi.h

– logoutRoom

退出房间

- (bool)logoutRoom

Return Value

true 成功,false 失败

Discussion

会停止所有的推拉流

Declared In

ZegoAudioRoomApi.h

– setAudioLiveEventDelegate:

设置直播事件代理对象

- (void)setAudioLiveEventDelegate:(id<ZegoAudioLiveEventDelegate>)liveEventDelegate

Parameters

liveEventDelegate

遵循 ZegoAudioLiveEventDelegate 协议的代理对象

Discussion

设置代理对象成功后,在 [ZegoAudioLiveEventDelegate -zego_onLiveEvent:info:] 中获取直播状态,状态参考 ZegoLiveEvent 定义。未设置代理对象,或对象设置错误,可能导致无法正常收到相关回调

Declared In

ZegoAudioRoomApi.h

– setAudioDeviceEventDelegate:

设置音视频设备错误回调代理对象

- (void)setAudioDeviceEventDelegate:(id<ZegoAudioDeviceEventDelegate>)deviceEventDelegate

Parameters

deviceEventDelegate

遵循 ZegoAudioDeviceEventDelegate 协议的代理对象

Discussion

开发者获取音视频设备错误,需要先设置此代理对象。未设置代理对象,或对象设置错误,可能导致无法正常收到相关回调

Declared In

ZegoAudioRoomApi.h

– pauseAudioModule

暂停模块

- (void)pauseAudioModule

Discussion

用于需要暂停指定模块的场合,例如来电时暂定音频模块。暂停指定模块后,注意在合适时机下恢复模块

Declared In

ZegoAudioRoomApi.h

– resumeAudioModule

恢复模块

- (void)resumeAudioModule

Discussion

用于需要恢复指定模块的场合,例如来电结束后恢复音频模块。暂停指定模块后,注意在合适时机下恢复模块

Declared In

ZegoAudioRoomApi.h

– setAudioRouteDelegate:

设置音频路由回调

- (void)setAudioRouteDelegate:(id<ZegoAudioRouteDelegate>)delegate

Parameters

delegate

回调

Declared In

ZegoAudioRoomApi.h

– enableMicDevice:

设置是否允许SDK使用麦克风设备

- (BOOL)enableMicDevice:(BOOL)enable

Parameters

enable

YES 表示允许使用麦克风,NO 表示禁止使用麦克风,此时如果SDK在占用麦克风则会立即释放。

Return Value

YES 调用成功 NO 调用失败

Discussion

调用时机为引擎创建后的任意时刻。

Note: 接口由于涉及对设备的操作,极为耗时,不建议随便调用,只在真正需要让出麦克风给其他应用的时候才调用

Declared In

ZegoAudioRoomApi.h

– setAVEngineDelegate:

Engine停止回调

- (void)setAVEngineDelegate:(id<ZegoAVEngineDelegate>)engineDelegate

Parameters

engineDelegate

engine Delegate

Declared In

ZegoAudioRoomApi.h

+ setConfig:

设置配置信息

+ (void)setConfig:(NSString *)config

Parameters

config

配置信息

Discussion

必须在Init SDK前调用

Declared In

ZegoAudioRoomApi.h

– setUserStateUpdate:

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

- (void)setUserStateUpdate:(bool)userStateUpdate

Parameters

userStateUpdate

是否需要通知其他用户

Discussion

默认不通知

Declared In

ZegoAudioRoomApi.h

– sendCustomCommand:content:completion:

发送自定义信令

- (bool)sendCustomCommand:(NSArray<ZegoUser*> *)memberList content:(NSString *)content completion:(ZegoCustomCommandBlock)block

Parameters

memberList

发送对象列表

content

消息内容

block

消息发送结果

Return Value

true 成功,false 失败

Discussion

信令内容由用户自定义。发送结果通过 block 回调

Declared In

ZegoAudioRoomApi.h

– setNetTypeDelegate:

设置网络类型回调

- (void)setNetTypeDelegate:(id<ZegoNetTypeDelegate>)delegate

Parameters

delegate

回调

Declared In

ZegoAudioRoomApi.h