[Android] update readme

AgoraIO · Dec 6, 2024 · 0901151 · 0901151
1 parent b9ed8cd
commit 0901151
Show file tree

Hide file tree

Showing 87 changed files with 6,170 additions and 3,147 deletions.
diff --git a/Android/APIExample/README.md b/Android/APIExample/README.md
@@ -90,7 +90,12 @@ Since version 4.0.0, Agora SDK provides an Extension Interface Framework. Develo
 In order to enable it, you could do as follows:
 
 1. Download [opencv](https://agora-adc-artifacts.s3.cn-north-1.amazonaws.com.cn/androidLibs/opencv4.zip) library, unzip it and copy into Android/APIExample/agora-simple-filter/src/main/jniLibs
-2. Download [Agora SDK包](https://doc.shengwang.cn/doc/rtc/android/resources), unzip it and copy c++ .so library (keeps arch folder) to Android/APIExample/agora-simple-filter/src/main/agoraLibs
+```text
+Android/APIExample/agora-simple-filter/src/main/jniLibs
+├── arm64-v8a
+└── armeabi-v7a
+```
+2. Download [Agora SDK RESOURCE](https://docs.agora.io/en/sdks?platform=android), unzip it and copy c++ .so library (keeps arch folder) to Android/APIExample/agora-simple-filter/src/main/agoraLibs; Replace the low_level_api/include .h files in the Android/APIExample/agora-simple-filter/src/main/cpp/AgoraRtcKit directory.
 
 ```text
 Android/APIExample/agora-simple-filter/src/main/agoraLibs
@@ -99,6 +104,10 @@ Android/APIExample/agora-simple-filter/src/main/agoraLibs
 ├── x86
 └── x86_64
 ```
+```text
+Android/APIExample/agora-simple-filter/src/main/cpp
+└── AgoraRtcKit
+```
 
 3. Modify simpleFilter to true in Android/APIExample/gradle.properties
 
@@ -107,7 +116,7 @@ Android/APIExample/agora-simple-filter/src/main/agoraLibs
 This project contains custom stream encrypt examples, which cannot be enabled by default. 
 The configuration method is as follows:
 
-1. Download [Agora SDK包](https://doc.shengwang.cn/doc/rtc/android/resources), unzip it and copy c++ .so library (keeps arch folder) to Android/APIExample/agora-stream-encrypt/src/main/agoraLibs
+1. Download [Agora SDK RESOURCE](https://docs.agora.io/en/sdks?platform=android), unzip it and copy c++ .so library (keeps arch folder) to Android/APIExample/agora-stream-encrypt/src/main/agoraLibs; Replace the hight_level_api/include .h files in the Android/APIExample/agora-stream-encrypt/src/main/cpp/include/agora directory.
 
 ```text
 Android/APIExample/agora-stream-encrypt/src/main/agoraLibs
@@ -116,6 +125,11 @@ Android/APIExample/agora-stream-encrypt/src/main/agoraLibs
 ├── x86
 └── x86_64
 ```
+```text
+Android/APIExample/agora-stream-encrypt/src/main/cpp
+└── include
+    └── agora
+```
 
 2. Modify streamEncrypt to true in Android/APIExample/gradle.properties
 

diff --git a/Android/APIExample/README.zh.md b/Android/APIExample/README.zh.md
@@ -86,7 +86,12 @@
 从4.0.0SDK开始，Agora SDK支持插件系统和开放的云市场帮助开发者发布自己的音视频插件，本项目包含了一个SimpleFilter示例，默认是禁用的状态，如果需要开启编译和使用需要完成以下步骤：
 
 1. 下载 [opencv](https://agora-adc-artifacts.s3.cn-north-1.amazonaws.com.cn/androidLibs/opencv4.zip) 解压后复制到 Android/APIExample/agora-simple-filter/src/main/jniLibs
-2. 手动下载[Agora SDK包](https://doc.shengwang.cn/doc/rtc/android/resources), 解压后将c++动态库（包括架构文件夹）copy到Android/APIExample/agora-simple-filter/src/main/agoraLibs
+```text
+Android/APIExample/agora-simple-filter/src/main/jniLibs
+├── arm64-v8a
+└── armeabi-v7a
+```
+2. 手动下载[Agora SDK包](https://doc.shengwang.cn/doc/rtc/android/resources), 解压后将c++动态库（包括架构文件夹）copy到Android/APIExample/agora-simple-filter/src/main/agoraLibs, 将 low_level_api/include 头文件替换到 Android/APIExample/agora-simple-filter/src/main/cpp/AgoraRtcKit 目录中
 
 ```text
 Android/APIExample/agora-simple-filter/src/main/agoraLibs
@@ -95,14 +100,18 @@ Android/APIExample/agora-simple-filter/src/main/agoraLibs
 ├── x86
 └── x86_64
 ```
+```text
+Android/APIExample/agora-simple-filter/src/main/cpp
+└── AgoraRtcKit
+```
 
 3. 修改Android/APIExample/gradle.properties配置文件中simpleFilter值为true
 
 ### 自定义加密
 
 本项目包含自定义加密示例，默认是不启用的。配置方法如下：
 
-1. 手动下载[Agora SDK包](https://doc.shengwang.cn/doc/rtc/android/resources), 解压后将c++动态库（包括架构文件夹）copy到Android/APIExample/agora-stream-encrypt/src/main/agoraLibs
+1. 手动下载[Agora SDK包](https://doc.shengwang.cn/doc/rtc/android/resources), 解压后将c++动态库（包括架构文件夹）copy到Android/APIExample/agora-stream-encrypt/src/main/agoraLibs，将 hight_level_api/include 头文件替换到 Android/APIExample/agora-stream-encrypt/src/main/cpp/include/agora 目录中
 
 ```text
 Android/APIExample/agora-stream-encrypt/src/main/agoraLibs
@@ -111,6 +120,11 @@ Android/APIExample/agora-stream-encrypt/src/main/agoraLibs
 ├── x86
 └── x86_64
 ```
+```text
+Android/APIExample/agora-stream-encrypt/src/main/cpp
+└── include
+    └── agora
+```
 
 2. 修改Android/APIExample/gradle.properties配置文件中streamEncrypt值为true