Merge pull request #16 from seymourtang/doc

Doc:Add more REAME documents and remove Chinese comments from the code

Author: seymourtang

README.md

@@ -31,9 +31,9 @@ This SDK has undergone some testing to ensure its basic functionality works corr
 ## Environment Setup
 
 * [Java 1.8 or later](https://www.java.com)
-* App ID and App Certificate obtained from the [Agora Console](https://console.shengwang.cn/)
-* Basic Auth credentials from the [Agora Console](https://console.shengwang.cn/)
-* Enable the relevant service capabilities on the [Agora Console](https://console.shengwang.cn/)
+* App ID and App Certificate obtained from the [Agora Console](https://console.agora.io/v2)
+* Basic Auth credentials from the [Agora Console](https://console.agora.io/v2)
+* Enable the relevant service capabilities on the [Agora Console](https://console.agora.io/v2)
 
 ## Installation
 
@@ -264,17 +264,6 @@ public class Main {
 
 For more examples, see [Example](./examples).
 
-## How to Contact Agora for Assistance if You Encounter Difficulties
-
-> Option 1: If you are already using Agora services or are in the process of integration, you can directly contact your sales or service representative.
->
-> Option 2: Send an email to [[email protected]](mailto:[email protected]) for consultation.
->
-> Option 3: Scan the QR code to join our WeChat group for questions.
->
-> <img src="https://download.agora.io/demo/release/SDHY_QA.jpg" width="360" height="360">
----
-
 ## Contribution
 
 This project welcomes and accepts contributions. If you encounter any issues or have suggestions for improvements, please open an issue or submit a Pull Request.
@@ -290,7 +279,7 @@ For more details, please refer to the [Semantic Versioning](https://semver.org)
 
 ## References
 
-* [Agora API Documentation](https://doc.shengwang.cn/)
+* [Agora API Documentation](https://docs.agora.io/en/)
 
 ## License
 

README_ZH.md

@@ -291,7 +291,7 @@ public class Main {
 
 ## 参考
 
-* [Agora API 文档](https://doc.shengwang.cn/)
+* [声网 API 文档](https://doc.shengwang.cn/)
 
 ## 许可证
 

agora-rest-client-core/src/main/java/io/agora/rest/core/DomainPool.java

@@ -49,7 +49,7 @@ private boolean domainNeedUpdate() {
     }
 
     public void selectBestDomain() {
-        //  提前判断domain是否需要更新，避免多线程情况下重复获取锁
+        // Check if domain needs updating first to avoid acquiring locks unnecessarily in multi-threaded scenarios
         if (!domainNeedUpdate()) {
             return;
         }

agora-rest-client-core/src/main/java/io/agora/rest/services/cloudrecording/README.md

@@ -1,44 +1,45 @@
-# 云端录制服务
-## 服务简介
-云端录制是声网为音视频通话和直播研发的录制组件，提供 RESTful API 供开发者实现录制功能，并将录制文件存至第三方云存储。云端录制有稳定可靠、简单易用、成本可控、方案灵活、支持私有化部署等优势，是在线教育、视频会议、金融监管、客户服务场景的理想录制方案。
+# Cloud Recording Service
 
-## 环境准备
+English | [简体中文](./README_ZH.md)
 
-- 获取声网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)
+## Service Introduction
+Cloud Recording is a recording component developed by Agora for audio and video calls and live broadcasts. It provides RESTful APIs for developers to implement recording functionality and store recording files in third-party cloud storage. Cloud Recording offers advantages such as stability, reliability, ease of use, cost control, flexible solutions, and support for private deployment, making it an ideal recording solution for online education, video conferences, financial supervision, and customer service scenarios.
 
-  > - 点击创建应用
-      >
-      >   ![](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/create_app_1.jpg)
+## Environment Preparation
+
+- Obtain Agora App ID -------- [Agora Console](https://console.agora.io/v2)
+
+  > - Click Create Application
+  >
+  >   ![](../../../../../../../../../assets/imges/EN/create_app_1.png)
   >
-  > - 选择你要创建的应用类型
-      >
-      >   ![](https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/github_readme/create_app_2.jpg)
-
-- 获取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)
-
-  > 在声网控制台的项目管理页面，找到你的项目，点击配置。
-  > ![](https://fullapp.oss-cn-beijing.aliyuncs.com/scenario_api/callapi/config/1641871111769.png)
-  > 点击主要证书下面的复制图标，即可获取项目的 App 证书。
-  > ![](https://fullapp.oss-cn-beijing.aliyuncs.com/scenario_api/callapi/config/1637637672988.png)
-
-- 开启云录制服务
-  > ![](https://fullapp.oss-cn-beijing.aliyuncs.com/scenario_api/callapi/config/rtm_config1.jpg)
-  > ![](https://fullapp.oss-cn-beijing.aliyuncs.com/scenario_api/callapi/config/rtm_config2.jpg)  
-  > ![](https://fullapp.oss-cn-beijing.aliyuncs.com/agora-rest-client/go/open_cloud_recording.png)
-
-## API 接口调用示例
-### 获取云端录制资源
-> 在开始云端录制之前，你需要调用 acquire 方法获取一个 Resource ID。一个 Resource ID 只能用于一次云端录制服务。
-
-需要设置的参数有：
-- appId: 声网的项目 AppID
-- username: 声网的Basic Auth认证的用户名
-- password: 声网的Basic Auth认证的密码
-- cname: 频道名
-- uid: 用户 UID
-- 更多 clientRequest中的参数见 [Acquire](https://doc.shengwang.cn/doc/cloud-recording/restful/cloud-recording/operations/post-v1-apps-appid-cloud_recording-acquire) 接口文档
-
-通过调用`acquire`方法来实现获取云端录制资源
+  > - Select the type of application you want to create
+  >
+  >   ![](../../../../../../../../../assets/imges/EN/create_app_2.png)
+
+- Obtain App Certificate ----- [Agora Console](https://console.agora.io/v2)
+
+  > In the project management page of the Agora Console, find your project and click Configure.
+  > ![](../../../../../../../../../assets/imges/EN/config_app.png)
+  > Click the copy icon under Primary Certificate to obtain the App Certificate for your project.
+  > ![](../../../../../../../../../assets/imges/EN/copy_app_cert.png)
+
+- Check the status of the recording service
+  > ![](../../../../../../../../../assets/imges/EN/open_cloud_recording.png)
+
+## API Call Examples
+### Acquire Cloud Recording Resources
+> Before starting cloud recording, you need to call the acquire method to obtain a Resource ID. A Resource ID can only be used for one cloud recording service.
+
+Required parameters:
+- appId: Agora project AppID
+- username: Username for Agora Basic Auth authentication
+- password: Password for Agora Basic Auth authentication
+- cname: Channel name
+- uid: User UID
+- For more parameters in clientRequest, see the [Acquire](https://docs.agora.io/en/cloud-recording/reference/restful-api#acquire) API documentation
+
+Implement acquiring cloud recording resources by calling the `acquire` method
 ```java
         String appId = "";
         String cname = "";
@@ -82,18 +83,18 @@
         }
 ```
 
-### 开始云端录制
-> 通过 acquire 方法获取云端录制资源后，调用 start 方法开始云端录制。
+### Start Cloud Recording
+> After acquiring cloud recording resources through the acquire method, call the start method to begin cloud recording.
 
-需要设置的参数有：
-- cname: 频道名
-- uid: 用户 UID
-- resourceId: 云端录制资源ID
-- mode: 云端录制模式
-- storageConfig: 存储配置
-- 更多 clientRequest中的参数见 [Start](https://doc.shengwang.cn/doc/cloud-recording/restful/cloud-recording/operations/post-v1-apps-appid-cloud_recording-resourceid-resourceid-mode-mode-start) 接口文档
+Required parameters:
+- cname: Channel name
+- uid: User UID
+- resourceId: Cloud recording resource ID
+- mode: Cloud recording mode
+- storageConfig: Storage configuration
+- For more parameters in clientRequest, see the [Start](https://docs.agora.io/en/cloud-recording/reference/restful-api#start) API documentation
 
-通过调用`start`方法来实现开始云端录制
+Implement starting cloud recording by calling the `start` method
 ```java
      StartResourceReq.StorageConfig storageConfig = StartResourceReq.StorageConfig.builder()
                 .accessKey("")
@@ -166,20 +167,20 @@
         }
 ```
 
-### 停止云端录制
-> 开始录制后，你可以调用 stop 方法离开频道，停止录制。录制停止后如需再次录制，必须再调用 acquire 方法请求一个新的 Resource ID。
+### Stop Cloud Recording
+> After starting recording, you can call the stop method to leave the channel and stop recording. If you need to record again after stopping, you must call the acquire method again to request a new Resource ID.
 
-需要设置的参数有：
-- cname: 频道名
-- uid: 用户ID
-- resourceId: 云端录制资源ID
-- sid: 会话ID
-- mode: 云端录制模式
-- 更多 clientRequest中的参数见 [Stop](https://doc.shengwang.cn/doc/cloud-recording/restful/cloud-recording/operations/post-v1-apps-appid-cloud_recording-resourceid-resourceid-sid-sid-mode-mode-stop) 接口文档
+Required parameters:
+- cname: Channel name
+- uid: User ID
+- resourceId: Cloud recording resource ID
+- sid: Session ID
+- mode: Cloud recording mode
+- For more parameters in clientRequest, see the [Stop](https://docs.agora.io/en/cloud-recording/reference/restful-api#stop) API documentation
 
-因为Stop 接口返回的不是一个固定的结构体，所以需要根据返回的serverResponseMode来判断具体的返回类型
+Since the Stop interface does not return a fixed structure, you need to determine the specific return type based on the serverResponseMode returned
 
-通过调用`stop`方法来实现停止云端录制
+Implement stopping cloud recording by calling the `stop` method
 ```java
    StopResourceReq stopResourceReq = StopResourceReq.builder()
                 .cname(cname)
@@ -203,20 +204,20 @@
 
 ```
 
-### 查询云端录制状态
-> 开始录制后，你可以调用 query 方法查询录制状态。
+### Query Cloud Recording Status
+> After starting recording, you can call the query method to check the recording status.
 
-需要设置的参数有：
-- cname: 频道名
-- uid: 用户ID
-- resourceId: 云端录制资源ID
-- sid: 会话ID
-- mode: 云端录制模式
-- 更多 clientRequest中的参数见[Query](https://doc.shengwang.cn/doc/cloud-recording/restful/cloud-recording/operations/get-v1-apps-appid-cloud_recording-resourceid-resourceid-sid-sid-mode-mode-query)接口文档
+Required parameters:
+- cname: Channel name
+- uid: User ID
+- resourceId: Cloud recording resource ID
+- sid: Session ID
+- mode: Cloud recording mode
+- For more parameters in clientRequest, see the [Query](https://docs.agora.io/en/cloud-recording/reference/restful-api#query) API documentation
 
-因为 Query 接口返回的不是一个固定的结构体，所以需要根据返回的serverResponseMode来判断具体的返回类型
+Since the Query interface does not return a fixed structure, you need to determine the specific return type based on the serverResponseMode returned
 
-通过调用`query`方法来实现查询云端录制状态
+Implement querying cloud recording status by calling the `query` method
 ```java
         QueryResourceRes queryResourceRes = null;
 
@@ -258,20 +259,20 @@
         }
 ```
 
-### 更新云端录制设置
-> 开始录制后，你可以调用 update 方法更新如下录制配置：
-> * 对单流录制和合流录制，更新订阅名单。
-> * 对页面录制，设置暂停/恢复页面录制，或更新页面录制转推到 CDN 的推流地址（URL）。
+### Update Cloud Recording Settings
+> After starting recording, you can call the update method to update the following recording configurations:
+> * For individual recording and composite recording, update the subscription list.
+> * For web recording, set pause/resume web recording, or update the streaming URL for pushing web recording to CDN.
 
-需要设置的参数有：
-- cname: 频道名
-- uid: 用户 UID
-- resourceId: 云端录制资源ID
-- sid: 会话ID
-- mode: 云端录制模式
-- 更多 clientRequest中的参数见 [Update](https://doc.shengwang.cn/doc/cloud-recording/restful/cloud-recording/operations/post-v1-apps-appid-cloud_recording-resourceid-resourceid-sid-sid-mode-mode-update) 接口文档
+Required parameters:
+- cname: Channel name
+- uid: User UID
+- resourceId: Cloud recording resource ID
+- sid: Session ID
+- mode: Cloud recording mode
+- For more parameters in clientRequest, see the [Update](https://docs.agora.io/en/cloud-recording/reference/restful-api#update) API documentation
 
-通过调用`update`方法来实现更新云端录制设置
+Implement updating cloud recording settings by calling the `update` method
 ```java
   UpdateResourceReq updateResourceReq = UpdateResourceReq.builder()
                 .uid(uid)
@@ -302,5 +303,5 @@
         }
 ```
 
-## 错误码和响应状态码处理
-具体的业务响应码请参考 [业务响应码](https://doc.shengwang.cn/doc/cloud-recording/restful/response-code) 文档
+## Error Codes and Response Status Codes
+For specific business response codes, please refer to the [Business Response Codes](https://docs.agora.io/en/cloud-recording/reference/common-errors) documentation