@pose-tracker/react-native-pose-estimation-light 0.3.4 → 0.3.6

package/src/types/externalFrame.ts

@@ -0,0 +1,53 @@
+/**
+ * External frames: the host app owns the camera and the preview, and pushes
+ * frames to {@link PoseTrackerClient.processFrame}. The SDK infers, runs the
+ * active exercise engine, and returns data. It draws nothing.
+ */
+
+import type { PoseTrackerEvent } from './events';
+import type { Pose } from './pose';
+
+export interface ExternalFrame {
+  /** Encoded image (JPEG / PNG) without the `data:` prefix. */
+  base64?: string;
+  /** `file://`, `data:` or `https:` URL the WebView can load. */
+  uri?: string;
+  /** Width of the frame you send. Keep the longest side at 256 px or less. */
+  width: number;
+  height: number;
+  /** Capture time of the frame. The exercise engine uses it for timing. */
+  timestampMs: number;
+  /**
+   * Mirror keypoints horizontally, as for a selfie preview. Default `true`.
+   * Pass `false` for a back camera or an unmirrored preview.
+   */
+  mirrored?: boolean;
+  /** MIME type of `base64`. Default `image/jpeg`. */
+  mime?: string;
+}
+
+export interface ExternalFrameResult {
+  /** True when a previous frame was still running. Nothing was inferred. */
+  dropped: boolean;
+  /**
+   * Pose for this frame, or the last pose when `dropped`. Keypoints are
+   * normalized 0–1 to the frame you sent.
+   */
+  pose: Pose | null;
+  /**
+   * Events produced by this frame (keypoints, counter, posture, angles,
+   * form score, …), in emission order. They are also delivered to the
+   * existing listeners. Empty when `dropped`.
+   */
+  events: PoseTrackerEvent[];
+}
+
+export function isExternalFrame(frame: unknown): frame is ExternalFrame {
+  if (frame == null || typeof frame !== 'object') return false;
+  const f = frame as Partial<ExternalFrame>;
+  return (
+    (typeof f.base64 === 'string' || typeof f.uri === 'string') &&
+    typeof f.width === 'number' &&
+    typeof f.height === 'number'
+  );
+}