Documentation guide
NativeChannels connects .NET MAUI to native adapters through generic Android, Apple, and Windows bridges. Use these guides to integrate an SDK, package a reusable plugin, or contribute to the framework.
Start with your task
| I want to… | Start here |
|---|---|
| Try a complete native round trip | Getting started |
| Select calls, messages, streams, or views | Choose a channel |
| See practical integrations | Examples |
| Package an SDK behind a C# API | Build a plugin |
| Find a member or option | C# API reference |
| Fix a setup or runtime failure | Troubleshooting |
| Observe call timings and outcomes | Diagnostics |
Channel guides
| Contract | Guide |
|---|---|
| Named operations and typed replies | Method channels |
| Values and binary chunks with a reply | Basic messages |
| Independent native subscriptions | Event streams |
| Embedded native UI with per-instance channels | Native views |
Read configuration for timeouts and dispatch, codecs for supported values and DTO metadata, and error handling for failure semantics. Threading and lifecycle explain ordering, ownership, and cleanup.
Native adapters and plugins
- Android integration: Kotlin modules, AARs, native dependencies, and preservation rules.
- Apple integration: Swift modules, Objective-C names, XCFrameworks, and callback lifetimes.
- Mac Catalyst: platform slices and separate build/runtime checks.
- Windows: C# adapters, WinUI views, local packages and verification.
- Plugin authoring: contracts, managed facades, registration, packaging, and consumer verification.
The Currency, AudioStreamer, VolumeMonitor, and PdfViewer reference plugins each include a sample and verification record.
Internals and maintenance
- Architecture, binary messenger, and wire protocol.
- Building, testing, and performance and stress.
- Platform verification, release checklist, NuGet publishing, and changelog.
- Contributing and editing the documentation site.
- Roadmap: complete Avalonia integration in 0.2, Uno in 0.3, and stable release acceptance. Both planned hosts target Android, iOS, Windows, desktop macOS, Linux, and browser/WebAssembly.
- FAQ and Flutter comparison.
The framework preview is available on NuGet.org; reference plugins are built locally. Use the verification record to distinguish compiled targets, executed scenarios, and remaining gaps.