Class PoseStream

A live pose stream from one device.

public sealed class PoseStream : IDisposable

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Disconnects on Dispose() — use it with using — and, as a backstop, when the handle is finalized.

Connect to a discovered device.

public PoseStream(DeviceInfo device, bool createThread = true)

device DeviceInfo: A device returned by Discover().
createThread bool: When true (the default and preferred mode), a background thread receives and buffers poses.

Connect to the device at ip.

public PoseStream(string ip, bool createThread = true)

ip string: Device IPv4 address; the Enpose API is IPv4-only.
createThread bool: When true (the default and preferred mode), a background thread receives and buffers poses; otherwise poses are collected when Receive(bool) is called.

Disconnect and release the stream. Idempotent.

public void Dispose()

Return poses received from the stream.

public IReadOnlyList<MarkerPose> Receive(bool block = false)

block bool: When false (the default), returns the poses that have arrived since the previous call (empty if none) without waiting. When true, waits for at least one pose update, up to a 3-second timeout — so the result is still empty if none arrives in that window.