快速开始

下载pdf
更新时间:2019-12-09 19:04

1 初始化 SDK

1.1 申请 AppID 与 AppSign

请在 即构管理控制台 申请 SDK 初始化需要的 AppID 和 AppSign,获取AppID 和 AppSign 指引

1.2 导入 SDK 头文件

使用 SDK 前,需要导入头文件:

#import <ZegoChatroom/ZegoChatroom.h>

1.3 初始化 SDK

示例代码如下:

// 设置测试环境
[ZegoChatroom setUseTestEnv:YES];

// 设置语聊房单例初始化配置
[ZegoChatroom setAppID:appID appSignature:appSign user:ZGUserHelper.user];

// 初始化 ZegoChatroom 单例对象。
[ZegoChatroom shared];

初始化完成后,开发者即可调用 SDK 相关接口,实现语聊功能。

2 进入房间

进入房间前,由于不知道当前房间是否存在,如果不存在,则需要在进入房间时初始化房间麦位,所以目前进入房间需要传默认麦位。

示例代码如下:

[ZegoChatroom.shared joinRoomWithRoomID:roomID roomName:roomName seatCount:seatCount liveConfig:nil];

3 操作麦位

语聊房提供一组麦位,观众可以通过进入麦位(上麦)加入直播互动,离开麦位(下麦)就是离开直播互动,此外还有换麦、抱麦、禁麦、封麦等操作。

此处以上麦、下麦操作为例:

//上麦操作
NSUInteger index = 0;//想要上麦的麦位索引
[ZegoChatroom.shared takeSeatAtIndex:index completion:^(NSError * _Nullable error) {
    //成功回调
}];

//下麦操作
[ZegoChatroom.shared leaveSeatWithCompletion:^(NSError * _Nullable error) {
    //成功回调                
}];

4 离开房间

示例代码如下:

[ZegoChatroom.shared leaveRoom];

5 简要流程实例

5.1 主播简要流程示例

  1. 初始化
  2. 加入房间
  3. 执行麦位操作
  4. 离开房间
// Step1.初始化
[ZegoChatroom setAppID:YourAppID appSignature:YourAppSignature user:user];

// Step2.加入房间
[ZegoChatroom.shared joinRoomWithRoomID:roomID roomName:roomName seatCount:seatCount liveConfig:nil];

// Step3.待登录成功即可执行麦位操作
// 执行上麦操作,将进入该麦位变为上麦者,上麦后房间内的成员即可听到上麦者的声音
[ZegoChatroom.shared takeSeatAtIndex:0 completion:^(NSError * _Nullable error) {
    //do something...
}];

...

// 执行下麦操作,将离开对应麦位变为观众,上麦者在下麦后房间内的成员就无法听到其声音
[ZegoChatroom.shared leaveSeatWithCompletion:^(NSError * _Nullable error) {
    //do something...
}];

// Step4.离开房间
[ZegoChatroom.sharedChatroom leaveRoom];

5.2 观众简要流程示例

  1. 初始化
  2. 加入房间
  3. 执行麦位操作(略)
  4. 离开房间
// Step1.初始化
[ZegoChatroom setAppID:YourAppID appSignature:YourAppSignature user:user];

// Step2.加入房间,如果房主已在上麦,则进入房间就可以听见房主的声音
[ZegoChatroom.shared joinRoomWithRoomID:roomID roomName:roomName seatCount:seatCount liveConfig:nil];

// Step3.待登录成功即可执行麦位操作
...

// Step4.离开房间
[ZegoChatroom.shared leaveRoom];

5.3 调用时序图

主播、观众方法的具体调用时序如图: