-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'flexible-classroom-2-9-400' of https://github.com/Agora…
…IO/Doc-Source-Private into staging
- Loading branch information
Showing
7 changed files
with
97 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -73,9 +73,10 @@ If you are satisfied with the default UI of Cloud Classroom and do not want to c | |
| 1. Add the following code to the HTML file in your project: | ||
|
|
||
| ```html | ||
| <!-- <!-- Please replace X.Y.Z with the cloud classroom version number, such as 1.0.10. | ||
| <!-- <!-- Please replace X.Y.Z with the cloud classroom version number, such as 1.0.40. | ||
| You can check the latest version number through the release notes or GitHub repository branch. --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected]"></script> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected]"></script> | ||
| ``` | ||
|
|
||
| 2. To launch a classroom, call [FcrUIScene.launch](../../client-api/ui-scene#launch). | ||
|
|
@@ -88,10 +89,10 @@ If you are satisfied with the default UI of Cloud Classroom and do not want to c | |
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <!-- Introduce SDK, 1.0.20 is the sample version number. You can check the latest version number through the release notes or GitHub repository branch. --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].20.bundle.js"></script> | ||
| <!-- Introduce Widget, 1.0.20 is the sample version number. You can check the latest version number through the release notes or GitHub warehouse branch --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].20.bundle.js"></script> | ||
| <!-- Introduce SDK, 1.0.40 is the sample version number. You can check the latest version number through the release notes or GitHub repository branch. --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].40.bundle.js"></script> | ||
| <!-- Introduce Widget, 1.0.40 is the sample version number. You can check the latest version number through the release notes or GitHub warehouse branch --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].40.bundle.js"></script> | ||
| </head> | ||
|
|
||
| <body> | ||
|
|
@@ -104,7 +105,7 @@ If you are satisfied with the default UI of Cloud Classroom and do not want to c | |
| <div id="root"></div> | ||
| <script type="text/javascript"> | ||
| // Start cloud classroom | ||
| FcrUIScene.launch(document.querySelector("#root"), { | ||
| const unmount = FcrUIScene.launch(document.querySelector("#root"), { | ||
| appId: "Your App ID", | ||
| region: "NA", | ||
| userUuid: "user id", | ||
|
|
@@ -135,6 +136,10 @@ If you are satisfied with the default UI of Cloud Classroom and do not want to c | |
|
|
||
| The sample code requires passing in `rtmToken`. You can refer to [Generate a <Vg k="MESS" /> token](../get-started/manage-agora-account#generate-an-rtm-token) to learn what a <Vg k="MESS" /> token is, how to get a temporary <Vg k="MESS" /> token for testing purposes, and how to generate a <Vg k="MESS" /> token from the server. The generated token passed in `userId` must be consistent with the `userUuid` parameters passed in the `launch` method; otherwise, the generated token will be invalid. | ||
|
|
||
| <Admonition type="info" title="Note"> | ||
| Calling `launch` returns `unmount`. When your App routing changes cause the unloading of a page, call `unmount` to disconnect the room and recycle resources. | ||
| </Admonition> | ||
|
|
||
| ### Customize the classroom UI | ||
|
|
||
| If you want to customize the classroom UI based on the default UI of Cloud Classroom, you need to integrate by downloading the source code on GitHub. Refer to the following steps: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -67,10 +67,10 @@ To integrate the whole <Vg k="FC"/> through CDN if you're satisfied with the def | |
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <!-- Introduce the SDK, 2.9.20 is the sample version number, you can check the latest version number through the release notes or GitHub warehouse branch --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].20.bundle.js"></script> | ||
| <!-- Introducing Widget, 2.9.20 is the sample version number. You can check the latest version number through the release notes or GitHub warehouse branch. (Widgets before 2.9.20 are packaged together with the SDK, and there is no need to introduce this library) --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].20.bundle.js"></script> | ||
| <!-- Introduce the SDK, 2.9.40 is the sample version number, you can check the latest version number through the release notes or GitHub warehouse branch --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].40.bundle.js"></script> | ||
| <!-- Introducing Widget, 2.9.40 is the sample version number. You can check the latest version number through the release notes or GitHub warehouse branch. (Widgets before 2.9.20 are packaged together with the SDK, and there is no need to introduce this library) --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].40.bundle.js"></script> | ||
| </head> | ||
| <body> | ||
| <style> | ||
|
|
@@ -141,10 +141,10 @@ If you want to customize the classroom UI based on the default UI of <Vg k="FC"/ | |
|
|
||
| 1. Switch to the latest branch. | ||
|
|
||
| For example, if you want to switch to the branch of v2.9.20, just run the following command: | ||
| For example, if you want to switch to the branch of v2.9.40, just run the following command: | ||
|
|
||
| ```bash | ||
| git checkout release/2.9.20 | ||
| git checkout release/2.9.40 | ||
| ``` | ||
|
|
||
| Agora recommends switching the branch to the latest release. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -85,9 +85,10 @@ If you are satisfied with the default UI of <Vg k="FC"/> and do not want to chan | |
| 1. Add the following code to the HTML file in your project: | ||
|
|
||
| ```html | ||
| <!-- Replace X.Y.Z with the Flexible Classroom version number, such as 2.9.20. | ||
| <!-- Replace X.Y.Z with the Flexible Classroom version number, such as 2.9.40. | ||
| You can check the latest version number through the release notes or GitHub repository branch. --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected]"></script> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected]"></script> | ||
| ``` | ||
|
|
||
| 2. To launch a classroom, call [AgoraEduSDK.config](../../client-api/classroom-sdk#config) and [AgoraEduSDK.launch](../../reference/classroom-sdk#launch) in the JavaScript code of the project. | ||
|
|
@@ -100,10 +101,10 @@ If you are satisfied with the default UI of <Vg k="FC"/> and do not want to chan | |
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <!-- Introducing SDK, 2.9.20 is the sample version number, you can check the latest version number through the release notes or GitHub warehouse branch --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].20.bundle.js"></script> | ||
| <!-- Introducing Widget, 2.9.20 is the sample version number. You can check the latest version number through the release notes or GitHub warehouse branch. (Widgets before 2.9.20 are packaged together with the SDK, and there is no need to introduce this library) --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].20.bundle.js"></script> | ||
| <!-- Introducing SDK, 2.9.40 is the sample version number, you can check the latest version number through the release notes or GitHub warehouse branch --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].40.bundle.js"></script> | ||
| <!-- Introducing Widget, 2.9.40 is the sample version number. You can check the latest version number through the release notes or GitHub warehouse branch. (Widgets before 2.9.0 are packaged together with the SDK, and there is no need to introduce this library) --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].40.bundle.js"></script> | ||
| </head> | ||
| <body> | ||
| <style> | ||
|
|
@@ -121,7 +122,7 @@ If you are satisfied with the default UI of <Vg k="FC"/> and do not want to chan | |
| region: 'NA' | ||
| }); | ||
| // Start online classroom | ||
| AgoraEduSDK.launch(document.querySelector('#root'), { | ||
| const unmount = AgoraEduSDK.launch(document.querySelector("#root"), { | ||
| userUuid: 'user id', | ||
| userName: 'user name', | ||
| roomUuid: 'room id', | ||
|
|
@@ -159,6 +160,10 @@ The sample code requires passing in `rtmToken`. You can refer to [Generate a <Vg | |
|
|
||
| For details on the values of other parameters, see [LaunchOption](../../client-api/classroom-sdk#launchoption). | ||
|
|
||
| <Admonition type="info" title="Note"> | ||
| Calling `launch` returns `unmount`. When your App routing changes cause the unloading of a page, call `unmount` to disconnect the room and recycle resources. | ||
| </Admonition> | ||
|
|
||
| <a name="change_default_ui_education"></a> | ||
| ### Customize the classroom UI | ||
|
|
||
|
|
@@ -249,7 +254,7 @@ If you are satisfied with the default UI of <Vg k="FC"/> and do not want to chan | |
| 1. Add the following code to the HTML file in your project: | ||
|
|
||
| ```html | ||
| <!-- Replace X.Y.Z with the Flexible Classroom version number. | ||
| <!-- Replace X.Y.Z with the Flexible Classroom version number. For example, 1.0.40 | ||
| You can check the latest version number through the release notes or the GitHub repository branch. --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected]"></script> | ||
| ``` | ||
|
|
@@ -264,10 +269,10 @@ If you are satisfied with the default UI of <Vg k="FC"/> and do not want to chan | |
| <head> | ||
| <meta charset="UTF-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <!-- Introduce SDK, 1.0.10 is the sample version number. You can check the latest version number through the release notes or GitHub repository branch. --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].10.bundle.js"></script> | ||
| <!-- Introducing Widget, 1.0.10 is the sample version number. You can check the latest version number through the release notes or GitHub warehouse branch. (Widgets before 1.0.10 are packaged together with the SDK, so there is no need to introduce this library) --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].10.bundle.js"></script> | ||
| <!-- Introduce SDK, 1.0.40 is the sample version number. You can check the latest version number through the release notes or GitHub repository branch. --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].40.bundle.js"></script> | ||
| <!-- Introducing Widget, 1.0.40 is the sample version number. You can check the latest version number through the release notes or GitHub warehouse branch. (Widgets before 1.0.10 are packaged together with the SDK, so there is no need to introduce this library) --> | ||
| <script src="https://download.agora.io/edu-apaas/release/[email protected].40.bundle.js"></script> | ||
| </head> | ||
|
|
||
| <body> | ||
|
|
@@ -286,7 +291,7 @@ If you are satisfied with the default UI of <Vg k="FC"/> and do not want to chan | |
| region: "NA", | ||
| }); | ||
| // Start online proctoring | ||
| AgoraProctorSDK.launch(document.querySelector("#root"), { | ||
| const unmount = AgoraProctorSDK.launch(document.querySelector("#root"), { | ||
| userUuid: "user id", // Refer to the description below to fill in userUuid | ||
| userName: "user name", | ||
| roomUuid: "room id", | ||
|
|
@@ -308,6 +313,10 @@ If you are satisfied with the default UI of <Vg k="FC"/> and do not want to chan | |
| </html> | ||
| ``` | ||
|
|
||
| <Admonition type="info" title="Note"> | ||
| Calling `launch` returns `unmount`. When your App routing changes cause the unloading of a page, call `unmount` to disconnect the room and recycle resources. | ||
| </Admonition> | ||
|
|
||
| When being proctored online, students need to use the primary and secondary devices to access the exam. For example, the main device is a Web client used to collect students' videos and share their screens when they answer questions; the secondary device is an Android or iOS device used to capture students' bodies when they answer questions. The proctor observes students answering questions through videos from several points to prevent cheating. You need to fill in the `userUuid` on different devices. For example, for student A, pass it in the `AgoraProctorSDK.launch` parameter on the Web side, and then on the Android or iOS side. Flexible Classroom will identify them as student A's primary and secondary devices, merge their video streams, and render the merged video images in the teacher's proctoring video window. | ||
|
|
||
| The sample code requires passing in `rtmToken`. You can refer to [Generate a <Vg k="MESS" /> token](../get-started/manage-agora-account#generate-an-rtm-token) to learn what a <Vg k="MESS" /> token is, how to get a temporary <Vg k="MESS" /> token for testing purposes, and how to generate a <Vg k="MESS" /> token from the server. The generated token passed in `userId` must be consistent with the `launch` parameters passed in the `userUuid` method; otherwise, the generated token will be invalid. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters