SetSceneTemplate
https://metaworld-api.zego.im/
This feature has been discontinued
Express supports custom scene template configuration for logging into scenes with corresponding configurations. When the system's pre-configured templates cannot meet your business needs, you can create custom templates and set related parameters through this server API.
The limit for custom templates is 50, if you need more templates, please contact ZEGOCLOUD Technical Support.
In the test environment (see the IsTest common parameter description), the stream ID needs to be prefixed with "zegotest-AppId-". For example, if the stream ID is "test" and the AppId is "123456789" in the test environment, the stream ID should be "zegotest-123456789-test".
-------------------------------------------(RightUpX, RightUpZ)
| |
| |
| |
| |
(LeftBottomX, LeftBottomZ)-------------------------------------After the template configuration is changed, scenes using this template will not take effect immediately. You need to wait for the scene to be destroyed (the scene will be automatically destroyed after all users exit for 10 minutes) and recreate it to take effect.
Request
Query Parameters
Possible values: [SetSceneTemplate]
Interface prototype parameters
https://metaworld-api.zego.im/?Action=SetSceneTemplate
💡Common parameter. A 16-character hexadecimal random string (hex-encoded 8-byte random number). For the generation algorithm, refer to the signature example.
💡Common parameter. Current Unix timestamp in seconds. For the generation algorithm, refer to the signature example. A maximum deviation of 10 minutes is allowed.
💡Common parameter. Signature used to verify the legitimacy of the request. Please refer to the signature mechanism to generate it.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
App AppID.
Template ID.
Lower-left corner X coordinate of the map (see the figure above).
Lower-left corner Z coordinate of the map (see the figure above).
Upper-right corner X coordinate of the map (see the figure above).
Upper-right corner Z coordinate of the map (see the figure above).
Maximum number of users in the scene.
AOI radius (user view radius).
AOI user limit
The upper limit of the number of remote users visible in the local user's AOI range, with a maximum limit of 100 users.
Responses
- 200
- application/json