AR51Client

static class thread-safe

namespace AR51.Net;

public static class AR51Client

Creates IAR51Client instances.

How-to

This page is reference (facts only). For a walkthrough with a complete sample, see the Connecting guide.

Example

await using IAR51Client ar51 = AR51Client.Create();
ar51.Skeletons.SkeletonReceived += (_, e) => Console.WriteLine(e.Skeleton.GetPosition(Joint.MidHip));
await ar51.StartAsync();

Method summary

Method	Returns
Create	IAR51Client	static

→ Full descriptions in Method details below.

Method details

Create

methodstatic

public static IAR51Client Create(AR51ClientOptions? options = null, ILoggerFactory? loggerFactory = null);

Creates a client. It does not connect until IAR51Client.StartAsync is called.

Parameters

optionsAR51ClientOptions?Connection settings. null finds the server on the local network. Optional.

loggerFactoryILoggerFactory?Receives the client's diagnostic log. null disables logging. Optional.

ReturnsIAR51ClientA new, not yet connected client.

Throws

ArgumentOutOfRangeExceptionA port or time span in options is out of range.

See also

• Connecting guide — walkthrough with a complete, compiled sample
• Class index — every AR51.Net type
• Data conventions, threading and errors