ZEGO iOS API Reference

下载pdf
更新时间:2019-06-13 17:42

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点,提供丰富的 API,为多端提供清晰稳定的实时语音视频云服务。

基本功能方法

此分类下主要包括初始化 SDK 和房间操作、麦位更新等方法。

方法 描述
属性
musicPlayer 音乐播放器
userInfo 当前用户
roomID 当前登录房间ID
liveConfig 语聊房上麦配置
seats 语聊房麦位信息数组
loginStatus 房间登录状态
liveStatus 当前用户直播状态
autoReconnectRoom 登录失败是否自动重连
autoReconnectTimeout 登录自动重连超时时间(s)
初始化
+ setAppID:appSignature:user: 设置语聊房单例初始化配置
+ shared 获取语聊房单例
+ releaseShared 释放当前语聊房单例
代理
- addDelegate: 添加ZegoChatroom代理
- removeDelegate: 移除ZegoChatroom代理
房间
- createRoomWithRoomID:roomName:seatCount:liveConfig: 创建并进入房间
- createRoomWithRoomID:roomName:initialSeats:liveConfig: 创建并进入房间(自定义麦位)
- joinRoom:liveConfig: 进入已有房间
- leaveRoom 离开当前房间
麦位操作
- takeSeatAtIndex:completion: 麦位操作,上麦
- leaveSeatWithCompletion: 麦位操作,下麦
- changeSeatTo:completion: 麦位操作,换麦
- pickUp:atIndex:completion: 麦位操作,抱人上麦
- kickOut:completion: 麦位操作,抱人下麦
- muteSeat:atIndex:completion: 麦位操作,禁麦、解禁
- closeSeat:atIndex:completion: 麦位操作,封麦、解封
- runSeatOperationGroup:completion: 执行一组麦位操作
其他
- muteMic: 禁用手机的麦克风
- muteSpeaker: 扬声器静音
- setPublishVolume: 设置本地推流音量
- setPlayVolume: 设置远程拉流音量
- setLiveExtraInfo: 设置直播额外信息

IM

方法 描述
- addIMDelegate: 添加ZegoChatroomIM代理
- removeIMDelegate: 移除ZegoChatroomIM代理
- setChatroomEnableUserStateUpdate: 设置房间是否广播用户状态
- sendChatroomMessage:type:completion: 发送房间内广播消息

音效

属性 描述
enableLoopback 开启采集监听(耳返)
virtualStereoAngle 虚拟立体声角度
voiceChangeValue 变声音调
audioReverbConfig 音频混响配置

信令

方法 描述
- addCMDDelegate: 添加ZegoChatroom信令代理
- removeCMDDelegate: 移除ZegoChatroom信令代理
- sendCustomCommand:memberList:completion: 发送信令

开发者

方法 描述
+ setUseTestEnv: 是否启用测试环境
+ uploadLog 上报日志

MusicPlayer

方法 描述
属性
playlist 音乐列表
currentResource 当前播放音乐
totalDuration 当前播放音乐的总时长(s,在资源开始播放回调后该值有效,0为无效值)
currentTime 当前播放音乐的时间进度(s,在资源开始播放回调后该值有效,小于0为无效值)
currentState 当前播放状态
isBuffering 是否正在缓冲
playMode 播放循环模式
musicVolume 音乐音量,范围在0到100,默认值是50
soundEffectVolume 音效音量,范围在0到100,默认值是50
代理
- addDelegate: 添加代理对象
- removeDelegate: 移除代理对象
播放操作
- setPlaylist: 设置音乐播放列表
- addMusicsToCurrentPlaylist: 播放列表后添加音乐
- removeMusicFromPlaylist: 删除播放列表中指定索引的音乐
- play 开始播放
- pause 暂停播放
- stop 停止播放
- seekToTime: 设置指定的进度进行播放
- playNextMusic 播放下一首
- playPreviousMusic 播放上一首
- playMusicFromIndex: 从音乐列表中指定索引处开始播放
- playSoundEffect: 播放音效

基本功能回调

方法 描述
- chatroom:didSeatsUpdate: 语聊房麦位更新回调(全量更新)
- chatroomDidAVEngineStop: SDK音视频引擎停止工作
- chatroom:didLoginEventOccur:loginStatus:error: 语聊房登录状态、事件回调
- chatroom:didAutoReconnectRoomStop: 语聊房登录重连终止回调
- chatroom:didLiveStatusUpdate:user: 语聊房上麦者直播连接状态更新回调
- chatroom:didLiveExtraInfoUpdate:user: 语聊房上麦者直播额外信息更新回调
- chatroom:didSoundLevelUpdate:user: 语聊房上麦者音量更新回调
- chatroom:didLiveQualityUpdate:user: 用户直播质量回调
- chatroom:didUserTakeSeat:atIndex: 语聊房麦位操作回调–上麦
- chatroom:didUserLeaveSeat:atIndex: 语聊房麦位操作回调–下麦
- chatroom:didUserChangeSeat:from:to: 语聊房麦位操作回调–换麦
- chatroom:didUser:pickUpUser:atIndex: 语聊房麦位操作回调–抱人上麦
- chatroom:didUser:kickOutUser:atIndex: 语聊房麦位操作回调–抱人下麦
- chatroom:didUser:muteSeat:atIndex: 语聊房麦位操作回调–禁麦、解禁
- chatroom:didUser:closeSeat:atIndex: 语聊房麦位操作回调–封麦、解封

IM回调

方法 描述
- chatroom:didRecvChatroomMessage: 语聊房收到IM消息回调
- chatroom:didOnlineCountUpdate: 语聊房房间人数更新回调
- chatroom:didUserJoin: 语聊房用户进入回调
- chatroom:didUserLeave: 语聊房用户离开回调

信令回调

方法 描述
- chatroom:didRecvCustomCommand:from: 语聊房收到信令回调

播放器回调

方法 描述
- player:shouldPlayMusicResource: 即将播放音乐回调
- player:didMusicPlayStateChange:state:error: 播放状态变化回调
- player:didMusicBufferStateChange: 音乐播放缓冲回调
- player:didMusicSeekTo: 音乐播放进度指定回调
- player:didSoundEffectStart: 音效播放回调