Skip to content

Oadm.Sdk.Vapix

The logged-in VAPIX client of a device, API checks, request options and safe XML parsing.

Type Description
IVapixClient Authenticated VAPIX access to one device, with the stored login and the pinned certificate.
IVapixClientFactory Creates logged-in clients for managed devices (ICorePluginContext.Vapix).
Type Description
DeviceApiExtensions Compatibility checks every task plugin must use before it changes anything on a device.
DeviceNotCompatibleException The device does not offer a required VAPIX API version.
DeviceXml The only way OADM and its plugins parse XML that came from a device: documents of at most DeviceXml.MaxCharacters characters (1 MB), DTD processing prohibited, no external resolver.
VapixRequestOptions Per-request options understood by IVapixClient.SendAsync.
VideoResolutions Resolution choice shared by the live view and plugins (snapshots).
Type Description
BasicDeviceInfo The answer of basicdeviceinfo.cgi getAllProperties.
DeviceApi One entry of the device’s VAPIX API discovery list (apidiscovery.cgi getApiList), e.g.
VideoSource One video source of a device: a view area, a sensor of a multisensor camera or a channel of a video encoder.
Type Description
VideoResolution A video resolution in pixels.