SetSceneTemplate
https://metaworld-api.zego.im/
Express 支持自定义场景模版配置,用于登录到对应配置的场景。 当系统预置的配置模板无法满足您的业务需求时,您可以通过该服务端 API 创建自定义模板,设置相关参数。
自定义模板上限为 50,如果您需要更多的模板数量,请联系 ZEGO 技术支持。
测试环境下(详见 IsTest 公共参数说明),流 ID 需要加上 “zegotest-AppId-” 前缀。例如,流 ID 为 “test”,在 AppId 为 “123456789” 的测试环境下,流 ID 应为 “zegotest-123456789-test”。
-------------------------------------------(RightUpX, RightUpZ)
| |
| |
| |
| |
(LeftBottomX, LeftBottomZ)-------------------------------------
模板配置更改后,正在使用该模板的场景不会立刻生效,需等待场景销毁后(场景中全部用户退出 10 分钟后,该场景会被自动销毁),重新创建才可生效。
Request
Query Parameters
可选值: [SetSceneTemplate
]
接口原型参数
https://metaworld-api.zego.im/?Action=SetSceneTemplate
💡公共参数。随机字符串。
💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
可选值: [2.0
]
默认值: 2.0
💡公共参数。签名版本号。
可选值: [false
, true
]
默认值: false
💡公共参数。是否为测试环境。设为 true 表示使用测试环境。 2021-11-16 及之前在 ZEGO 控制台 创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。
⚠️注意:测试环境跟正式环境是隔离的,请不要在操作正式环境 appid 时误把该参数标记为 true。2021-11-16 及之后创建的项目建议不要填写该参数。
📌是否必填参数:2021-11-16 及之前在 ZEGO 控制台创建的项目为必填,之后创建的则不是必填。
应用 AppID。
模板 ID。
地图左下角横坐标(见上图)。
地图左下角纵坐标(见上图)。
地图右上角横坐标(见上图)。
地图右上角纵坐标(见上图)。
场景人数上限。
AOI 半径(用户视野半径)。
AOI 人数上限
本端用户的AOI范围内,可视远端用户数的上限,人数上限最多 100。
Responses
- 200
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL