https://api.netless.link/v5/rooms/{uuid}/scenes
Key |
是否必填 |
类型 |
备注 |
token |
required |
string |
SDK Token 或 Room Token(只读以上权限) |
region |
required |
string |
数据中心 ID |
Key |
是否必填 |
类型 |
备注 |
uuid |
required |
string |
房间的 UUID |
Key |
是否必填 |
类型 |
备注 |
sceneDir |
optional |
string |
返回哪个场景组下的场景列表(不填则返回根目录下的场景) |
创建截图成功
[
"/init",
"/6f026653989b4439b32a6899e7d32fed",
"/b3a423f8caaa4ff688c0e395431776a5"
]
https://api.netless.link/v5/rooms/{uuid}/scenes
服务器端 API 对场景API 的限制与客户端一致。
- path 参数,不能与现有页面的路径重叠。(类比与:无法向文件中插入文件)
- path + 插入的 scenes 中的 name,拼接出来的路径,与已有的页面路径一致时,由于路径具有唯一性,新页面会覆盖旧页面(新文件会覆盖旧文件)。
具体见 页面(场景)管理-插入页面
Key |
是否必填 |
类型 |
备注 |
token |
required |
string |
SDK Token 或 Room Token(可写权限以上) |
region |
required |
string |
数据中心 ID |
Key |
是否必填 |
类型 |
备注 |
uuid |
required |
string |
房间的 UUID |
¶ Body Parameters
Key |
是否必填 |
类型 |
备注 |
scenes |
required |
array |
由 Scene 组成的数组,标明要插入的场景的数据结构。 |
path |
required |
string |
新场景应该插入到那个场景组之中 |
{}
type Scene = {
name: string;
ppt?: {
src: string;
width: number;
height: number;
};
};
https://api.netless.link/v5/rooms/{uuid}/scene-state
以下情况,将无法正确切换:
- 路径对应的页面不存在。
- 路径对应的是页面目录,而非页面。
具体见 页面(场景)管理
Key |
是否必填 |
类型 |
备注 |
token |
required |
string |
SDK Token 或 Room Token(可写以上权限) |
region |
required |
string |
数据中心 ID |
Key |
是否必填 |
类型 |
备注 |
uuid |
required |
string |
房间的 UUID |
¶ Body Parameters
Key |
是否必填 |
类型 |
备注 |
scenePath |
required |
string |
换到的场景地址 |
创建成功、返回房间描述对象。
{
"currentScenePath": [
"/init"
]
}