Room Context

RoomContext 提供课堂管理相关能力。

joined

joined: boolean;

自 v1.1.5 起新增。

是否成功加入课堂。

startCarousel

startCarousel: ({
    range,
    type,
    interval,
}: {
    range: number;
    type: number;
    interval: number;
    }) => Promise<any>;

自 v1.1.5 起新增。

开启学生轮播功能。老师或助教开启此功能后，学生按照指定的时间间隔轮流上台。仅适用于在线互动小班课。如果教室内学生人数小于等于 6，调用该方法后，interval 后，全部学生都会上台但无法轮播。

参数	描述
range	自动上台的学生范围： 1: 课堂内全部学生。 2: 全部摄像头非禁用的学生。
type	学生上台顺序： 学生按照加入房间顺序轮流上台。 学生随机上台。
interval	学生上台的时间间隔。默认值为 60，单位为秒。取值范围为 10 到 99。

stopCarousel

stopCarousel: () => Promise<any>;

自 v1.1.5 起新增。

停止学生自动分批上台功能。

sceneType

sceneType: number,

课堂类型：

• 0: 1 对 1 在线互动教学。
• 2: 互动直播大班课。
• 4: 在线互动小班课。

destroyRoom

destroyRoom: () => Promise<void>,

销毁课堂。

joinRoom

joinRoom: () => Promise<void>,

加入课堂。

roomInfo

roomInfo: RoomInfo,

当前课堂信息。

isCourseStart

isCourseStart: boolean,

课堂是否开始。

kickOutBan

kickOutBan: (userUuid: string, roomUuid: string) => Promise<void>,

将学生踢出课堂并禁止学生再进入该课堂。

参数	描述
userUuid	学生 ID。
roomUuid	课堂 ID。

kickOutOnce

kickOutOnce: (userUuid: string, roomUuid: string) => Promise<void>,

将学生踢出课堂。后续学生还能够再进入课堂。

参数	描述
userUuid	学生 ID。
roomUuid	课堂 ID。

liveClassStatus

liveClassStatus: {
    classState: string;
    duration: number;
},

自 v1.1.5 起废弃。声网建议改用 LiveRoomStatsContext 中的 liveClassStatus。

当前课堂状态。

queryCameraDeviceState

queryCameraDeviceState: (userList: EduUser[], userUuid: string, streamUuid: string) => any;

自 v1.1.2 起新增。

查询摄像头状态。

queryMicrophoneDeviceState

queryMicrophoneDeviceState: (userList: EduUser[], userUuid: string, streamUuid: string) => any;

自 v1.1.2 起新增。

查询麦克风状态。

isJoiningRoom

isJoiningRoom: boolean,

自 v1.1.2 起新增。

是否正在加入课堂。

roomProperties

roomProperties: any,

自 v1.1.2 起新增。

获取全部课堂属性，包含灵动课堂内置的课堂属性和开发者自定义的课堂属性。

updateFlexRoomProperties

updateFlexRoomProperties: (properties: any, cause: any) => Promise<any>;

自 v1.1.2 起新增。

新增或更新自定义课堂属性。支持整体修改和根据路径查找并修改某个属性的值。

参数	描述
properties	课堂属性。
cause	更新原因。

flexRoomProperties

flexRoomProperties: any;

自 v1.1.2 起新增。

获取由开发者自定义的课堂属性。

startNativeScreenShareBy

startNativeScreenShareBy: (windowId: number) => Promise<void>,

自 v1.1.2 起废弃。声网建议使用 ScreenShareContext 中 startNativeScreenShareBy。

使用指定的窗口或屏幕 ID 进行屏幕共享。

参数	描述
windowId	窗口或屏幕 ID。

teacherAcceptHandsUp

teacherAcceptHandsUp: (userUuid: string) => Promise<void>,

自 v1.1.2 起废弃。声网建议改用 HandsUpContext 中的 teacherAcceptHandsUp。

老师接受学生举手请求。

参数	描述
userUuid	用户 ID。

teacherRejectHandsUp

teacherRejectHandsUp: (userUuid: string) => Promise<void>,

自 v1.1.2 起废弃。声网建议改用 HandsUpContext 中的 teacherRejectHandsUp。

老师拒绝学生举手请求。

参数	描述
userUuid	用户 ID。

handsUpStudentList

handsUpStudentList: any[],

自 v1.1.2 起废弃。声网建议改用 HandsUpContext 中的 handsUpStudentList。

举手学生列表。

handsUpState

handsUpStudentList: any[],

自 v1.1.2 起废弃。声网建议改用 HandsUpContext 中的 handsUpStudentList。

学生的举手状态。

processUserCount

processUserCount: number,

自 v1.1.2 起废弃。声网建议改用 HandsUpContext 中的 processUserCount。

申请上台的用户总数。

muteAudio

muteAudio: (userUuid: string, isLocal: boolean) => Promise<void>,

自 v1.1.2 起废弃。声网建议改用 StreamListContext 中的 muteAudio。

禁用指定用户的音频。

参数	描述
userUuid	用户 ID。
isLocal	是否为本地用户。

unmuteAudio

unmuteAudio: (userUuid: string, isLocal: boolean) => Promise<void>,

自 v1.1.2 起废弃。声网建议改用 StreamListContext 中的 unmuteAudio。

取消禁用指定用户的音频。

参数	描述
userUuid	用户 ID。
isLocal	是否为本地用户。

muteVideo

muteVideo: (userUuid: string, isLocal: boolean) => Promise<void>,

自 v1.1.2 起废弃。声网建议改用 StreamListContext 中的 muteVideo。

禁用指定用户的视频。

参数	描述
userUuid	用户 ID。
isLocal	是否为本地用户。

unmuteVideo

unmuteVideo: (userUuid: string, isLocal: boolean) => Promise<void>,

自 v1.1.2 起废弃。声网建议改用 StreamListContext 中的 unmuteVideo。

取消禁用指定用户的视频。

参数	描述
userUuid	用户 ID。
isLocal	是否为本地用户。