X*S-API is a set of functions needed to interface the user with the X*S series of products (X*S-lib, X*S-server, X*S-NUC).
The functions are compiled and ready to be used on both Linux and Windows environments, 32 or 64 bit.
The aim of X*S-API is to make friendly the usage of our technologies, through simple functions, e.g:
- OpenConnection(handle, ip_address, port) ⇒ used by the client to set the connection with XS-server or XS-NUC, and enable the communication;
- SetParameters(handle, name, value) ⇒ it can be used to modify parameters of the algorithm;
- SetTask(handle, task) ⇒ used to communicate the path in order to be elaborated;
- StartOptimization(handle, cb) ⇒ it starts the elaboration of the path and allows the consuming of the optimized samples through a callback function defined by the user;
- CloseConnection(handle) ⇒ it closes the connection with the server application.