/usr/share/doc/openni2-doc/java/org/openni/VideoFrameRef.html is in openni2-doc 2.2.0.33+dfsg-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>VideoFrameRef</title>
<meta name="date" content="2016-01-23">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="VideoFrameRef";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../org/openni/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/openni/Version.html" title="class in org.openni"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/openni/VideoMode.html" title="class in org.openni"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/openni/VideoFrameRef.html" target="_top">Frames</a></li>
<li><a href="VideoFrameRef.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.openni</div>
<h2 title="Class VideoFrameRef" class="title">Class VideoFrameRef</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.openni.VideoFrameRef</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">VideoFrameRef</span>
extends java.lang.Object</pre>
<div class="block">The <a href="../../org/openni/VideoFrameRef.html" title="class in org.openni"><code>VideoFrameRef</code></a> class encapsulates a single video frame - the output of a
<a href="../../org/openni/VideoStream.html" title="class in org.openni"><code>VideoStream</code></a> at a specific time. The data contained will be a single frame of color, IR,
or depth video, along with associated meta data.
An object of type <a href="../../org/openni/VideoFrameRef.html" title="class in org.openni"><code>VideoFrameRef</code></a> does not actually hold the data of the frame, but only a
reference to it. OpenNI uses a ref-count to decide when the data buffer can be freed.
Once the frame is no longer needed, it can be released by calling the <a href="../../org/openni/VideoFrameRef.html#release()"><code>release()</code></a> method.
Although the finalization process of the garbage collector also releases the reference,
it is preferable to manually release it by calling this method rather than to
rely on a finalization process which may not run to completion for a long period of time.
The usual way to obtain <a href="../../org/openni/VideoFrameRef.html" title="class in org.openni"><code>VideoFrameRef</code></a> objects is by a call to
<a href="../../org/openni/VideoStream.html#readFrame()"><code>VideoStream.readFrame()</code></a>. Please note that the returned frame
holds native memory. Although the finalization process of the garbage collector
also disposes of the same system resources, it is preferable to manually free
the associated resources by calling this method rather than to rely on a finalization
process which may not run to completion for a long period of time.
All data references by a <a href="../../org/openni/VideoFrameRef.html" title="class in org.openni"><code>VideoFrameRef</code></a> is stored as a primitive array of pixels. Each
pixel will be of a type according to the configured pixel format (see <a href="../../org/openni/VideoMode.html" title="class in org.openni"><code>VideoMode</code></a>).</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#finalize()">finalize</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getCropOriginX()">getCropOriginX</a></strong>()</code>
<div class="block">Indicates the X coordinate of the upper left corner of the crop window.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getCropOriginY()">getCropOriginY</a></strong>()</code>
<div class="block">Indicates the Y coordinate of the upper left corner of the crop window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getCroppingEnabled()">getCroppingEnabled</a></strong>()</code>
<div class="block">Indicates whether cropping was enabled when the frame was produced.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.nio.ByteBuffer</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getData()">getData</a></strong>()</code>
<div class="block">Getter function for the array of data pointed to by this object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getFrameIndex()">getFrameIndex</a></strong>()</code>
<div class="block">Frames are provided sequential frame ID numbers by the sensor that produced them.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getHeight()">getHeight</a></strong>()</code>
<div class="block">Gives the current height of this frame, measured in pixels.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../org/openni/SensorType.html" title="enum in org.openni">SensorType</a></code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getSensorType()">getSensorType</a></strong>()</code>
<div class="block">Getter function for the sensor type used to produce this frame.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getStrideInBytes()">getStrideInBytes</a></strong>()</code>
<div class="block">Gives the length of one row of pixels, measured in bytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getTimestamp()">getTimestamp</a></strong>()</code>
<div class="block">Provides a timestamp for the frame.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../org/openni/VideoMode.html" title="class in org.openni">VideoMode</a></code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getVideoMode()">getVideoMode</a></strong>()</code>
<div class="block">Returns a reference to the <a href="../../org/openni/VideoMode.html" title="class in org.openni"><code>VideoMode</code></a> object assigned to this frame.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#getWidth()">getWidth</a></strong>()</code>
<div class="block">Gives the current width of this frame, measured in pixels.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../org/openni/VideoFrameRef.html#release()">release</a></strong>()</code>
<div class="block">Release the reference to the frame.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getData</h4>
<pre>public final java.nio.ByteBuffer getData()</pre>
<div class="block">Getter function for the array of data pointed to by this object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>ByteBuffer object to the actual frame data array. Type of data can be determined
according to the pixel format (can be obtained by calling <a href="../../org/openni/VideoFrameRef.html#getVideoMode()"><code>getVideoMode()</code></a>).</dd></dl>
</li>
</ul>
<a name="getSensorType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSensorType</h4>
<pre>public <a href="../../org/openni/SensorType.html" title="enum in org.openni">SensorType</a> getSensorType()</pre>
<div class="block">Getter function for the sensor type used to produce this frame. Used to determine whether this
is an IR, Color or Depth frame. See the <a href="../../org/openni/SensorType.html" title="enum in org.openni"><code>SensorType</code></a> enumeration for all possible return
values from this function.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The type of sensor used to produce this frame.</dd></dl>
</li>
</ul>
<a name="getVideoMode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVideoMode</h4>
<pre>public final <a href="../../org/openni/VideoMode.html" title="class in org.openni">VideoMode</a> getVideoMode()</pre>
<div class="block">Returns a reference to the <a href="../../org/openni/VideoMode.html" title="class in org.openni"><code>VideoMode</code></a> object assigned to this frame. This object
describes the video mode the sensor was configured to when the frame was produced and can be
used to determine the pixel format and resolution of the data. It will also provide the frame
rate that the sensor was running at when it recorded this frame.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Reference to the <a href="../../org/openni/VideoMode.html" title="class in org.openni"><code>VideoMode</code></a> assigned to this frame.</dd></dl>
</li>
</ul>
<a name="getTimestamp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimestamp</h4>
<pre>public long getTimestamp()</pre>
<div class="block">Provides a timestamp for the frame. The 'zero' point for this stamp is implementation specific,
but all streams from the same device are guaranteed to use the same zero. This value can
therefore be used to compute time deltas between frames from the same device, regardless of
whether they are from the same stream.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Timestamp of frame, measured in microseconds from an arbitrary zero</dd></dl>
</li>
</ul>
<a name="getFrameIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameIndex</h4>
<pre>public int getFrameIndex()</pre>
<div class="block">Frames are provided sequential frame ID numbers by the sensor that produced them. If frame
synchronization has been enabled for a device via
<a href="../../org/openni/Device.html#setDepthColorSyncEnabled(boolean)"><code>Device.setDepthColorSyncEnabled(boolean)</code></a>, then frame numbers for
corresponding frames of depth and color are guaranteed to match.
If frame synchronization is not enabled, then there is no guarantee of matching frame indexes
between <a href="../../org/openni/VideoStream.html" title="class in org.openni"><code>VideoStream</code></a> "VideoStreams". In the latter case, applications should use
timestamps instead of frame indexes to align frames in time.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Index number for this frame.</dd></dl>
</li>
</ul>
<a name="getWidth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWidth</h4>
<pre>public int getWidth()</pre>
<div class="block">Gives the current width of this frame, measured in pixels. If cropping is enabled, this will be
the width of the cropping window. If cropping is not enabled, then this will simply be equal to
the X resolution of the <a href="../../org/openni/VideoMode.html" title="class in org.openni"><code>VideoMode</code></a> used to produce this frame.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Width of this frame in pixels.</dd></dl>
</li>
</ul>
<a name="getHeight()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeight</h4>
<pre>public int getHeight()</pre>
<div class="block">Gives the current height of this frame, measured in pixels. If cropping is enabled, this will
be the length of the cropping window. If cropping is not enabled, then this will simply be
equal to the Y resolution of the <a href="../../org/openni/VideoMode.html" title="class in org.openni"><code>VideoMode</code></a> used to produce this frame.</div>
</li>
</ul>
<a name="getCroppingEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCroppingEnabled</h4>
<pre>public boolean getCroppingEnabled()</pre>
<div class="block">Indicates whether cropping was enabled when the frame was produced.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if cropping is enabled, false otherwise</dd></dl>
</li>
</ul>
<a name="getCropOriginX()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCropOriginX</h4>
<pre>public int getCropOriginX()</pre>
<div class="block">Indicates the X coordinate of the upper left corner of the crop window.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Distance of crop origin from left side of image, in pixels.</dd></dl>
</li>
</ul>
<a name="getCropOriginY()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCropOriginY</h4>
<pre>public int getCropOriginY()</pre>
<div class="block">Indicates the Y coordinate of the upper left corner of the crop window.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Distance of crop origin from top of image, in pixels.</dd></dl>
</li>
</ul>
<a name="getStrideInBytes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStrideInBytes</h4>
<pre>public int getStrideInBytes()</pre>
<div class="block">Gives the length of one row of pixels, measured in bytes. Primarily useful for indexing the
array which contains the data.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Stride of the array which contains the image for this frame, in bytes</dd></dl>
</li>
</ul>
<a name="release()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>release</h4>
<pre>public void release()</pre>
<div class="block">Release the reference to the frame. Once this method is called, the object becomes invalid, and
no method should be called other than the assignment operator, or passing this object to a
<a href="../../org/openni/VideoStream.html" title="class in org.openni"><code>VideoStream</code></a>::readFrame() call.
Although the finalization process of the garbage collector also releases the reference,
it is preferable to manually release it by calling this method rather than to
rely on a finalization process which may not run to completion for a long period of time.</div>
</li>
</ul>
<a name="finalize()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finalize</h4>
<pre>protected void finalize()
throws java.lang.Throwable</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>finalize</code> in class <code>java.lang.Object</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.Throwable</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../org/openni/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../org/openni/Version.html" title="class in org.openni"><span class="strong">Prev Class</span></a></li>
<li><a href="../../org/openni/VideoMode.html" title="class in org.openni"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?org/openni/VideoFrameRef.html" target="_top">Frames</a></li>
<li><a href="VideoFrameRef.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|