CXR-L(EN)
CXR-L(EN)
IntroductionQuick StartDevelopment Flow & State-MachineTerms and Abbreviations
Feature Development
Version HistoryAndroid
iOS
cxr-l-sdk · v1.0.3 · snapshot 2026-06-02· ↗ source
Terms and Abbreviations
Terms and Abbreviations
Platforms and products
| Term | Meaning |
|---|---|
| Rokid AI App | Required app (mainland); package com.rokid.sprite.aiapp; requires ≥ 1.7.14 when using client-l:1.0.3 |
| Hi Rokid | Required app (overseas) |
| Glasses | Rokid glasses device |
| CXR-L SDK | Android: com.rokid.cxr:client-l:1.0.3; iOS: CocoaPods RGCxrClient (v1.0.1) |
| CXR-S SDK | Glasses-side Android SDK, paired with CXR-L; Maven artifact cxr-service-bridge; see the SDK Integration (glasses-side) chapter |
| CXRServiceBridge | Glasses CXR-S bridge entry, com.rokid.cxr.CXRServiceBridge; subscribe / sendMessage pair with phone sendCustomCmd / ICustomCmdCbk |
| cxr-service-bridge | Maven coordinate prefix for CXR-S, e.g. com.rokid.cxr:cxr-service-bridge (version per Sample / release notes) |
Authentication and connection
| Term | Meaning |
|---|---|
| token | Auth token for CXRLink.connect(token) |
| CXRLink | Android SDK entry, com.rokid.cxr.link.CXRLink |
| CxrClient | iOS SDK entry, CxrClient.shared |
| ICXRLinkCbk | Android link callbacks |
Scenes and sessions
| Term | Meaning |
|---|---|
| Scene building | Glasses in working state: Custom View opened or Custom App running |
| Link ready | Transport available: onCXRLConnected; CustomApp also needs Bluetooth |
| Scene ready | CustomView: onCustomViewOpened; CustomApp: app opened on glasses |
Session types
| Term | Android enum | Notes |
|---|---|---|
| CustomView session | CxrDefs.CXRSessionType.CUSTOMVIEW | JSON layout delivery |
| CustomApp session | CxrDefs.CXRSessionType.CUSTOMAPP | Remote APK control; requires packageName |
iOS uses initialization modes (customView / customApp) — see RGCxrClient.
Capability abbreviations
| Abbrev | Capability |
|---|---|
| CustomView | Glasses custom UI (JSON + Base64 icons) |
| CustomApp | Remote glasses Android app control |
| CustomCMD | Binary messages via Caps + sendCustomCmd |
| Audio | startAudioStream / stopAudioStream |
| Photo | takePhoto + image callback |
Caps (Android)
com.rokid.cxr.Caps — serializes custom command payloads.
CustomView JSON terms
| Term | Meaning |
|---|---|
| View tree | Recursive JSON for customViewOpen: type + props + children |
| props.id | Unique node id for customViewUpdate |
| Icon name | Key linking customViewSetIcons and ImageView.props.name |