Skip to content

Commit

Permalink
enhance
Browse files Browse the repository at this point in the history
  • Loading branch information
@pmmgithub
pmmgithub committed Apr 13, 2023
1 parent 0dfc5d5 commit 49a3122
Show file tree
Hide file tree
Showing 19 changed files with 102 additions and 93 deletions.
2 changes: 1 addition & 1 deletion ...Flexible-Classroom/api_ref/classroom_api_ref/agora_class_sdk_api_ref_android.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ class AgoraEduLaunchConfig(val userName: String,
| `roomUuid` | 课堂 ID。这是课堂的全局唯一标识。长度在 64 字节以内。以下为支持的字符集范围（共 89 个字符）:<ul><li>26 个小写英文字母 a-z</li><li>26 个大写英文字母 A-Z</li><li>10 个数字</li><li>0-9</li><li>空格</li><li>"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "\_", " {", "}", "\|", "~", ","</li></ul> |
| `roleType` | 用户在课堂中的角色，详见 [AgoraEduRoleType](#agoraeduroletype)。 |
| `roomType` | 课堂类型，详见 [AgoraEduRoomType](#agoraeduroomtype)。 |
| `rtmToken` | 用于鉴权的 RTM Token，详见[使用 AccessToken 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_server_rtm)。 |
| `rtmToken` | 用于鉴权的 RTM Token，详见[使用 AccessToken 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_upgrade_rtm)。 |
| `startTime` | 课堂开始时间，单位为毫秒，以第一个进入课堂的用户传入的参数为准。 |
| `duration` | 课堂持续时间，单位为秒，以第一个进入课堂的用户传入的参数为准。 |
| `region` | 区域。建议设置为靠近你的课件或录制文件对象存储服务所在的区域，因为跨区域传输较大的静态资源会造成比较大的延迟。举例来说，如果你的 S3 服务在北美，则建议将 `region` 也设为北美区域。所有灵动课堂客户端必须设置相同的区域，否则无法互通。支持的区域详见 [AgoraEduRegion](#agoraeduregion)。 |
Expand Down
2 changes: 1 addition & 1 deletion ...own/Flexible-Classroom/api_ref/classroom_api_ref/agora_class_sdk_api_ref_ios.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Classroom SDK 退出回调。
| `roomName` | 课堂名，String 型。用于课堂内显示，长度在 64 字节以内。 |
| `roomUuid` | 课堂 ID，String 型。这是课堂的全局唯一标识。长度在 64 字节以内。以下为支持的字符集范围（共 89 个字符）:<li>26 个小写英文字母 a-z<li>26 个大写英文字母 A-Z<li>10 个数字 <li>0-9<li>空格<li>"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "\_", " {", "}", "\|", "~", "," |
| `roomType` | 课堂类型，详见 [AgoraEduRoomType](#agoraeduroomtype)。 |
| `token` | 用于鉴权的 RTM Token，String 型，详见[使用 AccessToken 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_server_rtm)。 |
| `token` | 用于鉴权的 RTM Token，String 型，详见[使用 AccessToken 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_upgrade_rtm)。 |
| `appId` |声网 App ID，String 型。 |
| `startTime` | 课堂开始时间，单位为毫秒，以第一个进入课堂的用户传入的参数为准。 |
| `duration` | 课堂持续时间，单位为秒，以第一个进入课堂的用户传入的参数为准。 |
Expand Down
2 changes: 1 addition & 1 deletion ...own/Flexible-Classroom/api_ref/classroom_api_ref/agora_class_sdk_api_ref_web.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ export type LaunchOption = {

| 参数 | 描述 |
| :----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `rtmToken` | （必填）用于鉴权的 RTM Token。详见[使用 RTM Token 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_server_rtm?platform=All%20Platforms)。 |
| `rtmToken` | （必填）用于鉴权的 RTM Token。详见[使用 RTM Token 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_upgrade_rtm?platform=All%20Platforms)。 |
| `userUuid` | （必填）用户 ID。这是用户的全局唯一标识，**需要与你生成 RTM Token 时使用的 UID 一致**。长度在 64 字节以内。~d6d26ba0-cf5b-11eb-9521-2d3265d0c546~ |
| `userName` | （必填）用户名，用于课堂内显示，长度在 64 字节以内。 |
| `roomUuid` | （必填）课堂 ID。这是课堂的全局唯一标识。长度在 64 字节以内。~d6d26ba0-cf5b-11eb-9521-2d3265d0c546~ |
Expand Down
2 changes: 1 addition & 1 deletion markdown/Flexible-Classroom/api_ref/proctor_api_ref/agora_class_proctor_api_ios.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@
| `roomName` | 课堂名。用于课堂内显示，长度在 64 字节以内。 |
| `roomUuid` | 课堂 ID。这是课堂的全局唯一标识。长度在 64 字节以内。以下为支持的字符集范围（共 89 个字符）:<ul><li>26 个小写英文字母 a-z</li><li>26 个大写英文字母 A-Z</li><li>10 个数字</li><li>0-9</li><li>空格</li><li>"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "\_", " {", "}", "\|", "~", ","</li></ul> |
| `appId` |声网 App ID。|
| `token` | 用于鉴权的 Token。 详见[使用 RTM Token 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_server_rtm?platform=All%20Platforms)。 |
| `token` | 用于鉴权的 Token。 详见[使用 RTM Token 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_upgrade_rtm?platform=All%20Platforms)。 |
| `region` | 区域，默认值为 `CN`，即中国大陆。建议设置为靠近你的课件或录制文件对象存储服务所在的区域，因为跨区域传输较大的静态资源会造成比较大的延迟。举例来说，如果你的 S3 服务在北美，则建议将 `region` 也设为北美区域。所有灵动课堂客户端必须设置相同的区域，否则无法互通。支持的区域详见 [AgoraProctorRegion](#agoraproctorregion)。 |
| `mediaOptions` | （选填）媒体流相关设置，包含媒体流加密，详见 [AgoraProctorMediaOptions](#agoraproctormediaoptions)。 |
| `userProperties` | （选填）由开发者自定义的用户属性，会传入 [`AgoraEduUserContext`](./API%20Reference/edu_context_swift/API/edu_context_api_overview.html#api-title__user_context) 的 `userProperties`，详见[如何设置自定义用户属性](faq/agora_class_custom_properties)。 |
Expand Down
2 changes: 1 addition & 1 deletion markdown/Flexible-Classroom/api_ref/proctor_api_ref/agora_class_proctor_api_web.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export type LaunchOption = {
| `roomName` | （必填）课堂名，用于课堂内显示，长度在 64 字节以内。 |
| `listener` | （必填）课堂启动状态：<li>`ready`: 课堂准备完毕。</li><li>`destroyed`: 课堂已销毁。</li> |
| `pretest` | （必填）是否开启课前设备检测：<li>`true`: 开启课前设备检测。开启后，在加入课堂前会弹出设备检测页面，测试终端用户的摄像头、麦克风和扬声器是否能正常工作。</li><li>`false`: 不开启课前设备检测。</li> |
| `rtmToken` | （必填）用于鉴权的 RTM Token。详见[使用 RTM Token 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_server_rtm?platform=All%20Platforms)。 |
| `rtmToken` | （必填）用于鉴权的 RTM Token。详见[使用 RTM Token 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_upgrade_rtm?platform=All%20Platforms)。 |
| `language` | （必填）课堂界面的语言，详见 [LanguageEnum](#languageenum)。 |
| `startTime` | （选填）课堂开始时间（毫秒），以第一个进入课堂的用户传入的参数为准。 |
| `duration` | （必填）课堂持续时间（秒），以第一个进入课堂的用户传入的参数为准。最大值为 86,400 秒，建议根据课堂实际时长设置。 |
Expand Down
8 changes: 4 additions & 4 deletions markdown/Flexible-Classroom/api_ref/restful_api_ref/agora_class_restful_api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

所有请求都发送给域名：api.agora.io。

为保障 REST 服务的高可用，避免因区域网络故障造成的服务不可用，声网提供切换域名的方案，详情请参考[切换域名](/cn/Real-time-Messaging/rtm_integration_bp?platform=RESTful#切换域名)
为保障 REST 服务的高可用，避免因区域网络故障造成的服务不可用，声网提供切换域名的方案，详情请参考[切换域名](/cn/Real-time-Messaging/rtm_integration_bp?platform=RESTful#切换域名)。

### 数据格式

Expand All @@ -20,7 +20,7 @@
- 服务端生成的 RTM Token。
- 生成 RTM Token 时使用的 uid。

具体生成 RTM Token 的方法请参考[生成 RTM Token](/cn/Real-time-Messaging/token_server_rtm) 文档。
具体生成 RTM Token 的方法请参考[生成 RTM Token](/cn/Real-time-Messaging/token_upgrade_rtm) 文档。

### 区域

Expand Down Expand Up @@ -127,7 +127,7 @@
| `roomProperties.schedule` | Object | 非必填 | 课程计划，包含开始时间，持续时长，拖堂时长等属性。 |
| `roomProperties.schedule.startTime` | Integer | 非必填 | 课堂开始时间戳，单位为毫秒。该字段不可更新。 |
| `roomProperties.schedule.duration` | Integer | 非必填 | 课堂持续时长，单位为秒。如果你设置了课堂持续时长和拖堂时长，当开启录制时，会按照二者之和向上取整设置最长录制时间 `maxRecordingHour` 参数。详见[设置录制状态](#设置录制状态)的 `maxRecordingHour` 参数说明。 |
| `roomProperties.schedule.closeDelay` | Integer | 非必填 | 拖堂时长，单位为秒。当课堂持续时长结束后，课程会进入“关闭”状态（`state`= 2，即拖堂状态），此时用户仍可以正常进入和逗留在教室。当拖堂时间结束时，课堂会关闭，并踢出所有用户。 |
| `roomProperties.schedule.closeDelay` | Integer | 非必填 | 拖堂时长，单位为秒。当课堂持续时长结束后，课程会进入“结束”状态（`state`= 2），此时用户仍可以正常进入和逗留在教室。当拖堂时间结束时，课堂会进入“关闭”状态（`state`= 3），并踢出所有用户。 |
| `roomProperties.processes` | Object | 非必填 | 申请邀请流程，包含举手等功能。 |
| `roomProperties.processes.handsUp` | Object | 非必填 | 上台设置，包含上台人数上限等。 |
| `roomProperties.processes.handsUp.maxAccept` | Integer | 非必填 | 上台人数上限。 |
Expand Down Expand Up @@ -644,7 +644,7 @@ curl -X DELETE 'https://api.agora.io/{region}/edu/apps/{yourAppId}/v2/rooms/test

| 参数 | 类型 | 是否必填 | 描述 |
| :------ | :----- | :----- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dirty` | Object | 非必填 | 用户踢人标记，包含以下字段：<ul><li>`state`: Integer 型，踢人状态：<ul><li>`1`: 被踢，无法进入课堂。</li><li> `0`: 未被踢，可以进入课堂。</li></ul><li>`duration`: Number 型，临时踢人持续时间，单位为秒，从被踢出时开始计时。当被踢持续时长结束后，用户自动恢复为未被踢状态。若不传该参数，则用户被永久踢出。</li></ul> |
| `dirty` | Object | 非必填 | 用户踢人标记，包含以下字段：<ul><li>`state`: Integer 型，踢人状态：<ul><li>`1`: 被踢，无法进入课堂。</li><li> `0`: 未被踢，可以进入课堂。</li></ul><li>`duration`: Number 型，临时踢人持续时间，单位为秒。该字段仅在 `state` 为 `1` 时生效。从被踢出时开始计时，过了 `duration` 设置的时长后，用户自动恢复为未被踢状态。若不传该参数，则用户被永久踢出。</li></ul> |

#### 请求示例

Expand Down
2 changes: 1 addition & 1 deletion markdown/Flexible-Classroom/faq/agora_class_errors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Error running install script for optional dependency: "/root/flexible-classroom-

`600001-1` 和 `401` 错误一般是因为 [`launch`](agora_class_api_ref_web?platform=Web#launch) 方法传入的 RTM Token 错误，或者 RTM Token 和 App ID 不匹配。请检查 RTM Token 是否正确，以及保证 App ID 和 RTM Token 匹配。

声网推荐你在后端生成 RTM Token，前端调用生成的 token，详情参考[使用 AccessToken2 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token2_server_rtm)。
声网推荐你在后端生成 RTM Token，前端调用生成的 token，详情参考[使用 AccessToken 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_upgrade_rtm)。

如果需要临时生成 token 测试，可以使用这个[工具](https://webdemo.agora.io/token-builder/)。

Expand Down
2 changes: 1 addition & 1 deletion markdown/Flexible-Classroom/faq/agora_class_launch_errors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<img src="./images/launch_rtm_token.png" style="zoom: 33%;" />

声网推荐你在后端生成 RTM Token，前端调用生成的 token，详情参考[使用 AccessToken2 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token2_server_rtm)。
声网推荐你在后端生成 RTM Token，前端调用生成的 token，详情参考[使用 AccessToken2 鉴权](https://docs.agora.io/cn/Real-time-Messaging/token_upgrade_rtm)。

如果需要临时生成 token 测试，可以使用这个[工具](https://webdemo.agora.io/token-builder/)。

Expand Down
Loading

0 comments on commit 49a3122

Please sign in to comment.