KAPI

界面

本页目录

场景模块 ​

介绍 ​

场景模块主要是提供一些基础的场景操作功能，比如获取场景分辨率、入场动画的控制、声音的控制等，具体功能使用可以参考Scene API。

作为最重要的功能模块，其中的new Scene(id, options)是初始化场景的第一个方法，也是区别于其他功能模块最重要的方法，以后的场景操作、相机操作、事件等功能才有实现的基础。

功能使用 ​

比如场景初始化如下：

html
<div id='kapi-container'></div>

<script src='https://unpkg.com/@ibrucekong/kapi'></script>

<script>
  // 授权码
  const kapi = await KAPI.build('Your Auth Token')
  // 加载云流场景服务
  const scene = new kapi.Scene('kapi-container', { server: 'Your Service URL' })
  // 等待场景加载好
  const readyState = await scene.ready()
  // 打印状态
  console.log(readyState)
</script>

结果如下图：

功能扩展 ​

在场景初始化好后，就可以操作一些其他功能，比如开启入场动画：

js
// 上面实例化的 scene 变量
const entrance = await scene.startEntrance()
// 打印 开启入场动画的结果
console.log(entrance)

同样可以执行暂停入场动画：

js
// 上面实例化的 scene 变量
const entrance = await scene.pauseEntrance()
// 打印 暂停入场动画的结果
console.log(entrance)

执行停止入场动画：

js
// 上面实例化的 scene 变量
const entrance = await scene.stopEntrance()
// 打印 停止入场动画的结果
console.log(entrance)

也可以执行声音控制的功能，比如开启静音：

js
// 上面实例化的 scene 变量
const mute = await scene.mute()
// 打印 开启静音的结果
console.log(mute)

执行取消静音：

js
// 上面实例化的 scene 变量
const unmute = await scene.unmute()
// 打印 开启静音的结果
console.log(unmute)

由此看见，一些操作的前提是场景初始化好，所以平台在使用时，会首先执行new Scene(id, options)，具体可参考Scene API