DeviceApi

Record in Oadm.Sdk.Vapix · Oadm.Sdk.dll

One entry of the device’s VAPIX API discovery list (apidiscovery.cgi getApiList), e.g. user-management 1.2, network-settings 1.37, fwmgr 1.10. A device can list the same API id with several major versions.

public sealed record DeviceApi(string Id, string Version, string? Name = null, string? Status = null)

Guide: Devices and VAPIX

Parameters

Id: The API id (“network-settings”).
Version: The version as the device lists it (“1.37”).
Name: The API’s name, when the device gives one.
Status: The API’s status (“released”, “beta”), when the device gives one.

Properties

Id

string Id { get; init; }

The API id (“network-settings”).

Name

string? Name { get; init; }

The API’s name, when the device gives one.

ParsedVersion

Version ParsedVersion { get; }

Parsed DeviceApi.Version; 0.0 when the device reports something unparsable.

Status

string? Status { get; init; }

The API’s status (“released”, “beta”), when the device gives one.

Version

string Version { get; init; }

The version as the device lists it (“1.37”).