menu_book

Knowledge Base

Documentation, guides, and resources for Noldus products.

FaceReader 9 - API Messages and Data Format

Last updated: Jul 28, 2026

Message Packages

The described messages are sent as bytes over TCP. A message is converted to bytes in the following manner:

  • The first 4 bytes contain the length in bytes (TypeNameLength) of the typename of the message.
    • Typenames can be:
      • FaceReaderAPI.Messages.ActionMessage
      • FaceReaderAPI.Messages.ResponseMessage
      • FaceReaderAPI.Data.Classification
  • The next TypeNameLength bytes contain the typename as UTF-8 encoded bytes.
  • The rest of the bytes are the Message XML as UTF-8 encoded bytes.

The total message length is calculated as follows:

MessageBytesLength = 4 + TypeNameLength + MessageXmlLength

The messages are prefixed with the length of the message to make receiving easier. The actual package sent over TCP consists of the following bytes:

  • The first 4 bytes contain the total length of the package (MessageBytesLength + 4).
  • The rest of the bytes contain the MessageBytes.
PackageBytes = array of bytes of length MessageBytesLength + 4

Technical Support

Technical support on using the Application Programming Interface is available for customers with NoldusCare. Please look on our web site at http://www.noldus.com/support-center/nolduscare for more information about NoldusCare.

The use of the Application Programming Interface itself is supported for customers with NoldusCare. However, due to the large number of possible programming languages and operating systems that allow implementation of the API into custom made applications, we are unable to provide active support for the applications you make yourself.

If you have any problems, questions, remarks or comments, please let us know. From the Help menu select Noldus Online and then Contact Help Desk, or browse to the MyNoldus section on our website. Under Get Support you will find the contact details of the help desk in your region.

Note that if you send us videos showing people's faces, you should have permission from those people that you can use the video for that purpose, and you may need to sign a form granting consent for us to use those videos.

Before you contact Technical Support, please have the version number and license number of your copy of FaceReader available. To find these numbers, from the Help menu select About.

Please refer to the Contact section on our web site (www.noldus.com) for other contact information.

Source: Application Programming Interface - FaceReader 9 Technical Note, Noldus Information Technology

Expand your existing system

Already a Noldus user? Ask about upgrade options and additional modules for your current setup.

Noldus is here to assist you throughout the whole process.

shopping_bag
check_circle

Thank you!

We'll get back to you shortly.

error

Please correct the following errors:

error

error

error

error

By clicking Submit, you consent to Noldus processing your data as described in our privacy policy.