集成 SDK 之前请首先在 Xcode 创建您的项目,如果您已有 macOS 项目,可直接集成 SDK。
无需上传 App Store 的应用关闭沙盒即可。上传 App Store 的应用会打开沙盒,此时 SDK 需要的最低配置如下(其他配置根据自己的需要添加):
在调用 API 之前需要进行初始化,您需要在该步骤中填入项目的 enterpriseId,如果您已经完成准备工作中的内容,则可以从管理平台获取到 enterpriseId。 初始化参数:
@interface XYSettings : NSObject
@property (nonatomic, copy) NSString *extId; // 企业ID(必填项,为nil时sdk内部会抛出异常)
@property (nonatomic, copy) NSString *server; // server地址,不设置则默认cloud.xylink.com
@property (nonatomic, assign) XYLogLevel level; // log等级
@property (nonatomic, assign) BOOL enableLog; // 是否打印log
@property (nonatomic, assign) int maxRecvVideoNum; // 最大接收的视频个数,默认值为8
@property (nonatomic, assign) XYLinkSDKLanguageType customLanguageType; // app需要的语言,默认是系统当前的语言
+ (XYSettings *)sharedXYSettings;
@end
// 调用下面的方法传入配置信息
/*
* 初始化XYLinkSDK环境
*
* @param settings 初始化参数
* @param aBlock 初始化完成block
*/
- (void)initWithSettings:(XYSettings *)settings block:(sdkCommonFunctionBlock)aBlock
初始化接口:
/*
* 初始化XYLinkSDK环境
*
* @param settings 初始化参数
* @param aBlock 初始化完成block
*/
- (void)initWithSettings:(XYSettings *)settings block:(sdkCommonFunctionBlock)aBlock
第三方登录接口
/*
* 使用第三方用户标识登录
*
* @param extUserId 第三方用户ID,需保证唯一性,建议使用自己业务系统的userId
* @param userName 第三方用户名,用于在会议中显示的用户名
* @param result 登录结果block,其中第一个BOOL表示登录是否成功,第二个BOOL表示是否需要网络探测,XYUser是账号信息, 登录成功时XYUser.error为nil,登录失败时XYUser.error代表具体的错误信息
*/
- (void)loginExternalAccount:(NSString *)extUserId
userName:(NSString *)userName
result:(loginResultBlock)result
小鱼账号登录接口
/*
* 使用小鱼账号登录
*
* @param userName 小鱼账号的用户名
* @param password 小鱼账号的密码
* @param result 登录结果block,其中第一个BOOL表示登录是否成功,第二个BOOL表示是否需要网络探测,XYUser是账号信息, 登录成功时XYUser.error为nil,登录失败时XYUser.error代表具体的错误信息
*/
- (void)loginXYLinkAccount:(NSString *)userName
password:(NSString *)password
result:(loginResultBlock)result
呼叫入会接口
/*
* 呼叫
*
* @param number 会议号或终端号,不可为空
* @param mode 呼叫类型
* 备注:请在收到回调xyLinkSDKOnNetworkDetectionFinished后再做呼叫操作。
*/
- (void)makeCall:(NSString *)number
callMode:(XYLinkSDKCallMode)mode
结束会议接口
/*
* 挂断
*
* @param type 挂断类型,没有与之对应的呼叫,不会进行任何操作
*/
- (void)hangup:(XYLinkSDKHangupType)type