Community-maintained developer documentation for FlexLib, the C# API for FlexRadio Systems software-defined radios. Written and corrected against FlexLib 4.2.x.
Unofficial and unaffiliated. This project is not produced, endorsed, or reviewed by FlexRadio Systems. FlexLib itself is FlexRadio's proprietary software, licensed separately by them, and is not distributed here. Obtain FlexLib from FlexRadio. For official support, contact FlexRadio at https://community.flexradio.com.
The FlexLib documentation published elsewhere has not kept pace with the library. These pages are maintained by a developer who ships against FlexLib in practice (SmartStreamer4), and every API claim here is checked against the FlexLib source rather than inherited from older documentation.
That checking is the point of the project. An earlier edition of these
pages documented members that do not exist in the shipping library
(Slice.Mode, Radio.MeterList, Meter.Value, Radio.RemoveSlice,
and others). The API Reference opens with a
corrections table listing what was wrong, what the library actually
does, and whether affected code fails to compile or fails silently.
| You want | Go to |
|---|---|
| A tutorial from zero | Getting Started |
| A signature, fast | API Reference |
| Working code to adapt | Examples |
| Threading model and protocol | Architecture |
| Upgrading from 4.1.5 | Migration Guide |
| The complete generated class reference | Generating API Docs |
Pages carry a status line under the title stating which FlexLib build their claims were checked against. Read it. A page marked partially verified has been corrected in targeted passes but not re-read end to end, and a signature you depend on is worth confirming against your own copy of the source.
The full class-by-class reference is not included in this repository. It is generated by DocFX directly from the FlexLib source, which means it reproduces FlexRadio's own code and documentation comments, and their license does not permit republishing that.
Building it yourself takes one command against the FlexLib source you already have. See Generating API Docs.
Corrections are welcome, and accuracy reports are the most valuable kind.
When reporting or fixing an API claim, please include the FlexLib build
you checked against (e.g. 4.2.20.41343) and the source file and line
that backs it. Claims that cannot be traced to the source will not be
merged, however plausible they look. That rule is what keeps this
documentation worth more than a search result.
Please do not open pull requests that add FlexLib source, DocFX-generated YAML, or rendered site output; those cannot be accepted for the licensing reason above.
The documentation in this repository is licensed CC BY 4.0. That covers this repository's prose, tables, and code samples only. It makes no claim over FlexLib or any other FlexRadio Systems property.