Skip to main content
Version: 0.9.0 (next)

QarPeerDeviceIdentity Struct

Extension: the device this application describes itself as. More...

Declaration​

struct QarPeerDeviceIdentity { ... }

Included Headers​

#include <qar-streaming-c/include/qar_streaming.h>

Public Member Attributes Index​

QarDeviceCategorycategory
const char *device_family
const char *device_id
const char *device_name
QarStructureHeaderheader

Description​

Extension: the device this application describes itself as.

Chain on QarPeerPresentation::header.next of QarOnboardInit or QarRejoinInit, or pass to qar_peer_update_device_identity(). Without it the application joins as a desktop PC with the fixed id of the host OS ("DesktopWindows" / "DesktopLinux").

An application always joins as QAR_PEER_ROLE_SOURCE: it describes its device, never its role. category must be QAR_DEVICE_CATEGORY_DESKTOP_PC, QAR_DEVICE_CATEGORY_SERVER or QAR_DEVICE_CATEGORY_CAMERA; any other value is refused with QAR_STATUS_PEER_DEVICE_CATEGORY_NOT_ALLOWED.

Ids and families are open UTF-8 strings ("Zed2i", "Zed"), matched by viewers against the hub's device catalog. An id the catalog does not know is fine: viewers fall back to the family, then to the category, and show device_name.

Definition at line 1508 of file qar_streaming.h.

Public Member Attributes​

category​

QarDeviceCategory QarPeerDeviceIdentity::category

DESKTOP_PC, SERVER or CAMERA

Definition at line 1511 of file qar_streaming.h.

device_family​

const char* QarPeerDeviceIdentity::device_family

optional (NULL = none); e.g. "Luxonis"

Definition at line 1513 of file qar_streaming.h.

device_id​

const char* QarPeerDeviceIdentity::device_id

required, non-empty; e.g. "LuxonisOakD"

Definition at line 1512 of file qar_streaming.h.

device_name​

const char* QarPeerDeviceIdentity::device_name

optional (NULL = none); e.g. "OAK-D"

Definition at line 1514 of file qar_streaming.h.

header​

QarStructureHeader QarPeerDeviceIdentity::header

QAR_STRUCTURE_TYPE_PEER_DEVICE_IDENTITY

Definition at line 1510 of file qar_streaming.h.

The documentation for this struct was generated from the following file:

Generated via doxygen2docusaurus 2.2.1 by Doxygen 1.9.8.