Class index — C# API (AR51.Net)

Every public type of the AR51.Net assembly, grouped by area. All types are in the one namespace AR51.Net.

Units

Positions are in meters, in the AR 51 world: left-handed, X right, Y up, Z forward (the same axes as Unity). Rotations are System.Numerics.Quaternion. See Data conventions.

Connecting

Type	Kind
AR51Client	static class	Creates IAR51Client instances.
AR51ClientOptions	record · sealed	Settings for AR51Client.Create.
AR51ErrorCode	enum	What went wrong in a AR51Exception.
AR51Exception	class · sealed	Thrown when a call to the AR 51 system fails.
ConnectionState	enum	The connection state of an IAR51Client.
ConnectionStateChangedEventArgs	class · sealed	Data for IAR51Client.ConnectionStateChanged.
IAR51Client	interface	The AR 51 system: finds the server, connects, and gives you every service through one object.

Skeletons

Type	Kind
HandJoint	enum	Hand joints reported in a HandPose.
HandPose	class · sealed	The joint positions of one hand, from a headset with hand tracking.
ISkeletonClient	interface	Live skeletons of the people the AR 51 system tracks.
Joint	enum	Body joints reported in a Skeleton.
Skeleton	class · sealed	One tracked person at one moment: the 3D position and confidence of each body joint, the hands when a hand-tracking headset reports them, plus identity and timing.
SkeletonClient	class · sealed	Receives live skeletons from the AR 51 skeleton service.
SkeletonEventArgs	class · sealed	Data for ISkeletonClient.SkeletonReceived.

Object detection

Type	Kind
IObjectDetectionClient	interface	Live tracked objects, for example props.
ObjectDetectionClient	class · sealed	Receives live tracked objects from the AR 51 object detection service.
TrackedObject	class · sealed	One tracked object at one moment, for example a prop: its position and rotation, plus identity and timing.
TrackedObjectEventArgs	class · sealed	Data for IObjectDetectionClient.ObjectReceived.

Servers

Type	Kind
IServerClient	interface	The AR 51 server machines: see their status, launch or quit the AR 51 server program, and start or stop tracking.
ServerInfo	record · sealed	An AR 51 server machine.
ServersChangedEventArgs	class · sealed	Data for IServerClient.ServersChanged.
ServerState	enum	Whether the AR 51 server program is running on a machine.
ServerStatus	record · sealed	The status of an AR 51 server machine.
TrackingState	enum	Whether the AR 51 server program is tracking.

Cameras

Type	Kind
AutoTuneEndedEventArgs	class · sealed	Data for ICameraClient.AutoTuneEnded.
AutoTuneOptions	record · sealed	Options for ICameraClient.StartAutoTuneAsync.
AutoTuneOutcome	enum	How an auto-tune ended.
AutoTuneStatus	record · sealed	The status of an auto-tune across all camera servers.
AutoTuneStatusEventArgs	class · sealed	Data for ICameraClient.AutoTuneStarted and ICameraClient.AutoTuneProgressChanged.
CameraAutoTuneStatus	record · sealed	The auto-tune status of one camera.
CameraCalibration	record · sealed	A camera's calibration values, in the OpenCV convention.
CameraFrame	record · sealed	One preview image from a camera.
CameraInfo	record · sealed	An AR 51 camera.
CameraSettings	record · sealed	A camera's image settings.
ICameraClient	interface	The AR 51 cameras: list them with their calibration values, preview their video, change their image settings, and tune those settings automatically.
LensDistortion	record struct · readonly	Lens distortion coefficients, in the OpenCV order (k1, k2, p1, p2, k3).
PreviewOptions	record · sealed	Options for ICameraClient.StreamPreviewAsync.

Calibration

Type	Kind
CalibrationEndedEventArgs	class · sealed	Data for ICalibrationClient.CalibrationEnded.
CalibrationOutcome	enum	How a calibration ended.
CalibrationResult	record · sealed	The result of a calibration.
CalibrationStatus	record · sealed	The status of camera calibration.
CalibrationStatusEventArgs	class · sealed	Data for ICalibrationClient.CalibrationStarted and ICalibrationClient.CalibrationProgressChanged.
CaptureBounds	record · sealed	The tracked area: a box in the AR 51 world (meters; left-handed, X right, Y up, Z forward).
ICalibrationClient	interface	Camera calibration and the tracked area (capture bounds).

Recording

Type	Kind
IRecordingClient	interface	Records camera video and tracking data on the AR 51 servers.
RecordingOptions	record · sealed	Options for IRecordingClient.StartRecordingAsync.
RecordingStateEventArgs	class · sealed	Data for IRecordingClient.RecordingStateChanged.

Devices

Type	Kind
DeviceInfo	record · sealed	A device connected to the AR 51 system.
DevicePlatform	enum	The platform of a connected device.
DevicesChangedEventArgs	class · sealed	Data for IDeviceClient.DevicesChanged.
DeviceType	enum	The kind of a connected device.
IDeviceClient	interface	The apps and devices connected to the AR 51 system: headsets, Unity and Unreal apps, phones and Mocap Studio.