Skip to content

Commit 2f1488f

Browse files
authored
Merge pull request #1363 from xuchengpu/doc-v2
update after Developer experience review
2 parents 5d2aac2 + 7a116bd commit 2f1488f

File tree

3 files changed

+23
-40
lines changed

3 files changed

+23
-40
lines changed

docs/document/android/easecallkit.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@
99
**利用 `EaseCallKit` 通话过程中,使用环信 ID 加入频道,方便音视频视图中显示用户名。如果用户不使用 `EaseCallKit` 而直接调用声网 API,也可以直接使用数字 UID 加入频道。**
1010

1111
:::tip
12-
本 UI 库只和移动端 3.8.0 及以上版本 Demo 互通。3.8.1 的 UI 库使用声网数字 uid 加入频道,而 3.8.0 使用字符串加入频道,3.8.1 版本不与 3.8.0 互通,Demo 中 EaseCallKit 使用的 token 和 UID 均由你自己生成。若你需要使用声网对应的音视频服务,需单独在声网申请。
12+
Demo 中 EaseCallKit 使用的 token 和 UID 均由你自己生成。若你需要使用声网对应的音视频服务,需单独在声网申请。
1313
:::
1414

1515
## 跑通 Demo
1616

17-
EaseCallKit 集成在环信开源 IM Demo 中,你可以通过进入 [环信 Demo 及源码](https://www.easemob.com/download/im) 下载页面,选择 Android 端进行下载,直接下载: [Android IM 源码](https://github.com/easemob/chat-android)
17+
EaseCallKit 集成在环信开源 IM Demo 中,你可以通过进入 [环信 Demo](https://www.easemob.com/download/demo) 下载页面,选择 Android 端进行下载。或者直接下载: [Android IM 源码](https://github.com/easemob/easemob-demo-android)
1818

1919
环境准备:
2020

21-
- Android Studio 3.5 及以上版本;
22-
- Gradle 4.6 及以上版本;
23-
- targetSdkVersion 29;
24-
- minSdkVersion 19;
25-
- Java JDK 1.8 及以上版本。
21+
- 推荐 Android Studio Meerkat | 2024.3.1 Patch 2及以上
22+
- 推荐 Gradle 8.0 及以上
23+
- targetVersion 33 及以上
24+
- Android SDK API 21 及以上
25+
- JDK 17 及以上
2626

2727
运行 Demo:
2828

@@ -53,10 +53,10 @@ EaseCallKit 集成在环信开源 IM Demo 中,你可以通过进入 [环信 De
5353

5454
#### Gradle 方式集成
5555

56-
-`build.gradle` 中添加以下代码,重新 build 你的项目即可。
56+
-`build.gradle` 中添加以下代码,重新 build 你的项目即可。[点击查看最新版本号](https://central.sonatype.com/artifact/io.hyphenate/ease-call-kit/versions)
5757

5858
```gradle
59-
implementation 'io.hyphenate:ease-call-kit:3.8.9'
59+
implementation 'io.hyphenate:ease-call-kit:4.15.1'
6060
```
6161

6262
:::tip
@@ -76,13 +76,11 @@ implementation project(':ease-call-kit')
7676

7777
```gradle
7878
//环信 SDK
79-
implementation 'io.hyphenate:hyphenate-chat:3.8.0' (`hyphenate-chat` 只支持 3.8.0 及以上版本)
79+
implementation 'io.hyphenate:hyphenate-chat:4.15.1'
8080
//声网 SDK
81-
implementation 'io.agora.rtc:full-sdk:3.8.0'
81+
implementation 'io.agora.rtc:full-rtc-basic:4.1.0'
8282
```
8383

84-
使用 easecallkit 4.0.1 或以上版本 时,请使用声网音视频库 `io.agora.rtc:full-sdk:4.1.0`
85-
8684
### 添加权限
8785

8886
根据场景需要,本库需要增加麦克风、相机和悬浮窗等权限:
@@ -109,7 +107,6 @@ implementation 'io.agora.rtc:full-sdk:3.8.0'
109107
在清单中增加 `EaseCallKit` 中的 `EaseVideoCallActivity``EaseMultipleVideoActivity`:
110108

111109
```xml
112-
//添加 Activity
113110
<activity
114111
android:name="com.hyphenate.easecallkit.ui.EaseVideoCallActivity"
115112
android:configChanges="orientation|keyboardHidden|screenSize"
@@ -140,7 +137,6 @@ callKitConfig.setRingFile(ringFile);
140137
//设置呼叫超时时间,单位为秒。
141138
callKitConfig.setCallTimeOut(30 * 1000);
142139
//设置声网的 appId。
143-
callKitConfig.setAgoraAppId("*****");
144140
Map<String, EaseCallUserInfo> userInfoMap = new HashMap<>();
145141
userInfoMap.put("***",new EaseCallUserInfo("****",null));
146142
callKitConfig.setUserInfoMap(userInfoMap);

docs/document/android/integration.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44

55
## 开发环境要求
66

7-
- Android Studio 3.0 或以上版本;
8-
- Android SDK API 等级 21 或以上;
9-
- Android 5.0 或以上版本的设备。
7+
- 推荐 Android Studio Meerkat | 2024.3.1 Patch 2及以上
8+
- 推荐 Gradle 8.0 及以上
9+
- targetVersion 33 及以上
10+
- Android SDK API 21 及以上
11+
- JDK 17 及以上
1012

1113
## 集成 SDK
1214

@@ -21,12 +23,6 @@
2123

2224
### 方法一:使用 mavenCentral 自动集成
2325

24-
:::tip
25-
26-
该方法仅适用于 v3.8.2 或以上版本。
27-
28-
:::
29-
3026
1. 在项目的 `build.gradle` 中添加 `mavenCentral()` 仓库。
3127

3228
```gradle
@@ -52,22 +48,12 @@ allprojects {
5248
...
5349
dependencies {
5450
...
55-
// x.y.z 请填写具体版本号,必须为 3.8.2 或以上版本。
51+
// x.y.z 请填写具体版本号
5652
// 可通过 SDK 发版说明获得最新版本号。
5753
implementation 'io.hyphenate:hyphenate-chat:x.x.x'
5854
}
5955
```
6056

61-
:::tip
62-
如果使用 3.8.0 之前的版本,gradle 依赖需要按照下面格式添加:
63-
:::
64-
65-
```gradle
66-
implementation 'io.hyphenate:hyphenate-sdk:3.7.5' // 完整版本,包含音视频功能
67-
68-
implementation 'io.hyphenate:hyphenate-sdk-lite:3.7.5' // 精简版,只包含IM功能
69-
```
70-
7157
### 方法二:手动复制 SDK 文件
7258

7359
打开 [SDK 下载页面](https://www.easemob.com/download/im),获取最新版的环信即时通讯 IM Android SDK,然后解压。
@@ -90,7 +76,7 @@ implementation 'io.hyphenate:hyphenate-sdk-lite:3.7.5' // 精简版,只包含I
9076
...
9177
dependencies {
9278
...
93-
// x.y.z 请填写具体版本号,必须为 3.8.2 或以上版本。
79+
// x.y.z 请填写具体版本号
9480
// 可通过 SDK 发版说明获得最新版本号。
9581
implementation(files("libs/hyphenatechat_x.y.z.jar"))
9682
}

docs/document/android/quickstart.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@
1212

1313
## 前提条件
1414

15-
- Android Studio 4.0 或以上版本;
16-
- Android SDK API 等级 21 或以上;
17-
- Android 5.0 或以上版本的设备;
18-
- JDK 11 或以上
15+
- 推荐 Android Studio Meerkat | 2024.3.1 Patch 2及以上
16+
- 推荐 Gradle 8.0 及以上
17+
- targetVersion 33 及以上
18+
- Android SDK API 21 及以上
19+
- JDK 17 及以上
1920
- 有效的环信即时通讯 IM 开发者账号和 App key,见 [环信即时通讯云控制台](https://console.easemob.com/user/login)
2021

2122
## 准备开发环境

0 commit comments

Comments
 (0)