CyberHub Platform

# Splicer Control System - API Call Instructions - V01

# 1. Page Initialization

  1. First, perform a GET request to the /v1/splicer/info interface to obtain page functionality permissions.
  2. At the same time, enable the websocket service to listen for synchronization push messages.
  3. Then, based on the data.echo_mode from the page functionality permissions interface, check the echo mode. If it is 1, poll GET /v1/splicer/echoscreen/mode1 to fetch the echoed screen images.
  4. Next, perform a GET request to /v1/splicer/wall/list to get the screen wall list data.
  5. Concurrently, perform a GET request to /v1/splicer/signal/list to get the signal source list, and then perform a GET request to /v1/splicer/signal/group to get signal groups.
  6. Then, based on the screen wall ID (defaulting to the first screen wall), perform a GET request to /v1/splicer/scene/list to obtain the scene list.
  7. Next, check the active_scene_id in the scene list. If it exists, proceed to the next step. If it does not exist, set active_scene_id to the ID of the first scene, then perform a GET request to /v1/splicer/scene/switch to switch to the first scene, and follow up with a GET request to /v1/splicer/logicslot/template to fetch the slot template.
  8. Finally, based on active_scene_id, perform a GET request to /v1/splicer/scene/window/list to fetch the window list.

# 2. Move Window and Change Window Size

  1. First, perform a GET request to /v1/splicer/scene/window/move.
  2. Then, perform a GET request to /v1/splicer/scene/save.

# 3. Add New Window

  1. First, perform a GET request to /v1/splicer/scene/window/open.
  2. Then, perform a GET request to /v1/splicer/scene/save.
  3. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 4. Replace Window

  1. First, call the /v1/splicer/scene/window/source interface.
  2. Then, call the /v1/splicer/scene/save interface.
  3. Finally, call the /v1/splicer/scene/window/list interface.

# 5. Window Ordering

  1. First, perform a GET request to /v1/splicer/scene/window/level.
  2. Then, perform a GET request to /v1/splicer/scene/save.
  3. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 6. Delete Window

  1. First, perform a GET request to /v1/splicer/scene/window/close.
  2. Then, perform a GET request to /v1/splicer/scene/save.
  3. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 7. Switch Screen Wall

  1. First, perform a GET request to /v1/splicer/scene/list.
  2. Then, perform a GET request to /v1/splicer/logicslot/template.
  3. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 8. Switch Scene

  1. First, perform a GET request to /v1/splicer/scene/switch.
  2. Then, perform a GET request to /v1/splicer/logicslot/template.
  3. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 9. Scene Sorting

  1. First, perform a GET request to /v1/splicer/scene/sort.
  2. Then, perform a GET request to /v1/splicer/scene/list.
  3. Then, perform a GET request to /v1/splicer/logicslot/template.
  4. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 10. Add Scene

  1. First, perform a POST request to /v1/splicer/scene/new.
  2. Then, perform a GET request to /v1/splicer/scene/list.
  3. Then, perform a GET request to /v1/splicer/logicslot/template.
  4. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 11. Delete Scene

  1. First, perform a DELETE request to /v1/splicer/scene.
  2. Then, perform a GET request to /v1/splicer/scene/list.
  3. Then, perform a GET request to /v1/splicer/logicslot/template.
  4. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 12. Rename Scene

  1. First, perform a POST request to /v1/splicer/scene/rename.
  2. Then, perform a GET request to /v1/splicer/scene/list.
  3. Then, perform a GET request to /v1/splicer/logicslot/template.
  4. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 13. Add or Remove Signal Source from Group

  1. First, perform a POST request to /v1/splicer/signal/group.
  2. Then, perform a GET request to /v1/splicer/signal/group.

# 14. Rename Signal Source

  1. First, perform a POST request to /v1/splicer/signal/rename.
  2. Then, perform a GET request to /v1/splicer/signal/list.
  3. Then, perform a GET request to /v1/splicer/signal/group.

# 15. Enable or Disable Virtual Slot

  1. First, perform a PUT request to /v1/splicer/logicslot/template.
  2. Then, perform a GET request to /v1/splicer/scene/list.
  3. Then, perform a GET request to /v1/splicer/logicslot/template.
  4. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 16. Clear All Windows

  1. First, perform a GET request to /v1/splicer/scene/window/close/all.
  2. Then, perform a GET request to /v1/splicer/scene/save.
  3. Finally, perform a GET request to /v1/splicer/scene/window/list.

# 17. Force Hardware Refresh

  1. First, perform a GET request to /v1/splicer/refresh/all.
  2. Then, redo step 1: Page Initialization.

←