CXR-L(EN)
CXR-L(EN)
IntroductionQuick StartDevelopment Flow & State-MachineTerms and Abbreviations
Feature Development
Version HistoryAndroid
iOS
cxr-l-sdk · v1.0.1 · snapshot 2026-05-13· ↗ source
Terms and Abbreviations
Terms and Abbreviations
Platforms and products
| Term | Meaning |
|---|---|
| Rokid AI App | Companion mobile app used for authorization redirection and device-side coordination. In the Android Sample its package name is com.rokid.sprite.aiapp. |
| Glasses | Rokid glasses device, which establishes the link with the phone via Bluetooth and other means. |
| CXR-L SDK | Mobile SDK: Android Maven artifact com.rokid.cxr:client-l; iOS CocoaPods RGCxrClient, etc. |
Authentication and connection
| Term | Meaning |
|---|---|
| token | Communication token obtained after successful authentication, used for CXRLink.connect(token) (Android) or subsequent session initialization (iOS). |
| CXRLink | Main entry class of the Android SDK, package path com.rokid.cxr.link.CXRLink. |
| CxrClient | Public iOS SDK entry point; docs and integration notes commonly use the singleton CxrClient.shared. |
| ICXRLinkCbk | Android link callback: onCXRLConnected, onGlassBtConnected, etc. |
Scenes and sessions
| Term | Meaning |
|---|---|
| Scene building | The glasses side has reached the working state required by the current business flow: the Custom View is opened and displayed; or the Custom App has been launched via openApp, etc. Photo capture, audio, and custom commands all require scene building to be completed; you must not assume they are available immediately after connect succeeds on the phone. |
| Scene opened (Android Sample) | CustomView flow: customViewOpened == true (ICustomViewCbk.onCustomViewOpened). CustomApp flow: appOpened == true (maintained by IGlassAppCbk and onGlassAppResume, etc.). |
Session types
| Term | Android enum | Notes |
|---|---|---|
| CustomView session | CxrDefs.CXRSessionType.CUSTOMVIEW | Used for delivering/updating Custom View JSON; does not carry the target glasses-side package name. |
| CustomApp session | CxrDefs.CXRSessionType.CUSTOMAPP | Used for glasses-side APK installation, launch, stop, uninstall, etc.; requires configuring the target packageName. |
On iOS, equivalent business scenarios are typically distinguished by initialization mode (e.g., customView / customApp). Follow RGCxrClient initialization options.
Capability abbreviations
| Abbrev | Capability |
|---|---|
| CustomView | Glasses-side custom UI (JSON layout + icon assets). |
| CustomApp | Remote control for a glasses-side Android app. |
| CustomCMD / Custom Command | Custom binary messages between phone and the glasses app (Android uses Caps + sendCustomCmd). |
| Audio | Audio stream capture (Android: startAudioStream / stopAudioStream). |
| Photo | Remote photo capture and image callback (Android: takePhoto + image callback). |
Caps (Android)
com.rokid.cxr.Caps: used to serialize custom command payloads and work together with sendCustomCmd.