文档中心
灵动课堂
API 参考
RoomStore | agora classroom sdk
Edu Store API Reference for Web/Electron
Properties
Protected Readonly classroomStore
clockTime
clockTime: number
Protected Readonly logger
logger: Logger
Accessors
clientServerTimeShift
- get clientServerTimeShift(): number
flexProps
- get flexProps(): Record<string, any>
Returns Record<string, any>
isOnPodium
- get isOnPodium(): boolean
recordReady
- get recordReady(): boolean
screenShareStreamUuid
- get screenShareStreamUuid(): undefined | string
Returns undefined | string
screenShareUserUuid
- get screenShareUserUuid(): undefined | string
Returns undefined | string
Methods
sendRewards
- sendRewards(rewards: { changeReward: number; userUuid: string }[], isBatch?: boolean): Promise<void>
Parameters
rewards: { changeReward: number; userUuid: string }[]
Optional isBatch: boolean
Returns Promise<void>
startCarousel
- startCarousel(params: { interval: number; range: number; type: number }): Promise<void>
Parameters
params: { interval: number; range: number; type: number }
interval: number
range: number
type: number
Returns Promise<void>
stopCarousel
- stopCarousel(): Promise<void>
updateClassState
- updateClassState(state: ClassState): Promise<void>
Parameters
Returns Promise<void>
updateFlexProperties
- updateFlexProperties(properties: Record<string, any>, cause: any): Promise<void>
Parameters
properties: Record<string, any>
cause: any
Returns Promise<void>
updateHostingSceneProperties
- updateHostingSceneProperties(properties: HostingScene, cause: any): Promise<void>
Parameters
Returns Promise<void>
updateIncrementProperties
- updateIncrementProperties(increments: Record<string, number>, cause?: unknown, throttleTime?: number): Promise<void>
Parameters
increments: Record<string, number>
Optional cause: unknown
Optional throttleTime: number
Returns Promise<void>
RoomStore
类用于初始化教室和监听教室数据。 负责功能: 1.初始化教室 roomProperties 2.监听教室数据变更3.教室状态变更 4.轮播
9.聊天控制
10.销毁教室