File: interfacewebcam_1_1Channel.html

package info (click to toggle)
raritan-json-rpc-sdk 4.0.20%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 57,236 kB
  • sloc: cs: 223,121; perl: 117,786; python: 26,872; javascript: 6,544; makefile: 27
file content (272 lines) | stat: -rw-r--r-- 15,355 bytes parent folder | download
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan / Server Technology Xerus™ PDU JSON-RPC API: webcam::Channel Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Raritan / Server Technology Xerus™ PDU JSON-RPC API
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacewebcam.html">webcam</a></li><li class="navelem"><a class="el" href="interfacewebcam_1_1Channel.html">Channel</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="interfacewebcam_1_1Channel-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">webcam::Channel Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The channel interface.  
 <a href="interfacewebcam_1_1Channel.html#details">More...</a></p>

<p><code>import&quot;<a class="el" href="WebcamChannel_8idl_source.html">WebcamChannel.idl</a>&quot;;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1061e3b3c475318616462aaf96d9428e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacewebcam_1_1Channel.html#a1061e3b3c475318616462aaf96d9428e">getClientType</a> ()</td></tr>
<tr class="memdesc:a1061e3b3c475318616462aaf96d9428e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the channel type.  <a href="interfacewebcam_1_1Channel.html#a1061e3b3c475318616462aaf96d9428e">More...</a><br /></td></tr>
<tr class="separator:a1061e3b3c475318616462aaf96d9428e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4119c1f217ef8ace71f7050599ac0b99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfacewebcam_1_1Webcam.html">Webcam</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacewebcam_1_1Channel.html#a4119c1f217ef8ace71f7050599ac0b99">getWebcam</a> ()</td></tr>
<tr class="memdesc:a4119c1f217ef8ace71f7050599ac0b99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the webcam.  <a href="interfacewebcam_1_1Channel.html#a4119c1f217ef8ace71f7050599ac0b99">More...</a><br /></td></tr>
<tr class="separator:a4119c1f217ef8ace71f7050599ac0b99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af029b38d10b6ab7679f73bd8578c3685"><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacewebcam_1_1Channel.html#af029b38d10b6ab7679f73bd8578c3685">isAvailable</a> ()</td></tr>
<tr class="memdesc:af029b38d10b6ab7679f73bd8578c3685"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine whether the channel is available.  <a href="interfacewebcam_1_1Channel.html#af029b38d10b6ab7679f73bd8578c3685">More...</a><br /></td></tr>
<tr class="separator:af029b38d10b6ab7679f73bd8578c3685"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b4f203ee13e373b1a107b0667537a49"><td class="memItemLeft" align="right" valign="top"><a id="a5b4f203ee13e373b1a107b0667537a49"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacewebcam_1_1Channel.html#a5b4f203ee13e373b1a107b0667537a49">release</a> ()</td></tr>
<tr class="memdesc:a5b4f203ee13e373b1a107b0667537a49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the channel to allow lower proritized clients to view an image otherwise the channel expires when it is unused (neither a image related method nor "isAvailable" is called) for 20 seconds. <br /></td></tr>
<tr class="separator:a5b4f203ee13e373b1a107b0667537a49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05d8d08dd67c1f5c4b150cd7335728a9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacewebcam_1_1Channel.html#a05d8d08dd67c1f5c4b150cd7335728a9">captureImage</a> (out <a class="el" href="structwebcam_1_1Image.html">Image</a> image)</td></tr>
<tr class="memdesc:a05d8d08dd67c1f5c4b150cd7335728a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a image.  <a href="interfacewebcam_1_1Channel.html#a05d8d08dd67c1f5c4b150cd7335728a9">More...</a><br /></td></tr>
<tr class="separator:a05d8d08dd67c1f5c4b150cd7335728a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a213cc767e7f0adc6c77a330a124da5ff"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacewebcam_1_1Channel.html#a213cc767e7f0adc6c77a330a124da5ff">triggerCapture</a> (out string captureToken)</td></tr>
<tr class="memdesc:a213cc767e7f0adc6c77a330a124da5ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Triggers the capture process to the temporary folder and returns a capture token to view them.  <a href="interfacewebcam_1_1Channel.html#a213cc767e7f0adc6c77a330a124da5ff">More...</a><br /></td></tr>
<tr class="separator:a213cc767e7f0adc6c77a330a124da5ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab4acc9c5dfa6373fcc59399ebd539041"><td class="memItemLeft" align="right" valign="top">constant int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacewebcam_1_1Channel.html#ab4acc9c5dfa6373fcc59399ebd539041">NO_ERROR</a> = 0</td></tr>
<tr class="memdesc:ab4acc9c5dfa6373fcc59399ebd539041"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error codes.  <a href="interfacewebcam_1_1Channel.html#ab4acc9c5dfa6373fcc59399ebd539041">More...</a><br /></td></tr>
<tr class="separator:ab4acc9c5dfa6373fcc59399ebd539041"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a711f4b636bc7ee34e1d18706392d5619"><td class="memItemLeft" align="right" valign="top"><a id="a711f4b636bc7ee34e1d18706392d5619"></a>
constant int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacewebcam_1_1Channel.html#a711f4b636bc7ee34e1d18706392d5619">ERR_NOT_AVAILABLE</a> = 2</td></tr>
<tr class="memdesc:a711f4b636bc7ee34e1d18706392d5619"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="interfacewebcam_1_1Channel.html" title="The channel interface.">Channel</a> is not available. <br /></td></tr>
<tr class="separator:a711f4b636bc7ee34e1d18706392d5619"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc02a9df2d96f2cab2f476f02dd5f2e5"><td class="memItemLeft" align="right" valign="top"><a id="afc02a9df2d96f2cab2f476f02dd5f2e5"></a>
constant int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacewebcam_1_1Channel.html#afc02a9df2d96f2cab2f476f02dd5f2e5">ERR_NO_SUCH_OBJECT</a> = 3</td></tr>
<tr class="memdesc:afc02a9df2d96f2cab2f476f02dd5f2e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Requested object does not exist. <br /></td></tr>
<tr class="separator:afc02a9df2d96f2cab2f476f02dd5f2e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The channel interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a05d8d08dd67c1f5c4b150cd7335728a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05d8d08dd67c1f5c4b150cd7335728a9">&#9670;&nbsp;</a></span>captureImage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int webcam::Channel::captureImage </td>
          <td>(</td>
          <td class="paramtype">out <a class="el" href="structwebcam_1_1Image.html">Image</a>&#160;</td>
          <td class="paramname"><em>image</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve a image. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">image</td><td>Result: the image</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR on success </dd>
<dd>
ERR_NOT_AVAILABLE this channel is temporarily paused, because all view ports are currently used by higher prioritized events </dd>
<dd>
ERR_NO_SUCH_OBJECT the viewed webcam was detached </dd></dl>

</div>
</div>
<a id="a1061e3b3c475318616462aaf96d9428e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1061e3b3c475318616462aaf96d9428e">&#9670;&nbsp;</a></span>getClientType()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string webcam::Channel::getClientType </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve the channel type. </p>
<dl class="section return"><dt>Returns</dt><dd>the client type </dd></dl>

</div>
</div>
<a id="a4119c1f217ef8ace71f7050599ac0b99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4119c1f217ef8ace71f7050599ac0b99">&#9670;&nbsp;</a></span>getWebcam()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="interfacewebcam_1_1Webcam.html">Webcam</a> webcam::Channel::getWebcam </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieve the webcam. </p>
<dl class="section return"><dt>Returns</dt><dd>the webcam </dd></dl>

</div>
</div>
<a id="af029b38d10b6ab7679f73bd8578c3685"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af029b38d10b6ab7679f73bd8578c3685">&#9670;&nbsp;</a></span>isAvailable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">boolean webcam::Channel::isAvailable </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Determine whether the channel is available. </p>
<p>A channel may become unavailable when higher prioritized viewers are active.</p>
<dl class="section return"><dt>Returns</dt><dd>true if the channel is available, false otherwise </dd></dl>

</div>
</div>
<a id="a213cc767e7f0adc6c77a330a124da5ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a213cc767e7f0adc6c77a330a124da5ff">&#9670;&nbsp;</a></span>triggerCapture()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int webcam::Channel::triggerCapture </td>
          <td>(</td>
          <td class="paramtype">out string&#160;</td>
          <td class="paramname"><em>captureToken</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Triggers the capture process to the temporary folder and returns a capture token to view them. </p>
<p>The capture token is valid for 9 seconds and needs to be refreshed when, or even better before the old token expires.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">captureToken</td><td>Result: a new captureToken</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR on success </dd>
<dd>
ERR_NOT_AVAILABLE this channel is temporarily paused, because all view ports are currently used by higher prioritized events </dd>
<dd>
ERR_NO_SUCH_OBJECT the viewed webcam was detached </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab4acc9c5dfa6373fcc59399ebd539041"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4acc9c5dfa6373fcc59399ebd539041">&#9670;&nbsp;</a></span>NO_ERROR</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">constant int webcam::Channel::NO_ERROR = 0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Error codes. </p>
<p>Operation successful, no error </p>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="WebcamChannel_8idl_source.html">WebcamChannel.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2022 00:25:44 for Raritan / Server Technology Xerus™ PDU JSON-RPC API by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>