接入流程

一、获取AppKey、AppSecretKey

在微吼官方平台上注册App

获取AppKey和AppSecretKey,使用SDK前需要先注册SDK。

二、SDK包下载

下载SDK包

微吼平台提供SDK包和demo。其中VHClassSDK即微吼课堂SDK,VHCFoundation作为基础组件,使用其他库时需先引入VHCFoundation库;VHClassSDKDemo是SDK的demo。

打开VHCSDK_iOS.xcworkspace即可查看demo和相关Api。

三、将SDK包VHClassSDK文件夹添加到项目中

引入SDK包后,将工程中任意文件.m改为.mm。

在TARGETS - General - Embedded Binaries下添加VhallLiveBaseApi、VhallSignalDynamic、WebRTC。

在TARGETS - Build Setting - Enable Bitcode 将值改为NO

添加系统依赖库libicucore.tbd

注意使用互动功能时,需要添加摄像头和麦克风的权限配置

四、注册SDK

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.
    
    //注册SDK
    [[VHClassSDK sharedSDK] initWithAppKey:@"您的AppKey" appSecretKey:@"您的AppSecretKey" apsForProduction:NO];

    return YES;
}

apsForProduction是设置开发还是测试环境,开发和测试环境下的AppKey、AppSecretKey有可能是不同的,上线请改为YES。

五、使用SDK

使用与课堂SDK的操作时,请先进入课堂:

/**
 @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;

调用如上方法,进入课堂。进入课堂后根据当前课堂状态处理相关业务。