Kivicube文档

简体中文

English

主题

什么是Kivicube? ​

Kivicube 是一个主要面向 AR 内容制作与分发的平台。你可以在平台中制作场景、组织合辑，然后以网页、小程序等形式进行展示。

对于开发者来说，Kivicube 的价值主要有两层：

  • 内容生产层：在 Kivicube 平台中完成场景搭建、素材上传、交互配置和发布。
  • 接入层：把已经发布的场景或合辑嵌入你自己的官网、H5 或活动页，并在 Web 端进行一定程度的 UI 和运行时能力定制。

这份文档解决什么问题 ​

这份文档聚焦第二层，也就是 Web 端接入与二次开发。你会在这里看到：

  • 如何通过 iframe 快速嵌入场景或合辑
  • 如何通过 iframe-plugin.js 打开、关闭、监听事件
  • 如何在宿主页面自定义首页、加载态、扫描态、拍照按钮等 UI
  • 如何使用高级 API 读取对象、创建内容、控制视频、动画、灯光和相机

平台构成概览 ​

平台架构图

制作端 ​

可使用 PC 或平板访问 https://cloud.kivicube.com，注册账号后在平台中创建场景、上传素材、配置交互，并发布为可访问的场景或合辑。

平台侧的制作说明可参考用户手册。

展示端 ​

发布后，平台会提供 Web 体验链接或二维码。对于开发接入来说，最关键的标识是：

  • sceneId：32 位场景 ID
  • collectionId：6 位合辑 ID

你既可以直接使用官方托管的体验页，也可以把它嵌入到自己的站点中。

官方托管页面 ​

Web 端场景一般形如：

text
https://www.kivicube.com/scenes/<sceneId>

合辑一般形如：

text
https://www.kivicube.com/collections/<collectionId>

如何接入你自己的网站 ​

请继续阅读下一页的快速上手。