梦想人AR SDK

[TOC]

• 声明

注：本文档"按原样"提供。本文档中表示的信息和视图（包括 URL 和其他 Internet 网站引用）可能会发生更改，且不进行通知。您需承担使用本文档的风险。

此处所述的某些示例仅为说明起见而提供，纯属虚构。不存在真实关联或连接，请勿妄加推测。

本文档未向您提供对任何梦想人产品的任意知识产权的任何法律权利。您可以复制和使用此文档，供内部参考之用。

©2019 梦想人科技 保留所有权利。

• 流程图

  

环境及配置

1. 开发工具：Xcode11
2. SDK版本：iOS 8.0
3. 支持架构： armv7s arm64 arm64e

配置Pod以及权限

1. 在Podfile中添加依赖：

   pod 'MXRSDK', :path => '../PodResource

   

2. Enable Bitcode设置为NO，在Header Search Path里需要添加MXRSDK.framewrok的头文件路径

   $(SRCROOT)/../MXRSDK/PodResource/MXRSDK.framework/Headers

3. 把PodResource文件夹下的Data以 Reference的方式拖进（添加）到工程项目中（展示模型相关文件）。

4. 需要设置对域名 mxrcorp.cn 的信任

   vide.mxrcorp.cn 、

   img.mxrcorp.cn 、

   qfile.mxrcorp.cn 、

   booksr.mxrcorp.cn、

   books.mxrcorp.cn、

   page.mxrcorp.cn、

   log.mxrcorp.cn、

5. 增加权限：相机、相册、麦克风、定位

接入说明

注册梦想人SDK

#import <MXRSDK.h>
/*
梦想人为了能提供更好更健全的SDK，内部集成了崩溃日志收集功能，如果贵方APP集成了的崩溃日志收集（三方或者自定义），请在崩溃初始化后再注册梦想人SDK。
*/
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [self initUMengSDK];
//    [self initUMengSDK];
    [MXRSDK registerWithAppId:nil];
    return YES;
}

初始化相关的操作接口

/// MXRSDK.h

/// 三方提供获取用户信息的能力，委托SDK进行相关的操作，未登录的时候请设置userId为nil
/// @see MXRSDKUser
@property (nonatomic, copy) MXRSDKUser *(^getUserBlock)(void);

/// 内存警告返回信息回调
///  @param currentVC 当前显示界面
@property (nonatomic, copy) void (^memoryWarningBlock)(UIViewController *currentVC);

接口说明

一、打开图书

​ 描述：在APP中新增专区入口，展示图书列表，点击进入阅读图书。

1. 获取图书信息列表

   // 请求图书列表block
   typedef void (^MXR4DGetBookArray) (NSError *err, NSArray<MXR4DBook *> *bookArray);
   
   /** 获取图书列表请求的模型
    */
   @interface MXR4DBookRequestM : NSObject
   
   @property (nonatomic, assign) NSInteger page;   // 页码
   @property (nonatomic, assign) NSInteger size;   // 每页图书数量
   @end
   
   //返回图书列表 NSArray<MXR4DBook *> *
   //MXR4DBook信息
   @interface MXR4DBook : NSObject
   @property (nonatomic, strong) NSString * bookGUID; //图书guid
   @property (nonatomic, strong) NSString * bookName; //图书名称
   @property (nonatomic, strong) NSString * bookCoverURL //图书封面
   @property (nonatomic, strong) CGFloat     bookSize; //图书大小
   /*
   '''
   其它信息省略，联系相关人员
   */
   @end

2. 打开图书（1.1版本新增说明）

   2.1 调用openBook方法打开相应图书。

   2.2 openBook方法说明：

   /// 三方图书类型，用来区分纸书和电子书
   typedef NS_ENUM(NSUInteger, MiguBookType) {
       MiguBookTypeNormal = 0,        // 普通图书
       MiguBookTypeEbook,         	   // 电子书，从三方h5页面入口的图书都认为是电子书
   };
   
   /// 需要登录的情况下返回NO
   /// push到图书阅读页面场景：如果图书已经下载到本地，且是可以打开的状态，则会打开到阅读页面，返回YES
   /// push到图书下载页面场景：如果图书未下载、图书暂停、图书等待、图书更新等状态，则直接下载该电子书并展示图书下载进度条，返回YES
   + (BOOL)openBook:(NSString *)bookGUID miguBookType:(MiguBookType)bookType;

二、打开模型

​ 场景2描述：在APP原有图书中新增4D模型入口，点击直接打开观看模型。

1. 打开模型

   1.1 open4DModel方法说明：

   /** 根据modelId打开对应模型页面
       @param modelId 模型唯一标识
   */
   + (void)openModel:(NSString *)modelId;

三、扫描接口返回

​ 描述：原扫描能力功过代理返回

/// MXRSDKScanVC.h

/// 设置进入扫一扫的类型，需要在push｜present之前设置好。 默认为普通扫一扫
@property (nonatomic, assign) MXRScanType scanType;

/// 配置入口属性，用来埋点。 需要三方设置
@property (nonatomic, assign) MXRScanEntrance entrance;

