# Universal Splicer Controller System - API Documentation - V01
# 1.1 User Login
URL:/v1/user/login
Request Method: POST
Function Description: User login
Parameters:
Key Name | Type | Parameter Description | Remarks |
---|---|---|---|
username | string | Login name | |
password | string | Password |
Return Value:
Key Name | Type | Parameter Description | Remarks |
---|---|---|---|
data | string | Returns token code | |
message | string | Returns message | Returns both success and error messages |
status | number | Returns status code | 0: Success |
# 1.2 User Logout
URL:/v1/user/logout
Request Method: GET
Function Description: User logout
Parameters:
Key Name | Type | Parameter Description | Remarks |
---|---|---|---|
token | string | token编码 |
Return Value:
Key Name | Type | Parameter Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Returns message | Returns both success and error messages |
status | number | Returns status code | 0: Success |
# 1.3 Change Password
URL:/v1/user/password/update
Request Method:POST
Function Description: Change password
Parameters:
Key Name | Type | Parameter Description | Remarks |
---|---|---|---|
token | string | Token code | |
new_password | string | New password | |
old_password | string | Old password | |
username | string | Username |
Return Value:
Key Name | Type | Parameter Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Returns message | Returns both success and error messages |
status | number | Returns status code | 0: Success |
# 2.1 Splicer Basic Information
URL:/v1/splicer/info
Request Method:GET
Function Description: Returns splicer information, including IP address, port, supported functions, etc.
Parameters:
Key Name | Type | Parameter Description | Remarks |
---|---|---|---|
token | string | Token code |
Return Value:
Key Name | Type | Parameter Description | Remarks |
---|---|---|---|
data | object | ||
message | string | Returns message | Returns both success and error messages |
status | number | Returns status code | 0: Success |
data:
Key Name | Type | Parameter Description | Remarks |
---|---|---|---|
brand | object Brand | ||
echo_mode | number | Echo mode | 0 No Echo, 1 Mode 1, 2 Mode 2 |
has_walls | boolean | Whether there is a screen wall list | Whether support fetching screen wall list |
ip | string | IP | Device IP |
port | number | Port | Device Port |
scene_delete | boolean | Whether scenes can be deleted | |
scene_new | boolean | Whether new scenes can be created | |
scene_switch | boolean | Whether scenes can be switched | |
signal_group | boolean | Whether the signal source has grouping | |
switch_wall | boolean | Whether the screen wall can be switched | |
version | string | Version | |
walls_setting | boolean | Whether screen wall settings can be modified | |
window_close | boolean | Whether windows can be deleted | |
window_open | boolean | Whether new windows can be created | |
window_signal_change | boolean | Whether the signal of the window can be switched | |
window_size_change | boolean | Whether the size of the window can be changed |
# 2.2 Get Splicer Mode 1 Echo Screen
URL:/v1/splicer/echoscreen/mode1
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | object | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
data:
Key Name | Type | Description | Remarks |
---|---|---|---|
list | object | ||
pic | string | Echo screen composite image | Base64, needs a prefix, e.g., data:image/png;base64,${pic} |
type | number | Image cutting method | 4: Cut image by interface coordinates |
list:
Key Name | Type | Description | Remarks |
---|---|---|---|
column | number | Column count | |
line | number | Row count | |
pos_info | array | Coordinates of the signal source corresponding to the echo screen |
pos_info[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
channel | number | Signal source ID | |
mode | number | Mode | |
pos | array | Coordinates of the signal source corresponding to the echo screen | Each window corresponds to the signal source |
pos_ex | array |
pos[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
pos_ex[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
# 2.3 Get Splicer Mode 2 Echo Screen
URL:/v1/splicer/echoscreen/mode2
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
signal_id | number | Screen wall ID |
Return Values:
【回显画面图的实际片地址】
# 2.4 Get Logic Slot Template
URL:/v1/splicer/logicslot/template
Request Method: GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | object | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
data:
Key Name | Type | Description | Remarks |
---|---|---|---|
id | string | Slot template ID | |
pos | array |
pos[0]
Key Name | Type | Description | Remarks |
---|---|---|---|
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
# 2.5 Update Logic Slot Template
URL:/v1/splicer/logicslot/template
Request Method: PUT
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
enable_logic_slot | boolean | Enable virtual slots | |
logic_slot_info | array | Slot list |
logic_slot_info[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
# 2.6 Save Logic Slot Template
URL:/v1/splicer/logicslot/template
Request Method:POST
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
pos | array | Slot list |
pos[0]
Key Name | Type | Description | Remarks |
---|---|---|---|
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
返回值:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
# 2.6 Delete Logic Slot Template
URL:/v1/splicer/logicslot/template
Request Method:POST
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
logic_template_id | string | Template ID |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
# 2.7 Get Mapping of Logical Port to Physical Port
URL:/v1/splicer/portmap
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | object | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
data:
Key Name | Type | Description | Remarks |
---|---|---|---|
output | array | ||
port_map | array |
port_map[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
port | array | Ports | |
wall_id | number | Screen wall ID |
port[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
logic_port | number | Logical port | |
phy_port | number | Physical port |
# 2.8 Bind Ports
URL:/v1/splicer/portmap
Request Method:POST
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
port | array | List of ports to bind | |
wall_id | number | "wall_id": 0 |
Port[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
logic_port | number | Logical port | |
phy_port | number | Physical port |
Return Values::
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
# 2.9 Clear Mapping of Logical Port to Physical Port
URL:/v1/splicer/portmap
Request Method: DELETE
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
# 2.10 Synchronize with Hardware
URL:/v1/splicer/refresh/all
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
# 2.11 Delete Scene
URL:/v1/splicer/scene
Request Method:DELETE
Function Description: Delete a scene under a specific screen wall.
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_id | number | Scene ID |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
# 2.12 Scene List
URL:/v1/splicer/scene/list
Request Method: GET
Function Description: Get all scenes under a specific screen wall.
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | object | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: success |
data:
Key Name | Type | Description | Remarks |
---|---|---|---|
active_scene_id | number | Current active scene | |
scenes | array | List of scenes |
scenes[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
enable | number | ||
enable_logic_slot | boolean | Whether to enable virtual slots | |
id | number | Scene ID | |
index | number | Scene index | |
logic_slot_info | array | Virtual slot list | |
main_voice_mode | number | Audio mode | |
name | string | Scene name | |
windows | array | List of windows in the scene (the windows array may be empty) |
logic_slot_info[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
windows[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
enable | boolean | Whether available (visible) | |
id | number | Window ID | |
is_mute | boolean | Whether muted | |
source_id | number | The ID of the signal source bound to the window | |
volume | number | Volume | |
win_blend_coef | number | ||
win_level | number | Level when arranging windows | |
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
# 2.13 Create Scene
URL:/v1/splicer/scene/new
Request Method:POST
Function Description: Create a new scene under a screen wall.
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
new_name | string | New scene name | |
wall_id | number | Screen wall ID |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.14 Rename Scene
URL:/v1/splicer/scene/rename
Request Method:POST
Function Description: Rename a scene.
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_id | number | Scene ID | |
new_name | string | New scene name |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.15 Save Scene
URL:/v1/splicer/scene/save
Request Method:GET
Function Description: Save the scene after it has changed.
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | ||
scene_id | number |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.16 Scene Sorting
URL:/v1/splicer/scene/sort
Request Method:POST
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_sort_info | array | Scene sorting information |
scene_sort_info[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
scene_id | number | Scene ID | |
sortindex | number | Scene sort order |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.17 Scene Switching
URL:/v1/splicer/scene/switch
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | ||
scene_id | number | Scene ID |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.18 Set Window Audio
URL:/v1/splicer/scene/window/audio
Request Method:PUT
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_id | number | Scene ID | |
window_info | object | Window information |
window_info:
Key Name | Type | Description | Remarks |
---|---|---|---|
enable | boolean | Whether available (visible) | |
id | number | Window ID | |
is_mute | boolean | Whether muted | |
source_id | number | ID of the signal source associated with the window | |
volume | number | Volume | |
win_blend_coef | number | ||
win_level | number | Level when arranging windows | |
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.19 Close Window
URL:/v1/splicer/scene/window/close
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_id | number | Scene ID | |
win_id | number | Window ID |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.20 Change Window Level
URL:/v1/splicer/scene/window/level
Request Method: GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_id | number | Scene ID | |
win_id | number | Window ID | |
source | number | Signal source ID | |
level | number | Window level | -1 for top, 0 for bottom, 1-n for level, where a higher n means a higher level |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.21 Get the List of Scene Windows Under the Screen Wall
URL:/v1/splicer/scene/window/list
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_id | number | Scene ID | |
win_id | number | Window ID |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | object | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
data:
Key Name | Type | Description | Remarks |
---|---|---|---|
enable | boolean | Whether the window is visible | |
id | number | Window ID | |
is_mute | boolean | Whether muted | |
source_id | number | Signal source ID | |
volume | number | Volume | |
win_blend_coef | number | ||
win_level | number | Window level | |
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
# 2.22 Move Window
URL:/v1/splicer/scene/window/move
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_id | number | Scene ID | |
win_id | number | Window ID | |
source | number | Signal source ID | |
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.23 Create Window
URL:/v1/splicer/scene/window/open
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_id | number | Scene ID | |
win_id | number | Window ID | |
source | number | Signal source ID | |
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.24 Switch Window Signal Source
URL:/v1/splicer/scene/window/source
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID | |
scene_id | number | Scene ID | |
win_id | number | Window ID | |
source | number | Signal source ID | |
x0 | number | Top-left x-coordinate | |
x1 | number | Bottom-right x-coordinate | |
y0 | number | Top-left y-coordinate | |
y1 | number | Bottom-right y-coordinate |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.25 Signal List
URL:/v1/splicer/signal/list
Request Method:GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | object | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
data:
Key Name | Type | Description | Remarks |
---|---|---|---|
signals | array | Signal source list |
signals[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
HZ | number | Refresh rate | |
channel | number | ||
connect_channel | number | ||
enable | boolean | Whether visible | |
ext | string | ||
height | number | Height | |
id | string | Signal source ID | |
ip | string | IP address | |
name | string | Signal source name | |
type | number | ||
width | number | Width |
# 2.26 Rename Signal Source
URL:/v1/splicer/signal/rename
Request Method:POST
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
new_name | string | New signal source name | |
source | object | Signal source |
source:
Key Name | Type | Description | Remarks |
---|---|---|---|
HZ | number | Refresh rate | |
channel | number | ||
connect_channel | number | ||
enable | boolean | Visibility | |
ext | string | ||
height | number | Height | |
id | string | Signal source ID | |
ip | string | IP address | |
name | string | Signal source name | |
type | number | ||
width | number | Width |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.27 Edit Screen Wall
URL:/v1/splicer/wall
Request Method:POST
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
comb_column | number | Vertical count | |
comb_line | number | Horizontal count | |
height | number | Height | |
width | number | Width | |
enable | boolean | Usability | |
led_mode | number | LED mode | |
mode | number | Mode | |
name | string | Name | |
hz | number | Refresh rate | |
screen_info | object | LED settings | |
vmode_hnum | number | Virtual slot horizontal division | |
vmode_vnum | number | Virtual slot vertical division | |
wall_id | string | Screen wall ID | |
sub_column | number | ||
sub_line | number | ||
dis_hsize | number | Width of resolution | |
dis_vsize | number | Height of resolution |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.28 Delete Screen Wall
URL:/v1/splicer/wall
Request Method:DELETE
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
comb_column | number | Vertical count | |
comb_line | number | Horizontal count | |
height | number | Height | |
width | number | Width | |
enable | boolean | Usability | |
led_mode | number | LED mode | |
mode | number | Mode | |
name | string | Name | |
hz | number | Refresh rate | |
screen_info | object | LED settings | |
vmode_hnum | number | Virtual slot horizontal division | |
vmode_vnum | number | Virtual slot vertical division | |
wall_id | number | Screen wall ID | |
sub_column | number | ||
sub_line | number | ||
dis_hsize | number | Width of resolution | |
dis_vsize | number | Height of resolution |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | string | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
# 2.29 Screen Wall List
URL:/v1/splicer/wall/list
Request Method: GET
Function Description:
Parameters:
Key Name | Type | Description | Remarks |
---|---|---|---|
token | string | Token encoding | |
wall_id | number | Screen wall ID |
Return Values:
Key Name | Type | Description | Remarks |
---|---|---|---|
data | object | ||
message | string | Return message | Returned for both success and error |
status | number | Return status code | 0: Success |
data:
Key Name | Type | Description | Remarks |
---|---|---|---|
active_wall_id | number | Current active screen wall | |
walls | array | List of screen walls |
Walls[0]:
Key Name | Type | Description | Remarks |
---|---|---|---|
comb_column | number | Columns | |
comb_line | number | Rows | |
dis_hsize | number | ||
dis_vsize | number | ||
enable | boolean | Visibility | |
height | number | Height | |
hz | number | Screen refresh rate | |
led_mode | boolean | LED mode | |
mode | number | Mode | |
name | string | Screen name | |
screen_info | object | Screen information | |
sub_column | number | ||
sub_line | number | ||
vmode_hnum | number | ||
vmode_vnum | number | ||
wall_id | number | Screen ID | |
width | number | Width |
screen_info:
Key Name | Type | Description | Remarks |
---|---|---|---|
screen_height | number | Screen Width | |
screen_width | number | Screen Height | |
x_offset | number | X Offset | |
y_offset | number | Y Offset |