Clarius offers multiple application programming interfaces (API) to allow researchers and commercial partners to work within the Clarius ecosystem of products.
 |
Cast API |
The Cast API runs on desktop platforms including Windows, Linux, and macOS. It uses the same technology as Clarius' in-app solution Clarius Cast, which allows streaming of the ultrasound image to multiple smart devices.
Programs developed using this technology can connect directly to the Clarius Scanner to stream images in real-time over the wireless network (Clarius App must also be running in parallel on a mobile device). In addition to streaming images, the Cast API also provides extra functionality that is not available through the Clarius Cast mobile solution, including the ability to:
- Change parameters such as gain and depth
- Freeze and unfreeze imaging
- Change imaging modes
- Download raw IQ and RF data directly to the desktop (when paired with the raw data software option)
This API is well-suited for:
- Academic Researchers
- Wanting to analyze raw ultrasound signals
- Running desktop software such as MATLAB or Python
- AI Startups and Developers
- Requiring quick access to real-time images
- Running desktop software such as TensorFlow or PyTorch
 |
Mobile API |
The Mobile API runs exclusively on Android, and allows new Apps to be developed that run side-by-side with the Clarius App. It uses Intents and Parcelables to exchange information on the Android platform and includes the ability to:
- Stream images in real-time
- Adjust parameters such as depth, gain, freeze, and imaging modes
- Handle button and power-down events sent from the scanner
Though Apps developed using the Mobile API require the Clarius App to be run in parallel, in this mode of operation, Clarius allows backgrounding of it's App to while maintaining the connection and imaging to the scanner so that partner Apps can be foregrounded as necessary.
This API is well-suited for:
- AI Startups creating new commercial applications
- Medical Device Companies requiring ultrasound images for guidance or augmentation other medical information
 |
OEM API |
The OEM API runs on desktop platforms including Windows, Linux, and macOS, and allows commercial partners to develop desktop applications where being stand-alone from the Clarius App is a requirement. This may stem from the need to integrate equipment that only runs on PC hardware, or having hard software requirements that do not allow to be run on a mobile platform.
This lower level API adds additional complexity when compared to the other APIs that Clarius offers due to the requirement to fully manage the Bluetooth and wireless connections to Clarius scanners. This is performed through special Bluetooth Low Energy services.
This API is well-suited for:
- Medical Device Companies with established software and hardware products
- AI Startups requiring larger computational resources in which mobile platforms cannot provide