| useAge |
boolean |
true |
Enable / disable age estimation model, possible values: true, false |
| useEmotions |
boolean |
true |
Enable / disable face expressions model, possible values: true, false |
| useFaceMask |
boolean |
true |
Enable / disable face mask model, possible values: true, false |
| useGender |
boolean |
true |
Enable / disable gender estimation model, possible values: true, false |
| useHeadpose |
boolean |
true |
Enable / disable head position model, possible values: true, false |
| useSmile |
boolean |
true |
Enable / disable smile detector, possible values: true, false |
| detectionRange |
string |
REGULAR |
Select REGULAR / LONG face detector |
| maxFaceSize |
float |
0 |
Maximum face size (width) as a % of the total frame width, varies with input resolution |
| maxNumFaces |
integer |
-1 |
Maximum number of simultaneous detections, default value is unlimited |
| minFaceSize |
float |
0 |
Minimum face size (width) as a % of the total frame width, varies with input resolution |
| licenseKey |
string |
|
DeepSight SDK authentication license |
| lifetimeAuthFile |
string |
|
Path to local authorization file when using lifetime licenses |
| operationMode |
string |
DEVELOPMENT |
Other options: RELEASE_LIFETIME for offline licenses, RELEASE_SESSION for session licenses |
| faceConfidenceThreshold |
float |
0.8 |
Face detector confidence value from 0.5 to 1, higher is stricter |
| neuralNetworksPath |
string |
./networks |
Path to the networks folder |
| bodyTrackFps |
string |
DYNAMIC |
People tracker operation mode, other options: FPS_30, FPS_10, FPS_5 |
| dnnTarget |
string |
CPU |
|
| networkType |
string |
QUANTIZED |
Switch between NORMAL or QUANTIZED networks |
| logLevel |
string |
INFO |
|
| numThreads |
integer |
-1 |
Number of virtual CPU threads that the Toolkit can use |
| drawResult |
boolean |
true |
Draw detection results on the image, possible values: true, false |
| blurFaces |
boolean |
false |
Blurs the image region where the person's face is, possible values: true, false |
| instanceName |
string |
tk |
Name of the toolkit instance |
| sourceType |
string |
WEBCAM |
Input source to use. Possible values: WEBCAM, VIDEO_FILE, VIDEO_STREAM |
| webcamIndex |
integer |
0 |
USB camera index assigned by the OS. 0 is usually the first USB camera found by the system |
| videoFilePath |
string |
|
Path to the video file to analyze |
| videoStreamUrl |
string |
|
URL of the video stream. Supported protocols are RTSP, RTP and HTTP(S) |
| resolutionWidth |
integer |
640 |
The resolution that the camera device should be open with. The resolution must be supported by the device |
| resolutionHeight |
integer |
480 |
The resolution that the camera device should be open with. The resolution must be supported by the device |
| loopVideo |
boolean |
false |
If set to true, when the video reaches the end, the playback is started from the beginning |
| processAllFrames |
boolean |
true |
If set to true, all the video frames are returned by the ds::help::SourceHandler::getNextFrame() function. Otherwise, frames not retrieved on time will be discarded |
| flipHorizontally |
boolean |
false |
Flip the image horizontally before processing |
| flipVertically |
boolean |
false |
Flip the image vertically before processing |
| rotateMode |
string |
ROTATE_0 |
Rotate the image in clockwise direction before processing. Possible values ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270 |
| zoomFactor |
integer |
1 |
Zoom the image before processing. Valid range: 1.0-100.0 |
| zoomCenterOffset_X |
integer |
0 |
Offset the image in x axis before applying zoom. Expressed in pixels |
| zoomCenterOffset_Y |
integer |
0 |
Offset the image in y axis before applying zoom. Expressed in pixels |
| ROI_X |
float |
0 |
x coordinate of the top-left corner of Region Of Interest, as a fraction of total frame width |
| ROI_Y |
float |
0 |
y coordinate of the top-left corner of Region Of Interest, as a fraction of total frame height |
| ROI_W |
float |
0 |
Width of the Region Of Interest rectangle, as a fraction of total frame width |
| ROI_H |
float |
0 |
Height of the Region Of Interest rectangle, as a fraction of total frame height |
| httpInterfacePort |
integer |
8080 |
HTTP port to use for local JSON pull output and API commands |
| httpInterfaceSsl |
boolean |
false |
Enable SSL for HTTP connection, possible values: true, false |
| httpInterfaceSslKey |
string |
certificate.key |
Path to the file containing SSL key |
| httpInterfaceSslCrt |
string |
certificate.crt |
Path to the file containing SSL certificate |
| rawCsvEnabled |
boolean |
false |
Enable exporting of raw data to CSV file, possible values: true, false |
| rawCsvPath |
string |
|
Path to the raw data CSV file |
| rawPullEnabled |
boolean |
false |
When enabled, raw data can be requested by HTTP get request, possible values: true, false |
| rawPushEnabled |
boolean |
false |
When enabled, pushes the raw data to the specified url, possible values: true, false |
| rawPushUrl |
string |
|
Specifies the URL to push raw data |
| aggregationFrequency |
integer |
30 |
Frequency of reporting aggregated data in seconds. Valid range: 1 - 3600 |
| aggregatedCsvEnabled |
boolean |
false |
Enable exporting of aggregated data to CSV file, possible values: true, false |
| aggregatedCsvPath |
string |
|
Path to the aggregated data CSV file |
| aggregatedPullEnabled |
boolean |
false |
When enabled, aggregated data can be requested by HTTP get request, possible values: true, false |
| aggregatedPushEnabled |
boolean |
false |
When enabled, pushes the aggregated data to the specified url, possible values: true, false |
| aggregatedPushUrl |
string |
|
Specifies the URL to push aggregated data |
| peopleCountEnabled |
boolean |
true |
Enable people count detection, possible values: true, false |
| peopleCountFrequency |
integer |
30 |
Frequency of reporting people count data in seconds. Valid range: 1 - 3600 |
| peopleCountCsvEnabled |
boolean |
false |
Enable exporting of people count data to CSV file, possible values: true, false |
| peopleCountCsvPath |
string |
|
Path to the people count data CSV file |
| peopleCountPullEnabled |
boolean |
false |
When enabled, people count data can be requested by HTTP get request, possible values: true, false |
| peopleCountPushEnabled |
boolean |
false |
When enabled, pushes the people count data to the specified url, possible values: true, false |
| peopleCountPushUrl |
string |
|
Specifies the URL to push people count data |
| statusPushEnabled |
boolean |
false |
When enabled, toolkit status updates are pushed to specified url, possible values: true, false |
| statusPushUrl |
string |
|
Specifies the URL to push toolkit status updates |
| statusPullEnabled |
boolean |
false |
When enabled, toolkit status can be requested by HTTP get request, possible values: true, false |
| currentStatsEnabled |
boolean |
false |
Enable for current time audience statistics to be collected and shared on two HTTP endpoints, possible values: true, false |
| currentStatsDuration |
integer |
30 |
The window duration for which the toolkit collects data. The default is set to 30000ms/30s |
| ucmsEnabled |
boolean |
false |
When enabled, generates per content demographics, based on content start and stop events, possible values: true, false |
| ucmsMode |
string |
START_STOP |
UCMS protocol mode. Possible values: START_STOP, START_START, START_DURATION |
| ucmsCsvEnabled |
boolean |
false |
Enable exporting of UCMS data to CSV file, possible values: true, false |
| ucmsCsvPath |
string |
|
Path to the UCMS data CSV file |
| ucmsPushEnabled |
boolean |
false |
When enabled, pushes the UCMS data to the specified URL, possible values: true, false |
| ucmsPushUrl |
string |
empty |
Specifies the URL to push UCMS data. |