快速入门

更新时间：2026-01-08 15:38:20

产品入门

建议您快速了解下产品相关的信息，包括产品介绍、产品架构和产品计费，需要关注基本概念尤其是物模型和全球化部署

产品模块和核心交互

目前产品组成模块情况如上图所示：

1. RTCX端到端能力闭环模块包括：

   • RTCX控制台
   • XsDemoApp
   • 客户端SDK：
     • AppSDK包括Android AppSDK，iOS AppSDK，HarmonyOS AppSDK
     • Windows PCSDK
     • WebSDK
   • RTCX云平台，支持云端API接口，国内和海外是两套完全隔离的环境。
   • RTCX DeviceSDK，包含相应的Demo程序

2. 客户模块包括客户自有客户端、客户云平台和客户设备端。

产品模块说明

• RTCX控制台入门参考：控制台入门概述。控制台账号与XsDemoApp的账号独立，产品模块图中标号【1】和【2】
• XsDemoApp使用文档参考：XsDemoApp操作指南，以Android为例，iOS类似。
• Android AppSDK接入参考：Android AppSDK。支持国内主流手机厂商的官方消息提送，参考：配置消息通道
• iOS AppSDK接入参考：iOS AppSDK，支持iOS P8推送凭证配置，类Android。
• HarmonyOS AppSDK接入参考：HarmonyOS AppSDK。
• Windows PCSDK接入参考：Windows PCDK，暂仅支持Windows PC客户端接入。
• WebSDK接入参考：WebSDK。支持降级播放等。
• RTCX云平台与客户云平台相互调用。其中客户云平台调用RTCX云平台需要客户开发。
  产品模块图中标号【3】，包括两大部分内容：
  1. RTCX云平台调用客户云平台（HTTPS）：
     • 支持调用客户自有账号体系，支持authCode换取access_token和通过access_token获取用户个人信息，参考：控制台账号体系和用户账号开发指南
  2. 客户云平台调用RTCX云平台（即RTCX云端API接口）：
     • 支持云端绑定和解绑。参考：设备绑定开发指南和绑定设备、解绑设备
     • 支持查询云存储套餐、购买套餐、立即生效、查询购买订单列表和详情、套餐转移、设置套餐状态等。参考：云存储开发指南和视频服务云存储购买
     • 支持设备分享和取消分享。参考接口：设备分享和取消分享
     • 支持物的模型调用。参考接口：获取物的属性，设置物的属性和触发物的服务
     • 支持场景功能
• 数据同步（消息网关）：
  • 支持消息同步，包括智能事件，自定义事件/属性/状态。详细参考：数据同步（消息网关）开发指南
    • 如果要获取带图片的消息中的图片，可以使用Android AppSDK和iOS AppSDK中的相关接口
• DeviceSDK接入参考：DeviceSDK

设备快速开发说明*

信息

1. 使用DemoApp进行已接入DeviceSDK设备的功能验证，无需客户自有客户端。即所谓的快速开发模式
2. 如果是其他客户授权的产品开发，则需要授权方提供产品对应App的ak/sk二维码截图，方便DemoApp扫码绑定
3. 针对授权产品，也可以先在自己账户下创建产品，调试通过后，通过物模型导出/导入功能迁移到授权产品中
4. 如果您的产品需要海外出货，建议前期在国内开发，相对体验更优，调试通过后，通过产品复制功能迁移到海外

1. 通过控制台先注册账号，然后登录控制台，完成企业认证。建议使用子账号，并根据角色设置对应的权限。
2. 根据需要开发的产品品类，创建产品。同时创建App，并关联产品
3. 配置产品物模型信息，平台已内置针对不同产品类型的标准物模型，不满足，可扩展。
4. 微信、钉钉或飞书对接群，提供编译链，获取到对应的DeviceSDK（同步提供DeviceSDK Demo，供前期体验）
5. 固件整合DeviceSDK，进行设备功能开发调试，比如：视频直播，以及其他按钮功能等
6. 下载Android XsDemoApp或在对接群中咨询下载地址。注意：DemoApp版本与DeviceSDK版本的兼容性
7. XsDemoApp支持应用切换，也就是支持填入不同的Ak/Sk
8. 选择XsDemoApp的内置账号体系登录XsDemoApp
9. 通过XsDemoApp扫码添加测试设备，完成设备添加，获取到设备列表
10. 进入单设备播放页，来开发调试设备功能，这些功能与物模型息息相关
11. 视频录制和回放需先开通云套餐，前期为了测试验证，可以对接群里申请手动开通

云端对接快速开发说明

1. 在完成设备快速开发体验后，建议云端对接尽快开展起来。
2. 建议优先完成自有账号体系、云端设备绑定和套餐对接，以便客户端逻辑闭环
3. 云端对接参考：云端API
4. 进阶参考：推荐对接方案

自有App快速开发说明

信息

1. 自有App开发，建议待设备大部分功能开发完成后进行
2. 如果产品授权三方开发，则要在控制台创建App（可以是临时App，注意账号体系配置），并做App与产品的关联
3. 如果您的产品全球出货，注意海外App需要通过AppSDK选择并设置国家，参考全球化部署
4. 如果您的产品全球出货，注意海外的账号接入，服务器端实现参考自有账号全球用户接入

1. 参考设备快速开发说明，确保设备功能已经通过XsDemoApp调试通过
2. 在控制台的App中新建App或复用已设置的App，获取对应客户端所需的Ak/Sk
3. 设置App信息，点击单个App的配置按钮，关联产品，设置账号体系和设置推送凭证（可选）
4. 从App管理之AppSDK中下载所需的AppSDK
5. 按照Android AppSDK的对接文档来进行自有Android App的开发
6. 按照iOS AppSDK的对接文档来进行自有iOS App的开发
7. 按照HarmonyOS AppSDK的对接文档来进行自有HarmonyOS App的开发

实际对接建议

1. 实际对接建议参考：推荐对接方案，尤其是针对海外出货

版本发布记录和说明

1. 版本发布记录和说明

下载链接汇总*

1. Android/iOS/HarmonyOS AppSDK
2. Android DemoApp
3. iOS DemoApp（见注意说明）
4. HarmonyOS DemoApp（暂仅支持单独提供，对接群里咨询）
5. DeviceSDK&Demo（一般是群里提供，另Demo包含在DeviceSDK中）
6. Android DeviceSDK&Demo（对接群里咨询）
7. PCSDK&Demo
8. WebSDK&Demo（Demo包含在WebSDK中）
9. 消息网关PulsarJavaSDK

开发指南或最佳实践*

1. 用户账号开发指南
2. 云存储和套餐开发指南
3. 设备绑定开发指南
4. 数据同步（消息网关）开发指南
5. 套餐、录制、事件和消息
6. 全球化部署
7. 专属版私有化部署
8. 局域网通信模式
9. 端到端通信说明
10. 亚马逊Alexa技能接入指南
11. Google Home技能接入指南
12. 追踪特写和iOS画中画
13. 音视频协议和格式支持说明