和缓SDK<Object-C版>对接文档.md 3.73 KB

和缓SDK对接文档 <简要流程版>

一:集成说明

  1. 您可以⼿动将 hhvDoctorSDKForOC.framework 及 TXLiteAVSDK_TRTC.framework 集成到项⽬中。集成后⼤概会使ipa包增加4.3M。

  2. 接⼊后需将hhVDoctorSDK.framework勾选为 Embed & Sign。此外,需要将 Enable Bitcode 勾选为 No。

  3. 为保障⽤户在视频问诊过程中将App压后台后仍能正常使⽤。需要在项⽬的 Background Modes 配置中 勾选

“Audio,Airplay, and Picture in Picture” 选项。

  1. 由于呼叫视频医⽣需要使⽤相机相册权限,需要在info.plist中添加对应的权限,否则会导致⽆法调⽤。
<key>NSPhotoLibraryUsageDescription</key> 
<string>应⽤需要使⽤相册权限,以便您向医⽣发送健康资料。</string> 
<key>NSCameraUsageDescription</key> 
<string>应⽤需使⽤相机权限,以便您向医⽣进⾏视频咨询。</string> 
<key>NSMicrophoneUsageDescription</key> <string>应⽤需使⽤⻨克⻛权限,以便您向医⽣进⾏视频咨询。</string>

二:初始化

在使⽤ HHDoctorSDK 任何⽅法之前,都应该⾸先调⽤初始化⽅法。正常业务情况下,初始化⽅法有仅只应调⽤⼀

次。示例代码如下:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.
    HHSDKOptions * options = [[HHSDKOptions alloc] initWithProductId:@"10284" isDebug:YES isDevelop:YES];
    [[HHMSDK sharedInstance] startWithOption:options];
}

注意:接入开发商在上线正式服之前,切记将isDebug和isDevelop 置为 NO

三:登录登出

在对医⽣视频呼叫之前,需要先登录账号信息。账号的 userToken 由视频医⽣提供⽅提供。

///接口定义
@interface HHMSDK : NSObject 

/// token登录
- (void) loginWithUserToken : (NSString *) token
                 completion :(void (^)(NSString *errorMsg))completion;

/// 登出
- (void) logout;

@end

调用示例代码:

//登录
[HHMSDK.sharedInstance loginWithUserToken:_mLoginToken.text completion:^(NSString *errorMsg) {       
    if (errorMsg == nil) {
      ///登录成功
    }else{
      ///登录失败
    }       
 }];

//登出
[HHMSDK.sharedInstance logout];

四:视频呼叫

///接口定义
@interface HHMSDK : NSObject

/// - Parameters:
/// - token: 呼叫人token
- (void) startCallWithUserToken : (NSString *) token;

@end

调用示例:

[HHMSDK.sharedInstance startCallWithUserToken: _mMemberToken.text];

五:医生回拨

///接口定义
@interface HHMSDK : NSObject

/// - Parameters:
/// - message: 医生回拨信息对应的JSON字符串
- (void) remoteMessage: (NSString *) message;

@end

调用示例:

[HHMSDK.sharedInstance remoteMessage: remoteMsg];

六:视频流程回调 HHMVideoDelegate

HHMSDK提供了整个视频流程回调的功能。

///接口定义
@interface HHMSDK : NSObject

- (void) add: (id<HHMVideoDelegate>) delegate;

- (void) remove: (id<HHMVideoDelegate>) delegate;

@end

调用示例:

[HHMSDK.sharedInstance add: self];

注:方法视频完成获取视频时长

@protocol HHMVideoDelegate<NSObject>

/// videoTime 通话时长,单位:秒
- (void)callDidFinish: (long) videoTime;

@end

七:设置呼叫视频医生附加参数

设置呼叫视频医生的时候可附加参数

///接口定义
@interface HHMSDK : NSObject

-(void)setCallExtension:(NSString *)callExtension;

@end

调用示例

[HHMSDK.sharedInstance setCallExtension:@"test data"];