License¶

The Inscoper API is designed to be accessible while providing advanced functionality for demanding research and production environments.

Operating Modes¶

The API can be operated in two distinct modes depending on whether a valid license is present.

Standard Mode (Unlicensed)¶

This mode allows you to test the integration and access the basic functions of the API. It is ideal for:

Discovering the API and main classes.
Initial development of basic scripts and tools.
Validating communication with the controller.

Professional Mode (Licensed)¶

Acquiring a license unlocks the full potential of the Inscoper API. This mode is required to benefit from advanced features essential for complex workflows.

Features Unlocked by the License¶

Using the API with an active license provides access to many exclusive features:

Multi-dimensional Acquisitions: Full support for Z-stack, Time-lapse, and multi-channel sequences.
High Performance: Optimized data flows for high-frame-rate cameras.
Advanced Hardware Management: Precise control of synchronization devices and hardware triggers (TTL).
Multi-Camera Support: Simultaneous use of multiple cameras for synchronized acquisitions.

License Placement¶

For the API to correctly detect and validate your license, the license file must be placed in the same directory as your script or executable.

Runtime Detection

If the license file is not found in the execution directory, the API will default to Standard Mode, even if a valid license file exists elsewhere on the system.