/// 扫描到普通二维码回调
/// @param scanVC 扫面页面
/// @param metadataObjects AVCaptureMetadataOutputObjectsDelegate返回的摄像头获取的原数据
/// @param value 解析出普通二维码数据
- (void)scanVC:(MXRSDKScanVC *)scanVC didOutputMetadataObjects:(NSArray *)metadataObjects value:(NSString *)value;

/// 用户点击扫一扫页面的返回按钮，不实现或者返回YES，SDK会自动返回上一层页面，否则不做任何操作
/// @param scanVC 扫描页面
- (BOOL)shouldReturnClickBackBtnOfScanVC:(MXRSDKScanVC *)scanVC;

/// 用户点击AR扫页面的更多 AR 图书按钮，页面层级由三方处理
/// @param scanVC 扫描页面
- (void)didClickMoreARBookBtnOfScanVC:(MXRSDKScanVC *)scanVC;

/// 用户使用AR 扫描下载图书，当用户没有登录的情况下，需要用户登录的代理方法
/// note: 层级关系由用户控制
/// @param scanVC 扫描页面
- (void)needLoginWithDownloadBookOfScanVC:(MXRSDKScanVC *)scanVC;

/// 打开图书，如果图书下载到本地可以打开，则打开，返回YES， 否则无法打开，返回NO，并尝试下载该书
/// 需要登录的情况下返回NO
+ (BOOL)openBook:(NSString *)bookGUID miguBookType:(MiguBookType)bookType;

四、分享接口

​ 描述：分享功能

​

/**
 分享图片接口
 1.1版本新增说明：如果是电子书的情况，图片上不会加水印
 
 分享渠道 shareType NSInteger 1微信好友，2微信朋友圈，3微博
 分享参数 params  NSDictionary
 包含 imageURL NSString类型 URL路径
 imageLocalPath NSString类型 本地沙盒路径
 [UIImage imageWithContentsOfFile:imageLocalPath]

 **/
-(void)callShareImageWithType:(NSInteger)shareType
                       params:(NSDictionary*)params;

/**
 分享链接

 分享渠道 shareType NSInteger 1微信好友，2微信朋友圈，3微博
 分享参数 params  NSDictionary
 微信好友渠道包含
 wechatFriendTitle NSString 微信好友标题
 wechatFriendContent NSString 微信好友内容
 wechatCircleTitle NSString 微信朋友圈标题
 weiboContent NSString 微博内容
 shareIcon NSString icon的图片
 shareURL NSString 分享链接
 */
-(void)callShareURLWithType:(NSInteger)shareType
                     params:(NSDictionary*)params;

五、APP调用扫一扫页面

​ 描述：从APP发起扫一扫

​ 1 点击精选右上方的扫一扫按钮

​ 2 点击精选banner & AR专区右上角的扫一扫按钮

​ 3 点击精选5G & AR专区右上角的扫一扫按钮

​ 相关交互：

///MXRSDK.h

/// 发送通知给咪咕告诉其进行处理浮窗 1.1需求新增
static NSString * const NOTI_MIGU_HIDDEN_AUDIOVIEW = @"NOTI_MIGU_HIDDEN_AUDIOVIEW";

/// 利用KVO的方式可以对其进行监听，实时刷新UI

/// 正在下载（包括等等下载）的图书数量，可以用KVO的方式进行监听实时刷新UI
@property (nonatomic, assign, readonly) NSUInteger downingBookNumber;

/// 所有图书数量，可以用KVO的方式进行监听实时刷新UI
@property (nonatomic, assign, readonly) NSUInteger totalBookNumber;

//// 由三方调用，扫描二维码下载图书需要登录时，在三方用户登录成功后，下载已扫描到的图书
/// note，请在dimiss或者pop完成的block中进行调用
- (void)downloadBookAfterSuccessfulLogin;

/// 由咪咕调用，在1.1版本需求中，点击电子书下载过程中，未登录场景下登录成功后需要调该方法，会自动打开下载页面。
/// note，请在dimiss或者pop完成的block中进行调用
- (void)downloadEBookAfterSuccessfulLogin;

六、埋点通知

​ 描述：SDK通知APP进行埋点

/// 提供数据统计的能力，委托SDK进行统计 （不建议使用该回调，请使用dataAnalysis）
@property (nonatomic, copy) void (^dataStatistics)(MXRSDKDataStatisticsType type, NSString *label) DEPRECATED_ATTRIBUTE
;

/// 三方提供数据统计的能力，委托SDK进行统计 param: {@"bookName": @"", @"bookGUID": @""}
@property (nonatomic, copy) void (^dataAnalysis)(MXRSDKDataStatisticsType type, NSString *label, NSDictionary *param);

七、其他

由于该SDK依赖的集成的SSZipArchive三方库有个中文乱码的bug，需要手动修改源码：

在该库的SSZipArchive.m文件中，把kCFStringEncodingDOSLatinUS改为kCFStringEncodingGB_18030_2000来防止中文乱码