-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhelp.html
More file actions
190 lines (169 loc) · 5.49 KB
/
help.html
File metadata and controls
190 lines (169 loc) · 5.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<html>
<style type="text/css">
.tg {border-collapse:collapse;border-color:#9ABAD9;border-spacing:0;}
.tg td{background-color:#EBF5FF;border-color:#9ABAD9;border-style:solid;border-width:1px;color:#444;
font-family:Arial, sans-serif;font-size:14px;overflow:hidden;padding:10px 5px;word-break:normal;}
.tg th{background-color:#409cff;border-color:#9ABAD9;border-style:solid;border-width:1px;color:#fff;
font-family:Arial, sans-serif;font-size:14px;font-weight:normal;overflow:hidden;padding:10px 5px;word-break:normal;}
.tg .tg-hmp3{background-color:#D2E4FC;text-align:left;vertical-align:top}
.tg .tg-q7lj{background-color:#34696d;font-size:large;font-weight:bold;text-align:left;vertical-align:top}
.tg .tg-0lax{text-align:left;vertical-align:top}
.whiteText {color:white}
</style>
<body class="whiteText">
<h1>Help</h1>
<h2>API Calls</h2>
There are many system functions which can be triggered via an http request. Lights, Cameras, Propresenter and Video switcher can be controlled this way.
<h3>Camera Cues</h3>
The general form of the camera cue url is:
<pre>
http://<hostname>:<port>/cq?cmd=___&parm=____&num=___
</pre>
<table class="tg">
<thead>
<tr>
<th class="tg-q7lj">cmd</th>
<th class="tg-q7lj">parm</th>
<th class="tg-q7lj">num</th>
<th class="tg-q7lj">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tg-0lax">power</td>
<td class="tg-0lax">on|off</td>
<td class="tg-0lax">camera #</td>
<td class="tg-0lax">http://127.0.0.1/cq?cmd=power&parm=on&num=1</td>
</tr>
<tr>
<td class="tg-0lax">tally</td>
<td class="tg-0lax">on|off</td>
<td class="tg-0lax">camera #</td>
<td class="tg-0lax">http://127.0.0.1/cq?cmd=tally&parm=on&num=1</td>
</tr>
<tr>
<td class="tg-0lax">move</td>
<td class="tg-0lax">left|right|up|down|in|out|stop|zoomstop</td>
<td class="tg-0lax">camera #</td>
<td class="tg-0lax">http://127.0.0.1/cq?cmd=move&parm=left&num=1</td>
</tr>
</tbody>
</table>
<h3>Light Cues</h3>
The general form of the light cue url is:
<pre>
http://<hostname>:<port>/lq?cmd=___&parm=____
</pre>
<table class="tg">
<thead>
<tr>
<th class="tg-q7lj">cmd</th>
<th class="tg-q7lj">parm</th>
<th class="tg-q7lj">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tg-0lax">gotocue</td>
<td class="tg-0lax">xxx.y</td>
<td class="tg-0lax">http://127.0.0.1:1880:/lq?cmd=gotocue&parm=123.4</td>
</tr>
<tr>
<td class="tg-0lax">pause</td>
<td class="tg-0lax"></td>
<td class="tg-0lax"></td>
</tr>
<tr>
<td class="tg-0lax">go</td>
<td class="tg-0lax"></td>
<td class="tg-0lax"></td>
</tr>
<tr>
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">goback</span></td>
<td class="tg-0lax"></td>
<td class="tg-0lax"></td>
</tr>
</tbody>
</table>
<h3>Video Cues</h3>
The general form of the video cue url to control an ATEM is:
<pre>
http://<hostname>:<port>/vq?cmd=___&parm=____
</pre>
<table class="tg">
<thead>
<tr>
<th class="tg-q7lj">cmd</th>
<th class="tg-q7lj">parm</th>
<th class="tg-q7lj">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tg-0lax">programinput<br></td>
<td class="tg-0lax"></td>
<td class="tg-0lax">http://127.0.0.1:1880:/vq?cmd=programinput&parm=?</td>
</tr>
<tr>
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">previewinput</span></td>
<td class="tg-0lax"></td>
<td class="tg-0lax"></td>
</tr>
<tr>
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">auxsource</span></td>
<td class="tg-0lax"></td>
<td class="tg-0lax"></td>
</tr>
<tr>
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">performcut</span></td>
<td class="tg-0lax"></td>
<td class="tg-0lax"></td>
</tr>
<tr>
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">performauto</span></td>
<td class="tg-0lax"></td>
<td class="tg-0lax"></td>
</tr>
<tr>
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">upstreamkeyer</span></td>
<td class="tg-0lax"></td>
<td class="tg-0lax"></td>
</tr>
<tr>
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">macroaction</span></td>
<td class="tg-0lax"></td>
<td class="tg-0lax"></td>
</tr>
</tbody>
</table>
<h3>ProPresnter Cues</h3>
Only Propresenter 7 is supported. The general form of the ProPresenter cue url is:
<pre>
http://<hostname>:<port>/pq?cmd=___&parm=____&num=____
</pre>
<table class="tg">
<thead>
<tr>
<th class="tg-q7lj">cmd</th>
<th class="tg-q7lj">parm</th>
<th class="tg-q7lj">num</th>
<th class="tg-q7lj">Example</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tg-0lax">clearlayer</td>
<td class="tg-0lax">slide</td>
<td class="tg-0lax">number</td>
<td class="tg-0lax">http://127.0.0.1:1880:/pq?cmd=clearlayer&parm=slide&num=3<br/>This will clear the slide layer in 3 seconds.</td>
</tr>
<tr>
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">propclear</span></td>
<td class="tg-0lax">name of prop</td>
<td class="tg-0lax">not applicable</td>
<td class="tg-0lax">http://127.0.0.1:1880:/pq?cmd=propclear&parm=name of prop<br/>This will clear the prop with name "name of prop".</td>
</tr>
</tbody>
</table>
</body>
</html>