Configuration API

Reading and updating SDK configuration at runtime.

API Reference

getConfig()

Get a read-only snapshot of the current full configuration.

Returns: Readonly<ClassroomConfig>

Example:

const config = classroom.getConfig();
console.log(config.language, config.board?.domId);

---

setConfig()

Partially update configuration at runtime (only specify fields to change).

Changes are immediately reflected in classroom.state.config$ and all subscribers are notified.

env 字段在 init() 后不可再更改。 env cannot be changed after init() has been called.

Parameter	Type	Description
partial	Partial<ClassroomConfig>	要更新的配置字段（深度合并，未指定字段保持不变）

Returns: void

Example:

classroom.setConfig({ language: 'en' });                          // 切换语言 / Switch language
classroom.setConfig({ debug: true });                             // 开启调试 / Enable debug
classroom.setConfig({ board: { ratio: '4:3' } });                // 只改比例，不影响 domId 等其他字段
classroom.setConfig({ behavior: { autoMuteMicWhenBoardMedia: true } });

---