Skip to content
Back

DeviceApiExtensions

Static class in Oadm.Sdk.Vapix · Oadm.Sdk.dll

Compatibility checks every task plugin must use before it changes anything on a device. Semantics follow VAPIX versioning: a different major version is a different, incompatible API; within a major version a higher minor version is backwards compatible.

public static class DeviceApiExtensions

Guide: Devices and VAPIX

Methods

Section titled “Methods”

FindApi

Section titled “FindApi”
static DeviceApi? FindApi(this IEnumerable<DeviceApi> apis, string apiId, int? major = null)

The highest listed version of apiId with the given major version, or of any major when null.

Require

Section titled “Require”
static DeviceApi Require(this IEnumerable<DeviceApi> apis, string apiId, string minVersion)

Throws DeviceNotCompatibleException unless DeviceApiExtensions.Supports is true.

Supports

Section titled “Supports”
static bool Supports(this IEnumerable<DeviceApi> apis, string apiId, string minVersion)

True when the device offers apiId with the same major version and at least minVersion.