用户登录
登录即“进入课堂”,是指当前用户进入“微吼课堂房间”的过程。
VHCFundation
VHCFundation是微吼课堂SDK基础库,其中VHClassSDK类是“课堂”的管理类,通过如下Api进入课堂。
进入课堂
传入用户昵称,当前要进入的课堂的课堂id,和需要的“口令”,验证通过即可进入课堂进行“参会”。
/**
@brief 进入课堂房间,异步函数
@param roomId 要进入的房间id
@param keyValue 要进入的房间口令,即进入房间的密码
@param nickName 用户昵称
@param sucess 进入成功,返回“参会id”,参会id即用户再此课堂中的用户id
@param failed 进入失败,返回失败原因
*/
- (void)joinClassWithNickName:(nonnull NSString *)nickName
roomId:(nonnull NSString *)roomId
key:(nonnull NSString *)keyValue
sucessed:(void(^)(NSString *joinId,VHClassBaseInfo *result))sucess
failed:(void(^)(VHCError *error))failed;
进入课堂后,讲师端将显示您已进入状态。进入课堂后可以看直播、进行互动等。
获取课堂基础信息
/**
@brief 获取课堂基本信息,异步函数
@param roomId 课堂id
@param sucess 成功,返回课堂基本信息 @see VHClassSDKBaseInfo
@param failed 获取出错,返回错误信息
*/
- (void)classBaseInfoWithRoomId:(nonnull NSString *)roomId
sucessed:(void(^)(VHClassBaseInfo *result))sucess
failed:(void(^)(VHCError *error))failed;
获取的基本信息通过block回调,在result中查看课堂基础属性,包括布局、课堂状态等,见VHClassBaseInfo 。
离开课堂
即离开当前的课堂,可以理解为退出登录。
/**
@brief 退出课堂
@discussion 退出课堂将关闭与课堂相关的系统消息
@warning 离开课堂时请务必调用此方法
*/
- (void)leaveRoom;
离开课堂将停止与课堂之间的通信等。