Skip to main content
Version: 0.9.0 (next)

PeerDeviceIdentity class

The device an application describes itself as (C QarPeerDeviceIdentity). Pass it at onboard or rejoin with PeerPresentationOptions.WithDeviceIdentity, or later with PeerControl.UpdateDeviceIdentity.

Namespace: Quaternar.Qaros · Assembly: Quaternar.Qaros.dll

public sealed class PeerDeviceIdentity : Structure

Inherits: Structure → PeerDeviceIdentity

Remarks​

An application is always a PeerRole.Source: it describes its device, never its role. PeerDeviceIdentity.Category must be DeviceCategory.DesktopPC, DeviceCategory.Server or DeviceCategory.Camera; any other is refused with StatusCode.PeerDeviceCategoryNotAllowed. Ids and families are open strings ("LuxonisOakD", "Luxonis"); one the hub's device catalog does not know is fine.

Constructors​

PeerDeviceIdentity(DeviceCategory, string)​

public PeerDeviceIdentity(DeviceCategory category, string deviceId)

Parameters

NameTypeDescription
categoryDeviceCategory
deviceIdstring

Properties​

MemberDescription
Category
DeviceIdRequired, non-empty; empty is refused with StatusCode.ArgumentNotSupported.
DeviceFamilyOptional; the rendering fallback for an id a viewer does not know.
DeviceNameOptional human name of the device; any UTF-8.

Category​

public DeviceCategory Category { get; set; }

Value: DeviceCategory

DeviceId​

Required, non-empty; empty is refused with StatusCode.ArgumentNotSupported.

public string DeviceId { get; set; }

Value: string

DeviceFamily​

Optional; the rendering fallback for an id a viewer does not know.

public string? DeviceFamily { get; set; }

Value: string

DeviceName​

Optional human name of the device; any UTF-8.

public string? DeviceName { get; set; }

Value: string