ABCDEFGHIJKLMNOPQRST
1
function callfrom versiondescriptionparametersreturnnotessample call
2
These API commands can be called by various methods: HTTP, OSC, RPC.
Please read the guide for an overview
3
API Manual
4
5
Player Editorthese commands are mainly for external clients, apps and alternative editors
6
setPlayModeChanges the play mode for th player windows:"live"|"edit"|"xray"
7
setEditingModeChanges the current editing function in the player windows:"move"|"warp"
8
9
Global functions
10
setGlobalOpacitySets the overall live set opacity for all surfacesf:opacity
11
setGlobalVolumeSets the overall volume levelf:volume
12
muteAudioMutes/unmutes all audiob:mute
13
getRuntimeInfoLiteReturns runtime information structureRuntimeInfoLite structure
14
15
Set functions
16
playSetIndexPlays a specific Set by Index (starting from 0) and Cue. Cue -2 is the black cue.i:index,i:cue
17
controlCurrentSetControls the play state of the current Sets:play_modeplay_mode can be "Play",Pause","RewindPlay","RewindPause"
18
19
Cue functions
20
playCuePlays the indexed Cue, obeys fade in-out from cue propertiesi:index
21
playCueRelativePlays the Cue relatively positioned to the current one. Example +1 means the next, -1 the previous.i:relative_position
22
rewindCurrentCueRewinds the Cue
23
getCurrentCueListReturns the list of Cues in the current Setlist of ResourceCue entities
24
setCueFadeSets the Cue fading in/out and crossfade flagi:set_index,i:cue_index,f:fade_in,
f:fade_out,b:crossfade		The special index -1 for set and cue refers the currently playing ones.
25
setCueResourceAssigns a Resource to a Surface, in a specific Set and Cue.
Play mode will be applied only if setting in the current Set and Cue		i:set_index,i:cue_index,i:surface_index,s:resource_name_or_id,s:play_modeThe special index -1 for set and cue refers the currently playing ones.
play_mode can be "Play",Pause","RewindPlay","RewindPause"
26
setCueResourceRegionSets the Resource Region to a Surface, in a specific Set and Cuei:set_index,i:cue_index,i:surface_index,i:region_indexThe special index -1 for set and cue refers the currently playing ones.
27
setCueResourceLoopSets the Resource loop state to a Surface, in a specific Set and Cuei:set_index,i:cue_index,i:surface_index,b:resource_loopThe special index -1 for set and cue refers the currently playing ones.
28
getCueResource1.9.16Returns the resource of requested set, cue and surface indexi:set_index, i:cue_index, i:surface_indexFacadeResource entityThe special index -1 for set and cue refers the currently playing ones.
29
30
Surface functionsthese commands will affet a Surface in the requested Set (-1 for current set) or in the current Set/Cue
31
setSurfaceOpacityChanges the opacity of a surface (range: 0.0 - 1.0)i:set_index,i:surface_index,f:opacityset_index can be -1 for the current set
32
resetSurfaceResourceClears a Surface from assigned resource, in the current Set and Cuei:surface_index
33
setSurfaceResourceAssigns a Resource to a Surface, in the current Set and Cuei:surface_index,s:resource_name_or_id,
s:play_mode		play_mode can be "Play",Pause","RewindPlay","RewindPause"
34
controlSurfaceResourceControls the play state of a Resource assigned to a Surface, in the current Set and Cues:surface_index,s:play_modeplay_mode can be "Play",Pause","RewindPlay","RewindPause"
35
setSurfaceFlatVerticesModifies a Surface vertices setting its mode to Flat warp (4 vertices)i:set_index,i:surface_index,
i:vertex1_x,i:vertex1_y,
i:vertex2_x,i:vertex2_y,
i:vertex3_x,i:vertex3_y,
i:vertex4_x,i:vertex4_y		set_index can be -1 for the current set
If the surface warp mode is different from Flat it will be set as it
36
moveSurface1.9.13Moves a Surface by dx/dy pixels, or sets the absolute position if absolute parameter is true (defaults to false)i:set_index, i:surface_index, f:dx, f:dy, b:absolute=falseset_index can be -1 for the current set.
absolute parameter defaults to false.
37
moveSurfacePoint1.9.13Moves a Surface control point (dependent on warping type) byt a relative amounti:set_index, i:surface_index, i:point_index, f:dx, f:dyset_index can be -1 for the current sethttp://localhost:15000/api/moveSurfacePoint/1/1/1/10/10
38
selectSurfacePoint1.9.13Selects in edit a Surface control pointi:set_index, i:surface_index, i:point_indexset_index can be -1 for the current set
39
selectSurface1.9.13Selects in edit a Surface. If specified will enter edit mode and also snap the mouse on the selected surface.i:set_index, i:surface_index, i:point_index, b:enter_edit=false, b:snap_mouse=falseset_index can be -1 for the current set
40
getSurfaces1.9.13Returns all the surfaces of the requested Seti:set_indexlist of FacadeSurface entitiesset_index can be -1 for the current set
41
setSurfaceSolo1.9.13Makes the requested Surface in "solo" visualization mode, or restores visibility of all surfaces if set on a surface that is already soloedi:surface_index
42
setSurfaceColor2022.1.0Sets the color rgb 0-255i:set_index,i:surface_index,i:alpha,i:red:i:green,i:blueset_index can be -1 for the current set
43
setSurfaceColorChannel2022.1.0Sets the color of a channel (0:alpha, 1:red, 2:green, 3:blue) 0-255i:set_index,i:surface_index,i:channel,i:color_valueset_index can be -1 for the current set
44
setSurfaceTextureScale2022.1.0Sets the surface texture scale (ovverides Cue if not 1)i:set_index,i:surface_index,f:scaleset_index can be -1 for the current set
45
setSurfaceTextureRotation2022.1.0Sets the surface texture rotation (ovverides Cue if not 0)i:set_index,i:surface_index,f:rotationset_index can be -1 for the current set
46
47
Resource functionsthese will affect Resources playing (and already assigned to a Surface)the resource_name is the one given in the Media Resources panel
48
resourceAdvanceIssues an advance command to a resource (ex: playlist next item).
Works only if resource is currently playing and resource type supports it (playlists).		s:resource_name_or_id
49
resourceControlControls the resource according to the play_modes:resource_name_or_id, s:play_modeplay_mode can be "Play",Pause","RewindPlay","RewindPause"
50
resourceIsEndedReturns true if the resource has ended. NOTE: if the resource is set to loop it will NEVER end.s:resource_name_or_idb:resource_ended
51
resourceChangeMediaFile1.9.16Changes a resource media file with the provided media file path. If path is relative it refers to the project /media subfolder.
After a media is changed a rewind of the current cue is needed to apply the transition parameters (default to true)		s:resource_name_or_id, s:file_name, b:rewind_current_cue=true
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75