The VAPIXService (Alert.CA.VAPIXService) is a class library that implements the VAPIX protocol — Axis Communications' HTTP-based API for communicating with Axis network cameras. This is the primary interface between the platform and physical cameras.
Architecture
What Is VAPIX?
VAPIX is Axis Communications' open HTTP-based API for controlling their network cameras. It provides:
- Image capture (JPEG, MJPEG streams)
- PTZ (Pan/Tilt/Zoom) control
- Camera configuration and status
- Overlay management
- Application (ACAP) management
VAPIXClient
The VAPIXClient implements IVAPIXClient and is the central class:
Image Acquisition
| Method | Purpose |
|---|
GetAWFImageAsync() | Capture image via AWF module (preferred — higher quality) |
GetImageAsync() | Capture image via standard VAPIX API (fallback) |
Camera Status
| Method | Purpose |
|---|
GetStatusAsync() | Query camera system ready state |
GetAllPropertiesAsync() | Get device info (model, firmware, serial number) |
GetApplicationsAsync() | List installed ACAP applications |
GetModelNumberAsync() | Get camera model number |
PTZ Control
| Method | Purpose |
|---|
| PTZ operations | Pan/tilt/zoom to specific coordinates |
| Home position | Return camera to home preset |
| Position query | Get current PTZ coordinates |
Overlay Management
| Method | Purpose |
|---|
| Overlay set | Apply text/image overlay on the camera feed |
| Overlay remove | Remove existing overlay |
| Overlay restore | Restore default overlay settings |
Documentation Sections