API Reference
MediaSFU API reference is available through curated package guides and generated reference sites for every supported SDK family.
Use the SDK guides for integration flow, install commands, backend mode, and framework-specific setup. Open the generated API sites when you need exact signatures, exported types, class members, props, or generated symbol listings.
Package API sites
| Package | Best for | API docs |
|---|---|---|
mediasfu-shared | Shared core logic across frameworks | Open API reference |
mediasfu-reactjs | Web apps with full React control | Open API reference |
mediasfu-angular | Angular apps with DI-based wrappers | Open API reference |
mediasfu-reactnative | Bare React Native mobile apps | Open API reference |
mediasfu-reactnative-expo | Expo-managed mobile apps | Open API reference |
mediasfu-vue | Vue apps with composition-friendly APIs | Open API reference |
mediasfu_sdk | Flutter apps across mobile, web, and desktop | Open staged Dartdoc · pub.dev |
com.mediasfu:mediasfu-sdk-android / com.mediasfu:mediasfu-sdk | Native Android and KMP Compose apps | Open staged Dokka/KDoc · Maven Central |
How to choose the right reference
- Start with SDK Guides when you are choosing a package or setting up a first room.
- Use this overview when you know the package family but need the right reference destination.
- Open Generated API Docs when you need exact generated TypeDoc, Dartdoc, or Dokka/KDoc pages.
- Return to Usage Paths when you are deciding between prebuilt UI, UI overrides, custom components, or headless mode.
Recommended reading order
- Start with /sdks to choose the right framework package.
- Read the relevant SDK guide for quickstart, backend mode, and framework-specific setup.
- Jump into the package API site when you need exact types, method signatures, or generated symbol listings.