用户登录

登录即“进入课堂”,是指当前用户进入“微吼课堂房间”的过程。

VHCFundation

VHCFundation是微吼课堂SDK基础库,其中VHClassSDK类是“课堂”的管理类,通过如下Api进入课堂。

进入课堂

使用SDK其他模块功能前,需要先进入课堂。直播、互动等功能都是在课堂内完成的,所以进入课堂才会有其他模块功能的使用权限。

成功进入课堂后用户就会在微吼课堂的讲师端列表中显示出来。

进入课堂后根据当前课堂的状态选择进入不同的功能模块,如果当前是直播状态,则可以进行看直播、互动。

进入课堂后,讲师端将显示您已进入状态。进入课堂后可以看直播、进行互动等。

获取课堂基础信息

/**
 @brief 获取课堂基本信息,异步函数
 @param roomId   课堂id
 @param sucess   成功,返回课堂基本信息  @see VHClassSDKBaseInfo
 @param failed   获取出错,返回错误信息
 */
+ (void)getClassInfoWithRoomId:(nonnull NSString *)roomId
                                  sucessed:(void(^)(VHClassBaseInfo *result))sucess
                                      failed:(void(^)(VHCError *error))failed;

进入课堂

/**
  @brief          登录,异步函数
  @param roomId   房间id
  @param nickName 用户昵称
  @param keyValue 口令
  @param sucess   登录成功,返回用户参会id
  @param failed   登录失败,返回失败原因
 */
+ (void)joinWithRoomId:(NSString *)roomId
                           name:(NSString *)nickName
                              key:(nullable NSString *)keyValue
                      sucessed:(void(^)(NSString *joinId,NSString *accessToken,VHClassBaseInfo *result))sucess
                          failed:(void(^)(VHCError *error))failed;

获取的基本信息通过block回调,在result中查看课堂基础属性,包括布局、课堂状态等。

系列课

系列课登录

/**
 @brief          登录,异步函数
 @param roomId   房间id
 @param nickName 用户昵称
 @param keyValue 口令
 @param resourceType 系列课资源类型 系列课中信息 1、系列课资源类型回放 2、系列课资源类型音视频 3、系列课资源类型课程
 @param resourceId   系列课资源ID
 @param sucess   登录成功,返回用户参会id
 @param failed   登录失败,返回失败原因
 */
+ (void)joinWithRoomId:(NSString *)roomId
                           name:(NSString *)nickName
                              key:(nullable NSString *)keyValue
                          phone:(nullable NSString *)phone
               resourceType:(int)resourceType
                    resourceId:(nullable NSString *)resourceId
                       sucessed:(void(^)(NSString *joinId,NSString *accessToken,VHClassBaseInfo *result))sucess
                           failed:(void(^)(VHCError *error))failed;

获取系列课基本信息

/**
 @brief 获取系列课堂基本信息,异步函数
 @param roomId   课堂id
 @param nickName 用户昵称
 @param keyValue 口令
 @param sucess   成功,返回课堂基本信息  @see VHClassSDKBaseInfo
 @param failed   获取出错,返回错误信息
 */
+ (void)getSeriesClassInfoWithRoomId:(nonnull NSString *)roomId
                                                name:(NSString *)nickName
                                                  key:(nullable NSString *)keyValue
                                              phone:(nullable NSString *)phone
                                          sucessed:(void(^)(VHClassBaseInfo *result))sucess
                                              failed:(void(^)(VHCError *error))failed;

离开课堂

即离开当前的课堂,可以理解为退出登录。

/**
 @brief 退出课堂
 @discussion 退出课堂将关闭与课堂相关的系统消息
 @warning 离开课堂时请务必调用此方法
 */
+ (void)leaveRoom;

离开课堂将停止与课堂之间的通信等。