配置管理 API
SDK 配置读取和运行时更新。
API 参考
getConfig()
获取当前完整配置快照(只读)。
返回值: Readonly<ClassroomConfig>
示例:
ts
const config = classroom.getConfig();
console.log(config.language, config.board?.domId);setConfig()
运行时部分更新配置(只传需要修改的字段,其余字段保持不变)。
更新后自动同步到 classroom.state.config$,所有订阅方立即收到通知。
env 字段在 init() 后不可再更改。 env cannot be changed after init() has been called.
| 参数 | 类型 | 说明 |
|---|---|---|
| partial | Partial<ClassroomConfig> | 要更新的配置字段(深度合并,未指定字段保持不变) |
返回值: void
示例:
ts
classroom.setConfig({ language: 'en' }); // 切换语言 / Switch language
classroom.setConfig({ debug: true }); // 开启调试 / Enable debug
classroom.setConfig({ board: { ratio: '4:3' } }); // 只改比例,不影响 domId 等其他字段
classroom.setConfig({ behavior: { autoMuteMicWhenBoardMedia: true } });