Skip to content

Commit e2b02ef

Browse files
HugoChaanHugoChaan
authored
opt readme (#158)
* opt readme * opt readme * opt readme * opt readme * opt readme * opt readme
1 parent 3fb0435 commit e2b02ef

File tree

16 files changed

+144
-117
lines changed

16 files changed

+144
-117
lines changed

‎Android/scenes/eCommerce/README.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
11
# E-Commerce
22

3-
> This document introduces how to quickly run through <mark>E-Commerce</mark> sample project.
3+
This document introduces how to quickly run through E-Commerce sample project.
44

5-
> <img src="https://download.agora.io/demo/release/CommerceShot01.png" width="300" height="640" /><img src="https://download.agora.io/demo/release/CommerceShot02.png" width="300" height="640" />
5+
Demo effect:
6+
7+
<img src="https://download.agora.io/demo/release/CommerceShot01.png" width="300" height="640" /> <img src="https://download.agora.io/demo/release/CommerceShot02.png" width="300" height="640" />
68

79
## Prerequisites
810

9-
- Android Studio 3.5 or higher.
10-
- Android SDK API Level 21 or higher.
11-
- A mobile device that runs Android 5.0 or higher.
11+
- Android Studio 4.0 or higher
12+
- Android SDK API Level 24 or higher
13+
- A mobile device that runs Android 7.0 or higher
1214

1315
## Project Setup
1416

15-
1. Follow [The Account Document](https://docs.agora.io/en/video-calling/reference/manage-agora-account) to get the **App ID** and **App Certificate(if enable token)**.
16-
2. Follow [Signaling Beginner's guide](https://docs.agora.io/en/signaling/get-started/beginners-guide?platform=android) to enable signaling in Agora Console.You should enable the following:
17+
1. Follow [The Account Document](https://docs.agora.io/en/video-calling/reference/manage-agora-account) to get the **App ID** and **App Certificate (if token is enabled)**.
18+
2. Follow [Signaling Beginner's Guide](https://docs.agora.io/en/signaling/get-started/beginners-guide?platform=android) to enable signaling in Agora Console. You should enable the following:
1719
* Using storage
1820
* User attribute callback
1921
* Channel attribute callback
2022
* Distributed lock
21-
3. Open the `Android` project and fill in the properties obtained above to the root [gradle.properties](../gradle.properties) file.
23+
3. Open the `Android` project and fill in the properties obtained above in the root [gradle.properties](../gradle.properties) file.
2224

2325
```
24-
# RTM RTC SDK key Config
26+
# RTC SDK key Config
2527
AGORA_APP_ID=<Your Agora App ID>
26-
AGORA_APP_CERTIFICATE=<Your Agora App Certificate(if enable token)>
28+
AGORA_APP_CERTIFICATE=<Your Agora App Certificate (if token is enabled)>
2729
```
2830

2931
4. Now you can run the project with Android Studio to experience the application.
@@ -41,7 +43,6 @@ AGORA_APP_CERTIFICATE=<Your Agora App Certificate(if enable token)>
4143
| scene/eCommmerce/RtcEngineInstance.kt | RTC Engine initializing. |
4244
| scene/eCommmerce/VideoSetting.kt | RTC video setting. |
4345
| scene/eCommmerce/CommmerceLogger.kt | Living streaming logger. |
44-
| scene/eCommmerce/beauty/ | Living streaming beauty implement. |
4546
| scene/eCommmerce/utils/ | Living streaming utils. |
4647
| scene/eCommmerce/widget/ | Living streaming UI widgets. |
4748
| scene/eCommmerce/shop/ | eCommerce UI widgets. |
@@ -50,13 +51,13 @@ AGORA_APP_CERTIFICATE=<Your Agora App Certificate(if enable token)>
5051

5152
If you have any problems or suggestions regarding the sample projects, feel free to file an issue.
5253

53-
## Related resources
54+
## Related Resources
5455

5556
- Check our [FAQ](https://docs.agora.io/en/faq) to see if your issue has been recorded.
5657
- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials.
57-
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case.
58+
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use cases.
5859
- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community).
59-
- If you encounter problems during integration, feel free to ask questions in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
60+
- If you encounter problems during integration, feel free to ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
6061

6162
## License
6263

‎Android/scenes/ktv/README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Online KTV
22

3-
> This document mainly explains how to quickly run through the <mark> Online KTV </mark> sample project.
4-
>
5-
> Demo effect:
6-
>
7-
> <img src="https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ktv/ktv_130_1.png" width="300" height="640"><img src="https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ktv/ktv_130_2.png" width="300" height="640">
3+
This document mainly explains how to quickly run through Online KTV sample project.
4+
5+
Demo effect:
6+
7+
<img src="https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ktv/ktv_130_1.png" width="300" height="640"><img src="https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ktv/ktv_130_2.png" width="300" height="640">
88
---
99

1010
## 1. Prerequisites
1111

12-
- <mark>Minimum compatibility with Android 7.0</mark>(SDK API Level 24).
13-
- Android SDK API Level 21 or higher.
14-
- A mobile device that runs Android 5.0 or higher.
12+
- Android Studio 4.0 or higher
13+
- Android SDK API Level 24 or higher
14+
- A mobile device that runs Android 7.0 or higher
1515

1616
---
1717

@@ -230,13 +230,13 @@
230230
231231
If you have any problems or suggestions regarding the sample projects, feel free to file an issue.
232232
233-
## Related resources
233+
## Related Resources
234234
235235
- Check our [FAQ](https://docs.agora.io/en/faq) to see if your issue has been recorded.
236236
- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials.
237-
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case.
237+
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use cases.
238238
- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community).
239-
- If you encounter problems during integration, feel free to ask questions in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
239+
- If you encounter problems during integration, feel free to ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
240240
241241
## License
242242

‎Android/scenes/show/README.md

+28-13
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
11
# Live Streaming
22

3-
> This document introduces how to quickly run through <mark>Live Streaming</mark> sample project.
3+
This document introduces how to quickly run through Live Streaming sample project.
44

5-
> <img src="https://download.agora.io/demo/release/LiveStreamingShot01.png" width="300" height="640" /><img src="https://download.agora.io/demo/release/LiveStreamingShot02.png" width="300" height="640" />
5+
Demo effect:
6+
7+
<img src="https://download.agora.io/demo/release/LiveStreamingShot01.png" width="300" height="640" /><img src="https://download.agora.io/demo/release/LiveStreamingShot02.png" width="300" height="640" />
68

79
## Prerequisites
810

9-
- Android Studio 3.5 or higher.
10-
- Android SDK API Level 21 or higher.
11-
- A mobile device that runs Android 5.0 or higher.
12-
- FaceUnity beauty authpack file.
11+
- Android Studio 4.0 or higher
12+
- Android SDK API Level 24 or higher
13+
- A mobile device that runs Android 7.0 or higher
14+
- FaceUnity beauty authpack file
1315

1416
## Project Setup
1517

1618
1. Follow [The Account Document](https://docs.agora.io/en/video-calling/reference/manage-agora-account) to get the **App ID** and **App Certificate**.
1719
2. Follow [The Restfull Document](https://docs.agora.io/en/video-calling/reference/restful-authentication) to get the **Customer ID** and **Customer Secret**.
18-
3. Follow [The Media Pull Document](https://docs.agora.io/en/media-pull/get-started/enable-media-pull) to enable media pull for cloud player.
19-
4. Follow Signaling Beginner's guide to enable signaling in Agora Console. You should enable the following:
20+
3. Follow [Signaling Beginner's Guide](https://docs.agora.io/en/signaling/get-started/beginners-guide?platform=android) to enable signaling in Agora Console. You should enable the following:
2021
* Using storage
2122
* User attribute callback
2223
* Channel attribute callback
2324
* Distributed lock
25+
4. Please contact technical support to enable robot room streaming service.
26+
```json
27+
If this step is not executed, you will not be able to see the video in robot rooms.
28+
```
2429
5. Open the `Android` project and fill in properties got above to the root [gradle.properties](../gradle.properties) file.
2530

2631
```
@@ -33,13 +38,23 @@ CLOUD_PLAYER_KEY=<Your Agora Customer ID>
3338
CLOUD_PLAYER_SECRET=<Your Agora Customer Secret>
3439
```
3540

36-
6. Obtain the beauty authpack file from FaceUnity, and then copy the beauty authpack file `authpack.java` to `scenes/show/src/main/java/io/agora/scene/show/beauty` direction.
41+
6. Obtain beauty resources and certificate files from FaceUnity:
42+
- Configure the package name applicationId corresponding to the certificate in [app/build.gradle](../../app/build.gradle).
43+
44+
- Put the FaceUnity beauty resources into the corresponding path.
45+
46+
| FaceUnity Beauty Resources | Location |
47+
|-------------------------------------|---------------------------------------------------------------------------|
48+
| makeup resource (e.g. naicha.bundle) | scenes/show/src/main/assets/beauty_faceunity/makeup |
49+
| sticker resource (e.g. fashi.bundle) | scenes/show/src/main/assets/beauty_faceunity/sticker |
50+
| animoji resource (e.g. kaola.bundle) | scenes/show/src/main/assets/beauty_faceunity/animoji |
51+
| authpack.java | scenes/show/src/main/java/io/agora/scene/show/beauty/authpack.java |
3752
```json
3853
If this step is not executed, you will not be able to experience the beauty feature.
3954
```
4055
7. Now you can run the project with android studio to experience the application.
4156

42-
## Source Code sitemap
57+
## Source Code Sitemap
4358

4459
| Path(Android/scenes/show/src/main/java/io/agora) | Description |
4560
|--------------------------------------------------|--------------------------------------------------------------------------------------|
@@ -62,13 +77,13 @@ If this step is not executed, you will not be able to experience the beauty feat
6277

6378
If you have any problems or suggestions regarding the sample projects, feel free to file an issue.
6479

65-
## Related resources
80+
## Related Resources
6681

6782
- Check our [FAQ](https://docs.agora.io/en/faq) to see if your issue has been recorded.
6883
- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials.
69-
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case.
84+
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use cases.
7085
- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community).
71-
- If you encounter problems during integration, feel free to ask questions in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
86+
- If you encounter problems during integration, feel free to ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
7287

7388
## License
7489

‎Android/scenes/show/build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ dependencies {
5757

5858
implementation rootProject.ext.deps.rtm
5959

60-
if (BEAUTY_RESOURCE = "") {
60+
if (BEAUTY_RESOURCE == "") {
6161
implementation 'com.faceunity:model:8.7.0'
6262
}
6363
implementation 'com.faceunity:core:8.7.0'

‎Android/scenes/show/src/main/assets/beauty_faceunity/animoji/PLACEHOLDER

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
hashiqi_Animoji.bundle
2+
kaola_Animoji.bundle

‎Android/scenes/show/src/main/assets/beauty_faceunity/makeup/PLACEHOLDER

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
tianmei.bundle
2+
xinggan.bundle

‎Android/scenes/show/src/main/assets/beauty_faceunity/sticker/PLACEHOLDER

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
cat_sparks.bundle
2+
sdlu.bundle

‎Android/scenes/show/src/main/assets/happy.mp3

-1.05 MB
Binary file not shown.

‎Android/scenes/show/src/main/assets/relax.mp3

-124 KB
Binary file not shown.

‎Android/scenes/show/src/main/assets/romantic.mp3

-1.56 MB
Binary file not shown.

‎Android/scenes/voice/README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# Audio Chatroom
22

3-
> This document introduces how to quickly run through <mark>Audio Chatroom</mark> sample project.
3+
This document introduces how to quickly run through Audio Chatroom sample project.
44

5-
> <img src="https://download.agora.io/demo/release/VoiceChatShot01.png" width="300" height="640" /><img src="https://download.agora.io/demo/release/VoiceChatShot02.png" width="300" height="640" />
5+
Demo effect:
6+
7+
<img src="https://download.agora.io/demo/release/VoiceChatShot01.png" width="300" height="640" /><img src="https://download.agora.io/demo/release/VoiceChatShot02.png" width="300" height="640" />
68

79
## Prerequisites
810

9-
- Android Studio 3.5 or higher.
10-
- Android SDK API Level 21 or higher.
11-
- A mobile device that runs Android 5.0 or higher.
11+
- Android Studio 4.0 or higher
12+
- Android SDK API Level 24 or higher
13+
- A mobile device that runs Android 7.0 or higher
1214

1315
## Project Setup
1416

@@ -47,13 +49,13 @@ IM_APP_CLIENT_SECRET=
4749

4850
If you have any problems or suggestions regarding the sample projects, feel free to file an issue.
4951

50-
## Related resources
52+
## Related Resources
5153

5254
- Check our [FAQ](https://docs.agora.io/en/faq) to see if your issue has been recorded.
5355
- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials.
54-
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case.
56+
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use cases.
5557
- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community).
56-
- If you encounter problems during integration, feel free to ask questions in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
58+
- If you encounter problems during integration, feel free to ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
5759

5860
## License
5961

‎README.md

+15-19
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,36 @@
11
# Agora Live
22

33
## Overview
4-
**AgoraLive** is an open-source entertainment project containing multiple scenarios. The project includes the following scenario solutions:
4+
**Agora Live** is an open-source entertainment project containing multiple scenarios. The project includes the following scenario solutions:
55

66
* Scenes
7-
7+
88
| Scenes | Platform | Location |
99
| --------------- | -------- | ---------------------------------------------------------------------------------------- |
10-
| LiveStreaming | iOS | [AgoraEntScenarios/Scenes/Show](iOS/AgoraEntScenarios/Scenes/Show/README.md) |
11-
| VoiceChatRoom | iOS | [AgoraEntScenarios/Scenes/VoiceChatRoom](iOS/AgoraEntScenarios/Scenes/VoiceChatRoom/README.md) |
12-
| E-Commerce | iOS | [AgoraEntScenarios/Scenes/Commerce](iOS/AgoraEntScenarios/Scenes/Commerce/README.md) |
13-
| Karaoke | iOS | [AgoraEntScenarios/Scenes/KTV](iOS/AgoraEntScenarios/Scenes/KTV/README.md) |
14-
| LiveStreaming | Android | [Android/scenes/show](Android/scenes/show/README.md) |
15-
| VoiceChatRoom | Android | [Android/scenes/voice](Android/scenes/voice/README.md) |
16-
| E-Commerce | Android | [Android/scenes/eCommerce](Android/scenes/eCommerce/README.md) |
17-
| Karaoke | Android | [Android/scenes/ktv](Android/scenes/ktv/README.md) |
18-
19-
20-
* Demo screenshots:
21-
22-
<img src="https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/agora-live/home_page_1.png?" width="320" height="640">
23-
<img src="https://download.agora.io/demo/release/AgoraLiveShot02.png" width="320" height="640" />
10+
| Live Streaming | iOS | [AgoraEntScenarios/Scenes/Show](iOS/AgoraEntScenarios/Scenes/Show/README.md) |
11+
| Voice Chat Room | iOS | [AgoraEntScenarios/Scenes/VoiceChatRoom](iOS/AgoraEntScenarios/Scenes/VoiceChatRoom/README.md) |
12+
| E-Commerce | iOS | [AgoraEntScenarios/Scenes/Commerce](iOS/AgoraEntScenarios/Scenes/Commerce/README.md) |
13+
| Karaoke | iOS | [AgoraEntScenarios/Scenes/KTV](iOS/AgoraEntScenarios/Scenes/KTV/README.md) |
14+
| Live Streaming | Android | [Android/scenes/show](Android/scenes/show/README.md) |
15+
| Voice Chat Room | Android | [Android/scenes/voice](Android/scenes/voice/README.md) |
16+
| E-Commerce | Android | [Android/scenes/eCommerce](Android/scenes/eCommerce/README.md) |
17+
| Karaoke | Android | [Android/scenes/ktv](Android/scenes/ktv/README.md) |
2418

19+
* Demo Screenshots:
2520

21+
<img src="https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/agora-live/home_page_1.png?" width="320" height="640"><img src="https://download.agora.io/demo/release/AgoraLiveShot02.png" width="320" height="640" />
2622

2723
## Feedback
2824

2925
If you have any problems or suggestions regarding the sample projects, feel free to file an issue.
3026

31-
## Related resources
27+
## Related Resources
3228

3329
- Check our [FAQ](https://docs.agora.io/en/faq) to see if your issue has been recorded.
3430
- Dive into [Agora SDK Samples](https://github.com/AgoraIO) to see more tutorials.
35-
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use case.
31+
- Take a look at [Agora Use Case](https://github.com/AgoraIO-usecase) for more complicated real use cases.
3632
- Repositories managed by developer communities can be found at [Agora Community](https://github.com/AgoraIO-Community).
37-
- If you encounter problems during integration, feel free to ask questions in [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
33+
- If you encounter problems during integration, feel free to ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/agora.io).
3834

3935
## License
4036

0 commit comments

Comments
 (0)