core
/
expressed
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
expressed/v_dl/sdk/doc/global.html

1727 lines
27 KiB
HTML
Raw Normal View History

work
2023-11-20 16:39:21 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="FP_START_GROUP_INDEX"><span class="type-signature">&lt;constant> </span>FP_START_GROUP_INDEX<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>2</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="FP_END_GROUP_INDEX"><span class="type-signature">&lt;constant> </span>FP_END_GROUP_INDEX<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>17</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="FP_NUMBER_OF_GROUPS"><span class="type-signature">&lt;constant> </span>FP_NUMBER_OF_GROUPS<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>16</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="VisageTrackerStatus"><span class="type-signature"></span>VisageTrackerStatus<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
Helper class for visage tracker status.
<br/><br/>
Sample usage:
<br/>
<pre class="prettyprint source"><code>
if (trackerReturnState===VisageModule.VisageTrackerStatus.TRACK_STAT_OK.value)
{
// Draw feature points
}
</code></pre>
<br/>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>TRACK_STAT_OFF</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
0
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TRACK_STAT_OK</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
1
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TRACK_STAT_RECOVERING</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
2
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>TRACK_STAT_INIT</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
3
</td>
<td class="description last"></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="VisageTracker.html#track">track()</a></li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="VisageTrackerImageFormat"><span class="type-signature"></span>VisageTrackerImageFormat<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
Helper class for visage tracker image format passed as a parameter to <a href="VisageTracker.html#track">track()</a> function.
<br/><br/>
Sample usage:
<br/>
<pre class="prettyprint source"><code>
trackerReturnState = m_Tracker.track(
mWidth, mHeight, ppixels, faceData,
VisageModule.VisageTrackerImageFormat.VISAGE_FRAMEGRABBER_FMT_RGBA.value,
VisageModule.VisageTrackerOrigin.VISAGE_FRAMEGRABBER_ORIGIN_TL.value
);
</code></pre>
<br/>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>VISAGE_FRAMEGRABBER_FMT_RGB</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
0
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VISAGE_FRAMEGRABBER_FMT_BGR</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
1
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VISAGE_FRAMEGRABBER_FMT_LUMINANCE</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
2
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VISAGE_FRAMEGRABBER_FMT_RGBA</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
3
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VISAGE_FRAMEGRABBER_FMT_BGRA</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
4
</td>
<td class="description last"></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="VisageTracker.html#track">track()</a></li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="VisageTrackerOrigin"><span class="type-signature"></span>VisageTrackerOrigin<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
Helper class for visage tracker origin passed as a parameter to <a href="VisageTracker.html#track">track()</a> function.
<br/><br/>
<b>Note</b>: This parameter is no longer used.
<br/><br/>
Sample usage:
<br/>
<pre class="prettyprint source"><code>
trackerReturnState = m_Tracker.track(
mWidth, mHeight, ppixels, faceData,
VisageModule.VisageTrackerImageFormat.VISAGE_FRAMEGRABBER_FMT_RGBA.value,
VisageModule.VisageTrackerOrigin.VISAGE_FRAMEGRABBER_ORIGIN_TL.value
);
</code></pre>
<br/>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">number</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>VISAGE_FRAMEGRABBER_ORIGIN_TL</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
0
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>VISAGE_FRAMEGRABBER_ORIGIN_BL</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="default">
1
</td>
<td class="description last"></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="VisageTracker.html#track">track()</a></li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="initializeLicenseManager"><span class="type-signature"></span>initializeLicenseManager<span class="signature">(licenseKeyFileName)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Initializes licensing manager.
<br/><br/>
Must be called before the constructor of either <a href="VisageTracker.html">VisageTracker</a>, <a href="VisageDetector.html">VisageDetector</a>, <a href="VisageGazeTracker.html">VisageGazeTracker</a>, <a href="VisageFaceAnalyser.html">VisageFaceAnalyser</a> or <a href="VisageFaceRecognition.html">VisageFaceRecognition</a>. Provided license key will be loaded via HTTP request.
<br/><br/>
In case of multiple licenses call the function multiple times providing different license keys.
<br/><br/>
Relative paths are also supported. Working folder being the folder where the main application html file is located.
<br/><br/>
Sample usage:
<br/>
<pre class="prettyprint source"><code>
//set up tracker and licensing, valid license needs to be provided
VisageModule.initializeLicenseManager("xxx-xxx-xxx-xxx-xxx-xxx-xxx-xxx-xxx-xxx-xxx.vlc");
m_Tracker = new VisageModule.VisageTracker("../../lib/Facial Features Tracker.cfg");
m_Detector = new VisageModule.VisageDetector();
faceData = new VisageModule.FaceData();
</code></pre>
<br/>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>licenseKeyFileName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Name of the licensing file.</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<dt>
<h4 class="name" id="getSDKVersion"><span class="type-signature"></span>getSDKVersion<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Returns visageSDK version and revision number.
<br/><br/>
</div>
<dl class="details">
</dl>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<dl>
<dt>
<h4 class="name" id="VFAReturnCode">VFAReturnCode</h4>
</dt>
<dd>
<div class="description">
Enumeration describing potential outcomes of the <a href="VisageFaceAnalyser.html#analyseImage">VisageFaceAnalyser.analyseImage()</a> and <a href="VisageFaceAnalyser.html#analyseStream">VisageFaceAnalyser.analyseStream()</a> methods of the VisageFaceAnalyser class.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>NoError</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The function has executed successfully.</td>
</tr>
<tr>
<td class="name"><code>InvalidFrame</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The image pointer or the related data may be null.</td>
</tr>
<tr>
<td class="name"><code>InvalidFaceData</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The FaceData has not been initialized by a previous tracking or detection operation.</td>
</tr>
<tr>
<td class="name"><code>InvalidLicense</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The license may be missing, invalid file name passed, expired or another related error.</td>
</tr>
<tr>
<td class="name"><code>DataUninitialized</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">VisageFaceAnalyser was not properly initialized by a call to Init() method, or required data files were not found on supplied location.</td>
</tr>
</tbody>
</table></dl>
</dl>
</dd>
<dt>
<h4 class="name" id="VFAFlags">VFAFlags</h4>
</dt>
<dd>
<div class="description">
Enumeration used to select which face analysis operations will be performed.
Flags can to be passed as options to <a href="VisageFaceAnalyser.html#analyseImage">VisageFaceAnalyser.analyseImage()</a> and <a href="VisageFaceAnalyser.html#analyseStream">VisageFaceAnalyser.analyseStream()</a> functions.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>VFA_AGE</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">1</td>
</tr>
<tr>
<td class="name"><code>VFA_GENDER</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">2</td>
</tr>
<tr>
<td class="name"><code>VFA_EMOTION</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">4</td>
</tr>
</tbody>
</table></dl>
</dl>
</dd>
<dt>
<h4 class="name" id="VFAEmotionIndices">VFAEmotionIndices</h4>
</dt>
<dd>
<div class="description">
Enumeration describing potential outcomes of the analyseImage() and analyseStream() methods of the VisageFaceAnalyser class.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>Anger</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Emotion index 0</td>
</tr>
<tr>
<td class="name"><code>Disgust</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Emotion index 1</td>
</tr>
<tr>
<td class="name"><code>Fear</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Emotion index 2</td>
</tr>
<tr>
<td class="name"><code>Happiness</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Emotion index 3</td>
</tr>
<tr>
<td class="name"><code>Sadness</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Emotion index 4</td>
</tr>
<tr>
<td class="name"><code>Surprise</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Emotion index 5</td>
</tr>
<tr>
<td class="name"><code>Neutral</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Emotion index 6</td>
</tr>
</tbody>
</table></dl>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-VisageTrackerUnityPlugin.html">VisageTrackerUnityPlugin</a></li><li><a href="module-VisageAnalyserUnityPlugin.html">VisageAnalyserUnityPlugin</a></li></ul><h3>Classes</h3><ul><li><a href="FaceData.html">FaceData</a></li><li><a href="ScreenSpaceGazeData.html">ScreenSpaceGazeData</a></li><li><a href="VectorFloat.html">VectorFloat</a></li><li><a href="VectorShort.html">VectorShort</a></li><li><a href="VectorString.html">VectorString</a></li><li><a href="VisageFaceAnalyser.html">VisageFaceAnalyser</a></li><li><a href="AnalysisData.html">AnalysisData</a></li><li><a href="FeaturePoint.html">FeaturePoint</a></li><li><a href="FDP.html">FDP</a></li><li><a href="VisageDetector.html">VisageDetector</a></li><li><a href="FaceDataVector.html">FaceDataVector</a></li><li><a href="VSRectVector.html">VSRectVector</a></li><li><a href="VSRect.html">VSRect</a></li><li><a href="VisageGazeTracker.html">VisageGazeTracker</a></li><li><a href="VisageFaceRecognition.html">VisageFaceRecognition</a></li><li><a href="VisageTracker.html">VisageTracker</a></li><li><a href="VisageConfiguration.html">VisageConfiguration</a></li><li><a href="VisageLivenessBlink.html">VisageLivenessBlink</a></li><li><a href="VisageLivenessSmile.html">VisageLivenessSmile</a></li><li><a href="VisageLivenessBrowRaise.html">VisageLivenessBrowRaise</a></li><li><a href="VisageAR.html">VisageAR</a></li></ul><h3>Global</h3><ul><li><a href="global.html#FP_START_GROUP_INDEX">FP_START_GROUP_INDEX</a></li><li><a href="global.html#FP_END_GROUP_INDEX">FP_END_GROUP_INDEX</a></li><li><a href="global.html#FP_NUMBER_OF_GROUPS">FP_NUMBER_OF_GROUPS</a></li><li><a href="global.html#initializeLicenseManager">initializeLicenseManager</a></li><li><a href="global.html#VisageTrackerStatus">VisageTrackerStatus</a></li><li><a href="global.html#VisageTrackerImageFormat">VisageTrackerImageFormat</a></li><li><a href="global.html#VisageTrackerOrigin">VisageTrackerOrigin</a></li><li><a href="global.html#getSDKVersion">getSDKVersion</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Sat Jul 29 2023 01:38:27 GMT-0000 (GMT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>