1 接入准备

1.1 成为开发者

申请开通微吼云账号，提供用户资料，微吼服务人员在后台为用户开通平台账号，账号开通后，用户即可登录，成为一名开发者。

1.2 创建应用

登录微吼云平台后，控制台选择应用管理，进入应用管理页面点击创建应用，根据页面提示信息，完成应用创建。应用创建完成，您可以在控制台界面找到在应用管理界面您可以找到 AppID。

1.3 添加服务

应用创建完成后，选择添加服务，添加文档服务，添加成功后可在文档服务下文档管理的【文档配置】页面查看AppID

1.4 SDK下载

SDK下载

2 工程配置

2.1 支持平台

  • SDK支持iOS 8.0以上系统

2.2 开发环境

  • Xcode 8或更高版本
  • OS X 10.10或更高版本

2.3 Xcode工程设置

下面通过一个简单的iOS Application工程，说明如和在Xcode工程中配置SDK。

2.3.1 拷贝SDK文件

在本例中，新建一个名字叫做VHSDKDemo的iOS工程，将下载下来的文件夹拷贝至工程目录。目录结构如下图所示：

2.3.2 添加库和Framework

libc++.tbd
libz2.1.0.tbd
libicucore.tbd
libz.tbd
libiconv.tbd
CoreTelephony.framework
MediaPlayer.framework
AVFoundation.framework
VideoToolbox.framework
AssetsLibrary.framework
OpenAL.framework
OpenGLES.framework
QuartzCore.framework
CoreMedia.framework
Security.framework

2.3.3 工程设置修改

  • AppDelegate.m 文件名修改为AppDelegate.mm
  • Build Setting 中 Enable Bitcode 设置为NO
  • 设置Info.plist中 App Transport Security Settings -> Allow Arbitrary Loads 设置为 YES
  • 设置Info.pplist中 Privacy - Camera Usage Description 是否允许使用相机
  • 设置Info.pplist中 Privacy - Microphone Usage Description 是否允许使用麦克风

2.4 验证

下面在VHSDKDemo的代码中，调用SDK的接口，设置appID 获取SDK版本信息，以验证工程设置是否正确。

2.4.1 引用头文件

在AppDelegate.mm开头引用SDK的头文件：

#import "VHLiveBase.h"

2.4.2 添加调用代码

在application: didFinishLaunchingWithOptions:方法中添加代码：

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [VHLiveBase registerApp:@"xxxxxxxxx"];//AppID：xxxxxxxxx
    [VHLiveBase setThirdPartyUserId:@"xxxxxxxx"];//第三方账号id：xxxxxxxx
    NSLog(@"SDK Version: %@",[VHLiveBase getSDKVersion]);
    return YES;
}

2.4.3 编译运行

如果前面各个步骤都操作正确的话，VHSDKDemo工程应该可以顺利编译通过。在Debug模式下运行APP，Xcode的Console窗格会打印出SDK的版本信息。

至此，工程配置完成。

3 注册APP

[VHLiveBase registerApp:@"xxxxxxxxx"];//AppID：xxxxxxxxx

4 设置第三方ID

[VHLiveBase setThirdPartyUserId:@"xxxxxxxx"];//第三方账号id：xxxxxxxx

5 LOG打印

在 VHLiveBase 中可以设置 log的级别，具体代码如下：

[VHLiveBase setLogLevel:VHLogLevelDebug];

6 获取channel_id、access_token

获取channel_id、access_token

7 代码对接

7.1 创建Document

SDK 中的 VHDocument 模块负责实现 文档服务相关功能。

  • channelID 频道id 可以通过调用 api 创建
  • accessToken 可以通过调用 api 获得
    NSString* channelID = @"xxxxxx";
    NSString* accessToken = @"xxxxxxxxxx";
    VHDocument *_document = [[VHDocument alloc]initWithChannelID:channelID accessToken:accessToken];

点播文档模块初始化

  • recordId 点播id 可以通过调用 api 创建
    NSString* recordId = @"xxxxxx";
    VHDocument *_document = [[VHDocument alloc]initWithRecordID:recordId];

7.2 设置 渲染View、delegate

  • delegate 设置文档代理
  • 接下来我们要给文档画面找个地方来显示，iOS系统中使用 view 作为基本的界面渲染单位，所以您只需要准备一个 view 并调整好布局就可以了。
    _document.delegate = self;
    _document.view.frame = self.view.bounds;
    [self.view insertSubview:_document.view atIndex:0];

7.3 文档loading显示状态

默认显示loading 不需要设置为NO

_document.showIndicator = YES;

7.4 高级功能

自定义翻页接口

  • documentID 文档id 可以通过调用 api 获得
  • pageID 需要展示的文档页码
NSString* documentID = @"xxxxxx";
NSString* pageID = @"1";
[_document nextPage:documentID pageID:pageID];

8 事件处理

8.1 错误回调

/**
 *  错误回调
 *  @param document 文档实例
 *  @param error    错误
 */
- (void)document:(VHDocument *)document error:(NSError *)error;