https://shunt-api.netless.link/v5/rooms/:uuid/scenes
Key |
Required or not |
Type |
Remarks |
token |
required |
string |
SDK Token or Room Token (read-only permission) |
Key |
Required or not |
Type |
Remarks |
uuid |
required |
string |
UUID of the room |
Key |
Required or not |
Type |
Remarks |
sceneDir |
optional |
string |
The list of scenes in which scene group to return (all scenes will be returned if not filled) |
Create screenshot successfully
[
"/init",
"/6f026653989b4439b32a6899e7d32fed",
"/b3a423f8caaa4ff688c0e395431776a5"
]
https://shunt-api.netless.link/v5/rooms/:uuid/scenes
The server-side API has the same restrictions on the scene API as the client-side.
- The path parameter cannot overlap with the path of the existing page. (Analog and: Cannot insert files into files)
- path + the name in the inserted scenes. When the spliced path is consistent with the existing page path, the new page will overwrite the old page (the new file will overwrite the old file) due to the uniqueness of the path.
For details, see Page (Scene) Management-Insert Page
Key |
Required or not |
Type |
Remarks |
token |
required |
string |
SDK Token or Room Token (with write permission and above) |
Key |
Required or not |
Type |
Remarks |
uuid |
required |
string |
UUID of the room |
¶ Body Parameters
Key |
Required or not |
Type |
Remarks |
scenes |
required |
array |
An array composed of Scenes, indicating the data structure of the scene to be inserted. |
path |
required |
string |
The new scene should be inserted into the scene group |
{}
type Scene = {
name: string;
ppt?: {
src: string;
width: number;
height: number;
};
};
https://shunt-api.netless.link/v5/rooms/:uuid/scene-state
The following conditions cannot be switched correctly:
- The page corresponding to the path does not exist.
- The path corresponds to the page directory, not the page.
For details, see Page (Scene) Management
Key |
Required or not |
Type |
Remarks |
token |
required |
string |
SDK Token or Room Token (can write above permissions) |
Key |
Required or not |
Type |
Remarks |
uuid |
required |
string |
UUID of the room |
¶ Body Parameters
Key |
Required or not |
Type |
Remarks |
scenePath |
required |
string |
Scene address to change to |
The creation is successful, and the room description object is returned.
{
"currentScenePath": [
"/init"
]
}