baiduAR

来自于:开发者立即使用

startARActivity

概述

DuMix AR简介

DuMix AR开放平台是百度AR正式推出的AR技术产品化应用服务,帮助开发者快速集成SDK,高效制作并分发AR内容。它包括AR SDK、内容制作工具、云端内容平台和内容分发服务,组成了一站式AR开发集成解决方案。

baiduAR 模块概述

本模块封装了DuMix AR开放平台的AR SDK,可以方便快捷的接入AR内容展示。

模块使用攻略

使用之前须从DuMix AR开放平台申请开发者账号并创建应用,获取 AppId、APIKey和 SecretKey。百度 AR控制台

使用本模块需要自己制作AR内容,请参考以下2个文档进行AR内容制作AR内容制作指南 适用于内容开发人员,介绍AR内容制作的入门教程。AR内容制作专题文档 适用于内容开发人员,分专题介绍AR内容的制作。

使用此模块之前建议先配置config.xml文件,配置完毕,需通过云端编译生效,配置方法如下:

  • 名称:baiduAR
  • 参数:AppId、APIKey、SecretKey
  • 配置示例:
  1. <feature name="baiduAR">
  2. <param name="AppId" value="10505227"/>
  3. <param name="APIKey" value="bsZQtN53DSWPbMuQqWhjFycO"/>
  4. <param name="SecretKey" value="ozhyztAAW9lta0nHdjCeQmYbVI33RGct"/>
  5. </feature>

License文件打包模块包需注意事项请参考License打包模块包注意事项

固件要求

Android:4.4.0及以上 iOS:8.0及以上

论坛示例

为帮助用户更好更快的使用模块,论坛维护了一个示例,示例中包含示例代码供您参考。

模块接口

startARActivity

打开AR识别界面

startARActivity({params}, callback(ret, err))

params

arKey:

  • 类型:字符串
  • 描述:(必填项)从DuMix AR内容平台获取的 arKey 。

arType:

  • 类型:数字型
  • 描述:(可选项)从DuMix AR内容平台获取的 arType 。
  • 默认值:0

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true, //布尔型;true||false
  3. evenType : 'share', // share 分享|openUrl 透传url |nonsupport 手机不支持当前AR时
  4. url : '',//openUrl、nonsupport 有值
  5. title : '', //分享标题
  6. content : '', //分享描述
  7. shareUrl : '', //分享url
  8. iconUrl : '', //图片或者视频url
  9. type : '' //1 视频,2 图片
  10. }

err:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. msg : ''
  3. }

示例代码

  1. var demo = api.require('baiduAR');
  2. demo.startARActivity({
  3. arKey : '10002431',
  4. arType : 0
  5. }, function(ret, err){
  6. alert(JSON.stringify(ret));
  7. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本