Skip to content

Commit 3dfb80f

Browse files
committed
Merge branch 'release/4.3.0' into dev/4.3.0_cp
2 parents 5cfe08b + 61fcda5 commit 3dfb80f

28 files changed

+5067
-1633
lines changed

KTVAPI/Android/README.md

Lines changed: 38 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# K 歌场景化 API 示例 demo
22

3-
> 本文档主要介绍如何快速跑通 K 歌场景化 API 示例工程,支持加载、播放声网内容中心版权音乐和本地音乐文件。
3+
> 本文档主要介绍如何快速跑通 K 歌场景化 API 示例工程,本 demo 支持普通合唱、大合唱两种模式, 包含加载、播放声网内容中心版权音乐和本地音乐文件等功能
44
>
55
> **Demo 效果:**
66
>
@@ -10,55 +10,61 @@
1010
## 1. 环境准备
1111

1212
- <mark>最低兼容 Android 5.0</mark>(SDK API Level 21)
13-
- Android Studio 3.5及以上版本
14-
- Android 5.0 及以上的手机设备
13+
- Android Studio 3.5及以上版本
14+
- Android 5.0 及以上的手机设备
1515

1616
---
1717

1818
## 2. 运行示例
1919

20-
- 获取声网 App ID -------- [声网Agora - 文档中心 - 如何获取 App ID](https://docs.agora.io/cn/Agora%20Platform/get_appid_token?platform=All%20Platforms#%E8%8E%B7%E5%8F%96-app-id)
21-
> - 点击创建应用
22-
>
23-
> ![xxx](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/create_app_1.jpg)
24-
>
25-
> - 选择你要创建的应用类型
26-
>
27-
> ![xxx](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/create_app_2.jpg)
28-
>
29-
> - 得到 App ID 与 App 证书
30-
>
31-
> ![xxx](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/get_app_id.jpg)
20+
- 2.1 进入声网控制台获取 APP ID 和 APP 证书 [控制台入口](https://console.shengwang.cn/overview)
3221

33-
- 获取 App 证书 ----- [声网Agora - 文档中心 - 获取 App 证书](https://docs.agora.io/cn/Agora%20Platform/get_appid_token?platform=All%20Platforms#%E8%8E%B7%E5%8F%96-app-%E8%AF%81%E4%B9%A6)
22+
- 点击创建项目
3423

35-
- **联系销售给 AppID 开通 K 歌权限(如果您没有销售人员的联系方式可通过智能客服联系销售人员 [Agora 支持](https://agora-ticket.agora.io/))**
24+
![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_1.jpg)
25+
26+
- 选择项目基础配置, 鉴权机制需要选择**安全模式**
27+
28+
![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_2.jpg)
29+
30+
- 拿到项目 APP ID 与 APP 证书
31+
32+
![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_3.jpg)
33+
34+
- **Restful API 服务配置(大合唱)**
35+
```json
36+
注: 体验大合唱模式需要填写 Restful API 相关信息
37+
```
38+
![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_4.jpg)
39+
![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_5.jpg)
40+
![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_6.jpg)
41+
42+
- **联系声网技术支持给 APP ID 开通 K 歌歌单权限和云端转码权限([声网支持](https://ticket.shengwang.cn/form?type_id=&sdk_product=&sdk_platform=&sdk_version=&current=0&project_id=&call_id=&channel_name=))**
3643

3744
```json
38-
注: 拉取声网版权榜单、歌单、歌曲、歌词等功能是需要开通权限的, 仅体验本地音乐文件模式可以不用开通
45+
注: 拉取声网版权榜单、歌单、歌曲、歌词等功能是需要开通歌单权限的, 仅体验本地音乐文件模式可以不用开通
46+
体验大合唱模式需要开通云端转码权限, 仅体验普通合唱可以不用开通
3947
```
4048

41-
- 在项目的 [**gradle.properties**](gradle.properties) 里填写需要的声网 App ID 和 App 证书
49+
- 2.2 在项目的 [**gradle.properties**](gradle.properties) 里填写需要的声网 App ID 和 App 证书、RESTFUL KEY 和 SECRET
4250

4351
```
4452
# RTM RTC SDK key Config
45-
AGORA_APP_ID:声网appid
46-
AGORA_APP_CERTIFICATE:声网Certificate
53+
AGORA_APP_ID:声网 APP ID
54+
AGORA_APP_CERTIFICATE:声网 APP 证书
55+
RESTFUL_API_KEY:声网RESTful API key
56+
RESTFUL_API_SECRET:声网RESTful API secret
4757
```
48-
- 用 Android Studio 运行项目即可开始您的体验
58+
- 2.3 用 Android Studio 运行项目即可开始您的体验
4959
5060
---
5161
5262
## 3. 如何集成场景化 API 实现 K 歌场景
5363
详见[**官网文档**](https://doc.shengwang.cn/doc/online-ktv/android/implementation/ktv-scenario/get-music)
5464
55-
### 集成遇到困难,该如何联系声网获取协助
56-
57-
> 方案1:如果您已经在使用声网服务或者在对接中,可以直接联系对接的销售或服务
58-
>
59-
> 方案2:发送邮件给 [[email protected]](mailto:[email protected]) 咨询
60-
>
61-
> 方案3:扫码加入我们的微信交流群提问
62-
>
63-
> <img src="https://download.agora.io/demo/release/SDHY_QA.jpg" width="360" height="360">
64-
---
65+
## 4. FAQ
66+
- 集成遇到困难,该如何联系声网获取协助
67+
- 方案1:可以从智能客服获取帮助或联系技术支持人员 [声网支持](https://ticket.shengwang.cn/form?type_id=&sdk_product=&sdk_platform=&sdk_version=&current=0&project_id=&call_id=&channel_name=)
68+
- 方案2:加入微信群提问
69+
70+
![](https://download.agora.io/demo/release/SDHY_QA.jpg)

KTVAPI/Android/app/.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
/build
1+
/build
2+
/release

KTVAPI/Android/app/build.gradle

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,13 @@ dependencies {
7474
implementation 'androidx.navigation:navigation-ui-ktx:2.4.1'
7575
implementation 'com.google.code.gson:gson:2.10.1'
7676
implementation 'com.squareup.okhttp3:okhttp:3.12.0'
77+
implementation 'com.squareup.okhttp3:logging-interceptor:4.10.0'
7778
implementation 'com.github.mrmike:ok2curl:0.8.0'
7879

7980
// 歌词组件
8081
implementation 'com.github.AgoraIO-Community:LyricsView:1.1.1-beta.8'
82+
//
83+
implementation 'io.agora:authentication:1.6.1'
8184
// ktvapi
8285
api project(":lib_ktvapi")
8386
}

KTVAPI/Android/app/src/main/AndroidManifest.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
1010
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
1111
<uses-permission android:name="android.permission.BLUETOOTH" />
12+
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
1213

1314
<application
1415
android:name=".MyApplication"
@@ -20,6 +21,7 @@
2021
android:roundIcon="@mipmap/app_ic_launcher_round"
2122
android:supportsRtl="true"
2223
android:theme="@style/app_Theme.AgoraKTV"
24+
android:networkSecurityConfig="@xml/network_security_config"
2325
tools:targetApi="31">
2426
<activity
2527
android:name=".ui.MainActivity"
14.4 MB
Binary file not shown.

0 commit comments

Comments
 (0)