灵动课堂事件枚举

概述

本页列出通过灵动课堂 RESTful API 查询所有课堂事件获取到的所有事件类型。

课堂状态变更

cmd 为 1 时，该事件提示课堂状态发生变更，data 中包含以下字段：

参数	类型	描述
startTime	Number	课堂开始时间，Unix 时间戳（毫秒），UTC 时间。课堂开始后此字段有值。
state	Integer	当前课堂状态： 0: 未开始。 1: 进行中。 2: 已结束。 3: 拖堂时间结束，房间关闭，用户无法再进入。

示例

{
    "startTime":1611561776588,
    "state":1
}

课堂聊天消息

cmd 为 3 时，该事件提示收到课堂聊天消息，data 中包含以下字段：

参数	类型	描述
fromUser	Object	发送该消息的用户，包含以下字段： userUuid: String 型，用户 uuid。 userName: String 型，用户名称。 role: Integer 型，用户在课堂中的角色： 1: 老师 2: 学生
message	String	消息内容。
type	Integer	消息类型，当前只支持 1，表示文本消息。

示例

{
    "fromUser":{
        "role":"host",
        "userName":"jason",
        "userUuid":"jason1"
    },
    "message":"aa",
    "type":1
}

用户进出课堂

cmd 为 20 时，该事件提示有用户进出课堂。data 中包含以下字段：

参数	类型	描述
total	Integer	进入和退出课堂的用户总数。
onlineUsers	Object 数组	进入课堂的用户，包含以下字段： userName: String 型，用户名称。 userUuid: String 型，用户 uuid。 role: Integer 型，用户在课堂中的角色： 1: 老师 2: 学生 userProperties: Object 型，用户属性。 streamUuid: String 型，用户流的 uuid，也是加入 RTC 频道时用的 UID。 type: Integer 型，用户进入类型： 1: 正常进入 2: 重连 updateTime: Number 型，用户进入课堂时的 Unix 时间戳，单位为毫秒，UTC 时间。
offlineUsers	Object 数组	退出课堂的用户，包含以下字段： userName: String 型，用户名称。 userUuid: String 型，用户 uuid。 role: Integer 型，用户在课堂中的角色： 1: 老师 2: 学生 userProperties: Object 型，用户属性。 streamUuid: String 型，用户流的 uuid，也是加入 RTC 频道时用的 UID。 type: Integer 型，用户退出类型： 1: 由于客户端原因退出课堂，例如正常离开课堂、应用被强制关闭或由于网络状况不佳而断线。 2: 被踢出课堂。 updateTime: Number 型，用户退出课堂时的 Unix 时间戳，单位为毫秒，UTC 时间。

示例

{
    "total":3,
    "onlineUsers":[
        {
            "userName":"",
            "userUuid":"",
            "role":"0",
            "userProperties":{  },
            "streamUuid":"",
            "type":1,
            "updateTime":1611561776588
        }
    ],
    "offlineUsers":[
        {
            "userName":"",
            "userUuid":"",
            "role":"0",
            "userProperties":{},
            "streamUuid":"",
            "type":1,
            "updateTime":1611561776588
        }
    ]
}

录制状态变更

cmd 为 1001 时，该事件提示录制状态发生变更，data 中包含以下字段：

参数	类型	描述
recordId	String	一次录制的的唯一标识符。调用设置录制状态 API 开始录制然后结束录制视为一次录制。仅当 state 为 1 时有此字段。
sid	String	声网云端录制服务的 sid。仅当 state 为 1 时有此字段。
resourceId	String	声网云端录制服务的 resourceId。仅当 state 为 1 时有此字段。
state	Integer	当前录制状态： 0: 录制已结束 1: 录制中
startTime	Number	录制开始时间，Unix 时间戳（毫秒），UTC 时间。录制开始后此字段有值。
streamingUrl	Object	经由页面录制后推到 CDN 的流地址。学生可以通过该地址观看教学。

示例

{
    "recordId":"xxx",
    "sid":"xxx",
    "resourceId":"xxx",
    "state":1,
    "startTime":1611564500488,
    "streamingUrl": {
            "rtmp": "",
            "flv": "",
            "hls": ""
        }
}

奖励数量变更

cmd 为 1101 时，该事件提示奖励数量发生变更，data 中包含以下字段：

参数	类型	描述
rewardDetails	Object 数组	一个 Object 代表一个用户的奖励数量变更情况，包含以下字段： userUuid: String 型，用户 uuid。 changedReward: Integer 型，发生变更的奖励个数。 totalReward: Integer 型，变更后用户的奖励总数。
updateTime	Number	奖励变更时间，Unix 时间戳（毫秒），UTC 时间。

示例：

{
     "rewardDetails":[ {
            "userUuid":"",
            "changedReward": 1,
            "totalReward": 10
        } ],
       "updateTime":1611564500488
}

云盘资源变更

cmd 为 1003 时，该事件提示云盘资源发生变更，data 中包含以下字段：

参数	类型	描述
resources	Object 数组	资源变更情况，一个 Object 代表一个资源的变更情况，包含以下字段： resourceUuid: String 型，资源 uuid。 resourceName: String 型，资源名称。 size: Number 型，资源大小，单位为字节。 url: String 型，资源的访问地址。 taskUuid: String 型，文件转换任务的 uuid。 taskToken: String 型，文件转换任务使用的 Token。 taskProgress: Object 型，文件转换任务进度。
operator	Object	操作人，包含以下字段： userUuid: String 型，用户 uuid。 userName: String 型，用户名称。 role: Integer 型，用户角色。
action	Integer	资源变更类型： 1: 资源新增或更新。 2: 资源被删除。

示例：

{
     "resources": [{
            "resourceUuid":"",
            "resourceName": "1",
            "size": 1024,
            "url": "http://xxx.com/ooo",
            "taskUuid": "",
            "taskToken": "",
            "taskProgress": {},
        } ],
      "operator":{
        "role":"1",
        "userName":"jason",
        "userUuid":"jason1"
        },
       "action": 1
}

讲台人员变更

cmd 为 1501 时，该事件提示讲台人员发生变化，data 中包含以下字段：

参数	类型	描述
acceptedUsers	Object 数组	当前台上人员列表，包含以下字段： userUuid: String 型，用户 uuid。
addAcceptedUsers	Object 数组	本次上台人员列表，包含以下字段： userUuid: String 型，用户 uuid。
removeAcceptedUsers	Object 数组	本次下台人员列表，包含以下字段： userUuid: String 型，用户 uuid。

示例：

{
    "acceptedUsers": [{
        "userUuid":""
    }],
    "addAcceptedUsers": [{
        "userUuid":""
    }],
    "removeAcceptedUsers": [{
        "userUuid":""
    }]
}

挥手人员变更

cmd 为 1502 时，该事件提示挥手人员发生变更，data 中包含以下字段：

参数	类型	描述
progressUsers	Object 数组	当前举手人员列表，包含以下字段： userUuid: String 型，用户 uuid。 payload: Object 型。
addProgressUsers	Object 数组	本次新增举手人员列表，包含以下字段： userUuid: String 型，用户 uuid。 payload: Object 型，扩展信息。
removeProgressUsers	Object 数组	本次移除举手人员列表，包含以下字段： userUuid: String 型，用户 uuid。 payload: Object 型，扩展信息。

示例：

{
    "progressUsers": [{
        "userUuid":"",
        "payload":{}
    }],
    "addProgressUsers": [{
        "userUuid":"",
        "payload": {}
    }],
    "removeProgressUsers": [{
        "userUuid":"",
        "payload": {}
    }]
}