Release/5.0.0

KTVAPI/Android/README.md

@@ -1,6 +1,6 @@
 # K 歌场景化 API 示例 demo
 
-> 本文档主要介绍如何快速跑通 K 歌场景化 API 示例工程，支持加载、播放声网内容中心版权音乐和本地音乐文件。
+> 本文档主要介绍如何快速跑通 K 歌场景化 API 示例工程，本 demo 支持普通合唱、大合唱两种模式, 包含加载、播放声网内容中心版权音乐和本地音乐文件等功能
 >
 > **Demo 效果:**
 >
@@ -10,55 +10,61 @@
 ## 1. 环境准备
 
 - <mark>最低兼容 Android 5.0</mark>（SDK API Level 21）
-- Android Studio 3.5及以上版本。
-- Android 5.0 及以上的手机设备。
+- Android Studio 3.5及以上版本
+- Android 5.0 及以上的手机设备
 
 ---
 
 ## 2. 运行示例
 
-- 获取声网 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)
-  > - 点击创建应用
-      >
-      >   ![xxx](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/create_app_1.jpg)
-  >
-  > - 选择你要创建的应用类型
-      >
-      >   ![xxx](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/create_app_2.jpg)
-  >
-  > - 得到 App ID 与 App 证书
-      >
-      >   ![xxx](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/get_app_id.jpg)
+- 2.1 进入声网控制台获取 APP ID 和 APP 证书 [控制台入口](https://console.shengwang.cn/overview)
 
-- 获取 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)
+  - 点击创建项目
 
-- **联系销售给 AppID 开通 K 歌权限(如果您没有销售人员的联系方式可通过智能客服联系销售人员 [Agora 支持](https://agora-ticket.agora.io/))**
+    ![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_1.jpg)
+
+  - 选择项目基础配置, 鉴权机制需要选择**安全模式**
+
+    ![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_2.jpg)
+
+  - 拿到项目 APP ID 与 APP 证书
+
+    ![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_3.jpg)
+
+  - **Restful API 服务配置（大合唱）**
+    ```json
+    注: 体验大合唱模式需要填写 Restful API 相关信息
+    ```
+    ![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_4.jpg)
+    ![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_5.jpg)
+    ![图片](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/ent-full/sdhy_6.jpg)
+
+  - **联系声网技术支持给 APP ID 开通 K 歌歌单权限和云端转码权限([声网支持](https://ticket.shengwang.cn/form?type_id=&sdk_product=&sdk_platform=&sdk_version=&current=0&project_id=&call_id=&channel_name=))**
 
     ```json
-    注: 拉取声网版权榜单、歌单、歌曲、歌词等功能是需要开通权限的, 仅体验本地音乐文件模式可以不用开通
+    注: 拉取声网版权榜单、歌单、歌曲、歌词等功能是需要开通歌单权限的, 仅体验本地音乐文件模式可以不用开通
+        体验大合唱模式需要开通云端转码权限, 仅体验普通合唱可以不用开通
     ```
 
-- 在项目的 [**gradle.properties**](gradle.properties) 里填写需要的声网 App ID 和 App 证书
+- 2.2 在项目的 [**gradle.properties**](gradle.properties) 里填写需要的声网 App ID 和 App 证书、RESTFUL KEY 和 SECRET
 
   ```
   # RTM RTC SDK key Config
-  AGORA_APP_ID：声网appid
-  AGORA_APP_CERTIFICATE：声网Certificate
+  AGORA_APP_ID：声网 APP ID
+  AGORA_APP_CERTIFICATE：声网 APP 证书
+  RESTFUL_API_KEY：声网RESTful API key
+  RESTFUL_API_SECRET：声网RESTful API secret
   ```
-- 用 Android Studio 运行项目即可开始您的体验
+- 2.3 用 Android Studio 运行项目即可开始您的体验
 
 ---
 
 ## 3. 如何集成场景化 API 实现 K 歌场景
 详见[**官网文档**](https://doc.shengwang.cn/doc/online-ktv/android/implementation/ktv-scenario/get-music)
 
-### 集成遇到困难，该如何联系声网获取协助
-
-> 方案1：如果您已经在使用声网服务或者在对接中，可以直接联系对接的销售或服务
->
-> 方案2：发送邮件给 [[email protected]](mailto:[email protected]) 咨询
->
-> 方案3：扫码加入我们的微信交流群提问
->
-> <img src="https://download.agora.io/demo/release/SDHY_QA.jpg" width="360" height="360">
----
+## 4. FAQ
+- 集成遇到困难，该如何联系声网获取协助
+  - 方案1：可以从智能客服获取帮助或联系技术支持人员 [声网支持](https://ticket.shengwang.cn/form?type_id=&sdk_product=&sdk_platform=&sdk_version=&current=0&project_id=&call_id=&channel_name=)
+  - 方案2：加入微信群提问
+
+    ![](https://download.agora.io/demo/release/SDHY_QA.jpg)

KTVAPI/Android/app/.gitignore

@@ -1 +1,2 @@
-/build
+/build
+/release

KTVAPI/Android/app/build.gradle

@@ -23,6 +23,8 @@ android {
         buildConfigField "String", "TOOLBOX_SERVER_HOST", "\"${properties.getProperty("TOOLBOX_SERVER_HOST", "")}\""
         buildConfigField "String", "AGORA_APP_ID", "\"${properties.getProperty("AGORA_APP_ID", "")}\""
         buildConfigField "String", "AGORA_APP_CERTIFICATE", "\"${properties.getProperty("AGORA_APP_CERTIFICATE", "")}\""
+        buildConfigField "String", "RESTFUL_API_KEY", "\"${RESTFUL_API_KEY}\""
+        buildConfigField "String", "RESTFUL_API_SECRET", "\"${RESTFUL_API_SECRET}\""
     }
 
     buildTypes {
@@ -74,10 +76,13 @@ dependencies {
     implementation 'androidx.navigation:navigation-ui-ktx:2.4.1'
     implementation 'com.google.code.gson:gson:2.10.1'
     implementation 'com.squareup.okhttp3:okhttp:3.12.0'
+    implementation 'com.squareup.okhttp3:logging-interceptor:4.10.0'
     implementation 'com.github.mrmike:ok2curl:0.8.0'
 
     // 歌词组件
     implementation 'com.github.AgoraIO-Community:LyricsView:1.1.1-beta.8'
+    //
+    implementation 'io.agora:authentication:1.6.1'
     // ktvapi
     api project(":lib_ktvapi")
 }

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

@@ -9,6 +9,7 @@
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
     <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
     <uses-permission android:name="android.permission.BLUETOOTH" />
+    <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
 
     <application
         android:name=".MyApplication"
@@ -20,6 +21,7 @@
         android:roundIcon="@mipmap/app_ic_launcher_round"
         android:supportsRtl="true"
         android:theme="@style/app_Theme.AgoraKTV"
+        android:networkSecurityConfig="@xml/network_security_config"
         tools:targetApi="31">
         <activity
             android:name=".ui.MainActivity"