SDK Feature Catalog

This catalog covers the application-facing features in the latest Ansight SDK release. Use it to choose a platform and package, then follow the linked platform guide to install the latest release and find exact API names.

Legend:

• Yes: first-class implementation in that SDK.
• Native: the cross-platform adapter exposes the feature through its Android or iOS bridge.
• Framework: supplied by the named framework integration.
• Conditional: available only when the app opts in or the host/device supports it.
• No: not implemented for that SDK.

Runtime and Enrollment

Shared enrollment model

1. The resident CLI host displays a short-lived, one-use QR invite from ansight pairing issue --qr.
2. The SDK scans it and sends ENROLLMENT_CONNECT over local UDP.
3. The host binds the invite to the SDK’s reported App ID and random app-installation ID. No prior app registration is required.
4. The host returns an ephemeral ws:// endpoint and session token.
5. The enrolled installation saves the returned state and reconnects on later launches.

Simulator, emulator, Mac Catalyst, and desktop targets use automatic loopback registration and skip the QR flow entirely.

Clearing app data or reinstalling creates a new installation ID and requires a fresh scan. Enrollment does not authorize remote tools: the app’s tool guard remains a separate policy boundary.

Capture and Diagnostics

Current runtimes advertise screenshot-control version 1 in device.profile. The CLI host can select host capture mode for a simulator or emulator; the SDK then suspends its periodic in-app JPEG loop while the host uses a platform source such as simctl or adb. Without a host-capture response, the configured SDK JPEG capture continues.

Screen capture adds rendering, encoding, and transport work. Disable periodic capture for trend-focused measurements unless visual evidence is required.

Remote Tools and Extensibility

All remote tools use the shared tool.query, tool.call, and tool.batch protocol. Catalog schema v2 supports deterministic revisions, conditional refresh, capability manifests, runtime availability, and compressed large JSON responses. See Remote Tool Protocol for the exact wire contract. Read-only, read/write, and full-access guards set one ordered maximum: Read, Write, or Critical.

App artifact providers advertise dynamically available exports through artifacts.query and create a requested snapshot through artifacts.request. Requested bytes use the live binary file-transfer channel, so artifact creation requires an active host session.

Shared tool IDs

The file-descriptor suite is native-only. There is no Ansight.Tools.FileDescriptorDiagnostics NuGet package. Cross-platform bridges receive the suite through native aggregate defaults but do not expose suite-specific framework options.

JNI reference diagnostics is Android-only. Native Android can configure the graph maxima; .NET Android registers it through Ansight.Core. React Native, Flutter, and Cordova/Capacitor inherit it from Android all-in-one defaults without suite-specific JavaScript or Dart configuration. HPROF capture briefly pauses the app and is intended for explicit development investigations.

Flutter macOS capture is framework-owned. Wrap the app in AnsightFlutterCaptureBoundary to retain Flutter-compositor screenshots, timestamp-correlated Flutter visual trees, Flutter-derived FPS, and pointer evidence. The boundary follows the configured JPEG cadence and deduplicates unchanged frames. Native AppKit screenshots, visual-tree inspection/actions, and input outside the boundary are not currently captured.

Framework and Workflow Features

Ansight and Ansight.Maui reference annotation and offline-capture packages. Annotated feedback is registered by default in Debug application builds and hard-disabled in Release builds; WithAnnotatedFeedback(...) customizes it. The managed recorder uses an OfflineCaptureController. Native offline capture opts in through WithOfflineCapture(...) / withOfflineCapture(...) and must not run alongside a parallel managed recorder.

Package Map

All-In-One Defaults

The all-in-one developer preset is aligned across .NET, Android, and iOS:

React Native defaults to core mode unless useNativeAllInOneDefaults: true is passed or withAnsightDefaults() / withAnsightSdk(...) is used. Flutter AnsightOptions.developer() and Cordova/Capacitor .withAnsightDefaults() select aligned developer presets. Crash capture is a core default rather than an all-in-one-only feature. None of these APIs detects build type; the app must apply its own development guard and choose tool, capture, crash-retention, and enrollment policy.

Build-Time Safeguards

Developer enrollment UI and broad remote-tool access are development features. Do not auto-launch enrollment or ship unrestricted tool policies in CI, store, TestFlight, Play Store, or other distributable builds.

Platform Privacy

• Android merges required network settings automatically; Google Code Scanner avoids a host-app camera permission.
• iOS requires Camera and Local Network usage descriptions when those features are invoked.
• No SDK needs Bluetooth, location, contacts, or photo-library access for enrollment.
• Clipboard reads can expose sensitive user content and may invoke the operating system’s paste-permission flow. Tool diagnostics redact clipboard values.
• Purchase diagnostics are simulator/emulator-only and retain bounded, app-reported evidence without exporting raw receipts, tokens, or transaction identifiers.
• Enrollment and the current local WebSocket transport do not encrypt or authenticate the network path. Use Ansight only on a trusted local network.

Platform Guides

• .NET SDK
• Android SDK
• iOS SDK
• React Native and Expo SDK
• Flutter SDK
• Cordova / Capacitor SDK
• Network Capture
• Connectivity Capture
• Native Offline Capture
• Managed .NET Offline Capture
• Motion Capture
• Clipboard Tools
• Purchase Diagnostics