Client SDK overview
Clients offer a Headless SDK and UI Kit. Headless exposes classroom operations and callbacks; UI Kit provides classroom screens. Both use classroom user tokens issued by your backend.
Swipe horizontally to see the full diagram
Platforms
| Platform | Headless / UI Kit | Requirements | Guide |
|---|---|---|---|
| Web / H5 | @eduskit/sdk / @eduskit/ui | npm 0.1.1; Vue 3 UI, with a controller for other frameworks | Web |
| Android | com.eduskit:edusdk / com.eduskit:edusdk-ui | Kotlin / Java; API 24+, arm64 distribution chain | Android |
| iOS / iPadOS | EduSDK / EduSDKUI | Swift / Objective-C; unified SwiftPM package requires iOS 15+ | iOS |
| Electron | @eduskit/sdk-electron / @eduskit/ui-electron | Windows / macOS; native dependencies are OS- and architecture-specific | Electron |
| Qt / C++ | DesktopSdk / EduSdk::UiQt | macOS and Windows x64; examples require native provider libraries | Qt / C++ |
| WeChat / Alipay / Douyin mini programs | Platform createEduSdk subpackage entry | Source bundles; host monotonic clock, Worker/WASM and device integration required | Mini programs |
| HarmonyOS | @edukits/edusdk / @edukits/edusdk-ui | Local HAR; host provider bindings required | HarmonyOS |
| Flutter / React Native | Planned native bridges | No official bridge plugin or package | Bridge status |
Entry parameters
| Parameter | Source |
|---|---|
appId | Classroom application ID |
backendUrl | sdk-api endpoint for the environment |
classroomId | Server classroom creation result |
userId | Registered user's eduUserId |
userToken | Raw accessToken issued by the Server SDK |
displayName | Business display name |
The production default is https://sdk.eduskit.com; development uses https://sdk-dev.eduskit.com. Web requires classroomId, userId and userToken. Mobile Options also require application, endpoint and display-name arguments as shown in their signatures.
Entry responses supply IM, RTC and whiteboard credentials and addresses. Source builds use init.needWhiteboard / init.needRtc to select capabilities and keep IM and RTC credentials separate. See Classroom lifecycle.
Configure Host permissions and networking before running platform examples. Versions and distribution describes source/release differences.