SDK
Understand the Ansight SDK family, shared runtime capabilities, and where to start for .NET, iOS, Android, and React Native integrations.
Ansight SDKs embed a local development runtime in your app. The runtime pairs with Ansight Studio, streams live app evidence, and can expose opt-in tool surfaces to developers and agents connected through Studio.
Use this section as the platform-neutral map. Each platform page then documents the concrete package names, installation steps, initialization APIs, and supported tool suites for that SDK.
Supported SDKs
| SDK | Runtime target | Start here |
|---|---|---|
 .NET | .NET, .NET MAUI, Android, iOS, and Mac Catalyst apps. | .NET SDK Overview |
 iOS | Native Swift, SwiftUI, and UIKit apps. | iOS SDK Overview |
 Android | Native Kotlin, Jetpack Compose, and Android View apps. | Android SDK Overview |
 React Native | React Native apps backed by the native iOS and Android SDKs. | React Native SDK Overview |
Core Capabilities
| Capability | What it provides |
|---|---|
| Pairing and host connection | Development pairing with Ansight Studio, signed pairing payload validation, host discovery, and local session transport. |
| Host auto-probe | SDK-owned remembered-host retry behavior that reconnects after the host disappears and later reappears while the runtime is active. |
| Session capture | Periodic JPEG screenshots, screen-view changes, touch input, lifecycle state, and app logs for replay and review in Studio. |
| Performance telemetry | Runtime sampling for metrics such as memory, FPS, battery where supported, and platform-specific channels. |
| Live client logs | Explicit app-to-Studio log events that appear alongside screenshots, telemetry, and tool results. |
| Artifacts | App-defined diagnostic exports that Studio and agents can discover and retrieve during a session. |
| Remote tools | Optional read, write, and delete tool surfaces for visual trees, files, preferences, secure storage, databases, reflection, custom tools, and platform-specific inspection. |
| Tool guards | Runtime policy that can deny discovery and execution, restrict tools to read-only access, or allow selected write/delete workflows in trusted builds. |
Availability and API names vary by platform. Use the platform-specific articles before relying on a capability in app code.
Important: Screen capture will result in an FPS drop while frames are rendered or captured, encoded, and transported. Keep periodic JPEG capture scoped to development or QA sessions, and disable it for performance-focused runs unless visual evidence is required.
Host Auto-Probe
The .NET, Android, iOS, and React Native SDKs expose the same remembered-host retry concept. While the runtime is active, host auto-probe retries previous host connections so the app can reconnect after the host disappears and later reappears. Probing pauses while a live session is connected and resumes after the retry delay when that session is lost. The option is enabled by default in runtime defaults and in the all-in-one developer presets. Configure it when you need a specific client name or retry cadence:
| Field | Default |
|---|---|
| enabled | true |
| initial delay | 1000 ms |
| probe interval while disconnected | 5000 ms |
| retry delay after a lost session | 10000 ms |
| client name | unset |
Use each platform’s withoutHostAutoProbe() / WithoutHostAutoProbe() helper,
or set the enabled flag to false, for flows where reconnects should only happen
after an explicit app action.
Common Integration Flow
- Choose the SDK page for your app platform.
- Install the platform packages or products.
- Initialize the runtime in the platform startup location called out by the setup page, such as Android
Application.onCreate(), iOSAppDelegatelaunch, .NETMauiProgram, or React Native JavaScript bootstrap. - Configure security and tool guard policy before registering broad tool suites.
- Pair the app with Ansight Studio.
- Enable capture, telemetry, logs, artifacts, and tools needed for the workflow.
Capability Docs
Most SDKs follow the same documentation shape:
- Setup packages
- Security
- Pairing
- Configuration
- JPEG screenshots
- Screen views
- Performance telemetry
- Touch input
- Capturing logs
- App lifecycle
- Artifacts
- Tools
When a platform has extra capabilities, such as React Native component and shadow tree inspection, those are documented inside that platform’s Tools section.