Documentation for Face Intellect 8.0-8.1. Documentation for other versions of Intellect is available too.
Previous page
Next page
Commands can be used in Intellect scripts (see Examples of frequently used scripts and Guide for creating scripts (programming)) or sent directly to the core using the IIDK (see Intellect Integration Developer Kit (IIDK)).
The description of the FIRSERVER object commands:
| Command | Description |
|---|---|
| GET_IMAGE | Getting the image by its ID |
| SET_SOURCES | Rearranging the Recognition channel objects in the Intellect objects tree. The existing Recognition channel objects will be deleted, the new ones will be created and configured for the face detection objects whose IDs are specified in the sources<> parameter. Note. If the sources<> parameter contains non-existing IDs of face detection objects, the Recognition channel objects will be created with the default settings (as configured in Intellect) |
| VERIFY_START | User verification. It compares the face captured in the frame with the user photo, which is stored on the disk at the path: <Intellect installation directory>\Bmp\<Person> |
| ADD_PERSON_FROM_FILE | Adding of a reference face from a file to the reference face database |
| PHOTO_ADDED | Updating a photo for an existing face in the reference face database |
| START_CAM_FACECAPTURE | Starting the face detection |
| STOP_CAM_FACECAPTURE | Stopping the face detection |
| CHECK_QUALITY_START | Checking the quality of the saved user photo. Compares the quality of the user photo to the specified minimum quality of the face on the Face Recognition Server. Determines the quality of the photo or its absence |
The list of the commands parameters:
| Parameter | Parameter description |
|---|---|
| requestId<> | The request ID (is required to uniquely associate the request with the response on the client side) |
| id<> | The image ID |
sources<> | The list of existing Face detection objects IDs |
| biggestFace<1> | If there are several faces in the added photo, then the reference face with the biggest size in the frame will be added to the database |
| person_id<> | The face identifier in the reference face database |
| image<> | The image in the "base64" format |
| delay<> | The command execution delay in seconds |
| cam_id<> | The camera ID |
| p_id<> | The name of the photo file in the <Intellect installation directory>\Bmp\<Person> folder without permission |
| wait<> | Timeout in seconds |
| filename<> | The full name of the photo file. Files with the JPG, BMP, GIF, PNG extensions are allowed |
| name<> | First name of the added user |
| surname<> | Last name of the added user |
| department<> | The department to which the user will be added |
| comment<> | Commentary |
| cam_facecapture<> | Face detection |
| p_id<> | The ID of the user whose photo quality is checked |
The command example for getting the image by its ID:
DoReact(FIRSERVER|1|GET_IMAGE|id<052B723D-5C29-E811-88D3-005056C00008>,requestId<76C5B293-FD2F-4F25-B1D7-7B62442D2E89>);
In response to this request, a message will be received, where the "image" parameter will contain an image in the "base64" format (for the details on the event generated by the request, see FIRSERVER events).
The command example for rearranging the Recognition channel objects in the Intellect objects tree:
DoReact(FIRSERVER|1|SET_SOURCES|sources<2.1,3.1>);
The command example for updating a user's photo by his identifier:
DoReactStr("FIRSERVER",1,"PHOTO_ADDED","person_id<1>,biggestFace<1>,image<base64>,delay<1>");
The command example for the user verification:
DoReactStr("FIRSERVER","1","VERIFY_START","cam_id<1>,p_id<15>,wait<10>");
The command example for adding a face from a file to the reference face database:
DoReactStr("FIRSERVER","1","ADD_PERSON_FROM_FILE","filename<c:\\iso_small.jpg>,name<Jane>,surname<Kramer>,department<Department 1>,comment<>");
The command example for stopping the face detection:
FIRSERVER|1|STOP_CAM_FACECAPTURE|cam_facecapture<3.1>
The command example for starting the face detection:
FIRSERVER|1|START_CAM_FACECAPTURE|cam_facecapture<3.1>
The command example for checking the quality of a saved user photo:
DoReactStr("FIRSERVER","1","CHECK_QUALITY_START","p_id<1>");