Appearance
connect
最后更新时间 2026-04-17
connect(options) 用于建立 RTC 连接并返回当前 RTC 会话状态。
- 接口标识:
rtc.connect - 请求类型:
RtcConnectRequest - 当前状态:可接入
该接口预期用于音视频或实时通话场景的连接建立,但当前仍处于文档冻结阶段,尚未纳入正式可接入范围。
注意事项
- 该接口当前为规划中能力,业务方不应在生产环境中直接依赖。
- 未来开放时,还会补充更多房间、媒体、设备和信令前置条件说明。
- 当前实现阶段为 浅实现,当前可接入状态为 可接入。
- 当前方法已出现在 public API registry 中,但当前仍未纳入
release/phase0正式发布承诺。
支持说明
该接口当前仅用于冻结 RTC 连接能力语义。
| 应用能力 | Android | iOS | Harmony | PC | 发布状态 |
|---|---|---|---|---|---|
| SDK Wrapper | 未发布 | 未发布 | 未发布 | 未发布 | 未纳入 release/phase0 |
发布基线:
- android: Android 8.0+ (API 26)
- ios: iOS 15+
- harmony: HarmonyOS NEXT API 12+
- pc: Host OS with supported native bridge runtime
输入
该接口接收 RtcConnectRequest 请求对象,字段定义如下。
| 名称 | 数据类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
room_id | String | 是 | - | 待连接的 RTC 房间标识。 |
说明
请求对象由业务方传入,用于触发上层 SDK API 调用。平台 wrapper 可以按各自语言习惯封装参数对象,但字段语义必须与 RtcConnectRequest 保持一致。
输出
该接口成功后返回 RtcConnectResponse 业务结果,字段定义如下。
| 名称 | 数据类型 | 描述 |
|---|---|---|
connection_state | unknown | RTC 连接状态;当前方法仍处于 documented-only 状态。 |
状态与前置条件
- 调用前置条件:
runtime.bootstrap、auth.login - 当前 SDK 状态要求:当前能力未正式开放。
- 调用成功后状态:暂无正式状态流转定义。
示例代码
平台调用示例
| 平台 | 正式入口 | 绑定方式 | 错误返回方式 |
|---|---|---|---|
| Android | com.robin.sdk.RobinSdk | kotlin-java-facade | result-error-object |
| iOS | RobinSdk | swift-facade | throws-result-enum |
| Harmony | RobinSdk | arkts-js-facade | result-code-object |
| PC | robin_sdk_bridge | native-bridge-facade | bridge-error-code |
说明
当前仓库尚未提供该方法的真实平台 facade 调用代码片段。你可以先根据以下真实入口信息接入平台 wrapper;后续如补充 docs/examples/<platform>/rtc-connect.*,页面会自动渲染对应平台示例。
错误码
| 错误码 | 描述 | 排查建议 |
|---|---|---|
action_not_enabled | 当前接口能力未开放,或当前发布范围不支持该调用。 | 检查接口是否已纳入当前发布范围,并确认目标平台已支持该能力。 |