From 664444bd6ad1c3a50e2132654885716c7acb7a4e Mon Sep 17 00:00:00 2001
From: Suri539 <fanyuanyuan@agora.io>
Date: Thu, 17 Oct 2024 15:28:40 +0800
Subject: [PATCH] 450

---
 dita/RTC-NG/API/api_config_getappid.dita      | 12 ++--
 .../API/api_config_getjsonparameter.dita      | 61 +++++++++++++++++
 dita/RTC-NG/API/api_config_setappid.dita      |  6 +-
 .../API/api_config_setjsonparameter.dita      | 65 +++++++++++++++++++
 .../api_playerconfig_getjsonparameter.dita    | 53 +++++++++++++++
 .../api_playerconfig_setjsonparameter.dita    | 61 +++++++++++++++++
 dita/RTC-NG/API/api_rte_setconfigs.dita       | 10 +--
 dita/RTC-NG/RTC_NG_API_CPP.ditamap            |  4 +-
 .../RTC-NG/config/keys-rtc-ng-api-cpp.ditamap | 28 ++++++++
 .../config/relations-rtc-ng-api.ditamap       | 15 ++++-
 10 files changed, 302 insertions(+), 13 deletions(-)
 create mode 100644 dita/RTC-NG/API/api_config_getjsonparameter.dita
 create mode 100644 dita/RTC-NG/API/api_config_setjsonparameter.dita
 create mode 100644 dita/RTC-NG/API/api_playerconfig_getjsonparameter.dita
 create mode 100644 dita/RTC-NG/API/api_playerconfig_setjsonparameter.dita

diff --git a/dita/RTC-NG/API/api_config_getappid.dita b/dita/RTC-NG/API/api_config_getappid.dita
index 521259fb801..77442b0a69a 100644
--- a/dita/RTC-NG/API/api_config_getappid.dita
+++ b/dita/RTC-NG/API/api_config_getappid.dita
@@ -30,7 +30,7 @@
                 <dd>v4.5.0</dd>
             </dlentry>
             </dl>
-            <p props="android" conkeyref="SetConfigs_Rte/exception"/>
+            <p/>
         </section>        
         <section id="restriction" deliveryTarget="details">
             <title>调用限制</title>
@@ -45,11 +45,13 @@
             </plentry>
             </parml> </section>
         <section id="return_values">
-            <title><ph keyref="return-section-title"/></title>
+            <title><ph keyref="return-section-title" props="cpp apple framework"/>
+            <ph props="android">异常</ph></title>
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
-            <ul props="native unreal bp electron unity rn cs">
+            <ul props="cpp apple unreal bp electron unity rn cs">
                 <li>方法调用成功，返回设置的 App ID。</li>
-                <li>方法调用失败，返回空字符串。//TODO 失败是抛出异常，不是返回空字符串。</li>
-                </ul> </section>
+                <li>方法调用失败，返回空字符串。</li>
+                </ul> 
+        <p props="android" conkeyref="SetAppId/exception"/></section>
         </refbody>
 </reference>
diff --git a/dita/RTC-NG/API/api_config_getjsonparameter.dita b/dita/RTC-NG/API/api_config_getjsonparameter.dita
new file mode 100644
index 00000000000..a7c5c60649b
--- /dev/null
+++ b/dita/RTC-NG/API/api_config_getjsonparameter.dita
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_config_getjsonparameter">
+    <title><ph keyref="GetJsonParameter_Config"/></title>
+    <shortdesc id="short"><ph id="shortdesc">获取已设置的 SDK JSON 配置信息。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="GetJsonParameter_Config"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public String getJsonParameter() throws RteException;</codeblock>
+            <codeblock props="hmos" outputclass="language-arkts"/>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (NSString * _Nullable)jsonParameter:(AgoraRteError * _Nullable)error;</codeblock>
+            <codeblock props="cpp unreal" outputclass="language-cpp">std::string GetJsonParameter(Error *err = nullptr)</codeblock>
+            <codeblock props="bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从</dt>
+                <dd>v4.5.0</dd>
+            </dlentry>
+            </dl>
+            <p>当你调用 <xref keyref="SetJsonParameter_Config"/> 设置 JSON 配置信息后，你可以调用该方法获取已设置的配置信息。</p>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>调用时机</title>
+            <p>//TODO</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>调用限制</title>
+            <p>无。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details" props="cpp apple framework">
+            <title>参数</title>
+            <parml>
+            <plentry conkeyref="SetConfigs_Rte/err">
+                <pt/>
+                <pd/>
+            </plentry>
+            </parml> </section>
+        <section id="return_values">
+            <title><ph keyref="return-section-title" props="cpp apple framework"/>
+            <ph props="android">异常</ph></title>
+            <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
+            <ul props="cpp apple unreal bp electron unity rn cs">
+                <li>方法调用成功，返回设置的 JSON 配置信息。</li>
+                <li>方法调用失败，返回空字符串。</li>
+                </ul> 
+        <p props="android" conkeyref="SetAppId/exception"/></section>
+        </refbody>
+</reference>
diff --git a/dita/RTC-NG/API/api_config_setappid.dita b/dita/RTC-NG/API/api_config_setappid.dita
index a76acc47775..b223b00d102 100644
--- a/dita/RTC-NG/API/api_config_setappid.dita
+++ b/dita/RTC-NG/API/api_config_setappid.dita
@@ -30,11 +30,10 @@
                 <dd>v4.5.0</dd>
             </dlentry>
             </dl>
-            <p props="android" conkeyref="SetConfigs_Rte/exception"/>
         </section>
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>
-            <p>//TODO 该方法需要在初始化之前调用。</p>
+            <p> 该方法需要在 <xref keyref="InitMediaEngine"/> 之前调用。</p>
         </section>        
         <section id="restriction" deliveryTarget="details">
             <title>调用限制</title>
@@ -52,5 +51,8 @@
                 <pd></pd>
             </plentry>
             </parml> </section>
+        <section id="return_values">
+            <title><ph props="android">异常</ph></title>
+            <p id="exception">调用失败时，SDK 会抛出 <xref keyref="RteException"/> 异常，并返回相应的错误信息。你需要捕获异常并进行处理。</p></section>
         </refbody>
 </reference>
diff --git a/dita/RTC-NG/API/api_config_setjsonparameter.dita b/dita/RTC-NG/API/api_config_setjsonparameter.dita
new file mode 100644
index 00000000000..38c1c72a20f
--- /dev/null
+++ b/dita/RTC-NG/API/api_config_setjsonparameter.dita
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_config_setjsonparameter">
+    <title><ph keyref="SetJsonParameter_Config"/></title>
+    <shortdesc id="short"><ph id="shortdesc">设置 SDK 的 JSON 配置信息。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="SetJsonParameter_Config"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public void setJsonParameter(String jsonParameter) throws RteException;</codeblock>
+            <codeblock props="hmos" outputclass="language-arkts"/>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (void)setJsonParameter:(NSString * _Nullable)jsonParameter error:(AgoraRteError * _Nullable)error;</codeblock>
+            <codeblock props="cpp unreal" outputclass="language-cpp">void SetJsonParameter(const char *json_parameter, Error *err = nullptr);</codeblock>
+            <codeblock props="bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从</dt>
+                <dd>v4.5.0</dd>
+            </dlentry>
+            </dl>
+            <p/>
+        </section>
+        <section id="scenario" deliveryTarget="details">
+            <title>适用场景</title>
+            <p>当你需要设置私有参数或使用定制功能时，可以调用该方法。</p>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>调用时机</title>
+            <p>该方法需要在创建 <xref keyref="Config"/> 对象之后调用。//TODO 这个config对象是在setconfig的时候创建的，所以可不可以说需要在 setconfig 之后调用？</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>调用限制</title>
+            <p>无。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details">
+            <title>参数</title>
+            <parml>
+            <plentry id="json">
+                <pt props="apple android">jsonParameter</pt>
+                <pt props="cpp">json_parameter</pt>
+                <pd>JSON 字符串形式的参数。</pd>
+            </plentry>
+            <plentry props="cpp apple" conkeyref="SetConfigs_Rte/err">
+                <pt></pt>
+                <pd></pd>
+            </plentry>
+            </parml> </section>
+        <section id="return_values" props="android">
+            <title><ph>异常</ph></title>
+            <p conkeyref="SetAppId/exception"></p>
+            </section>
+        </refbody>
+</reference>
diff --git a/dita/RTC-NG/API/api_playerconfig_getjsonparameter.dita b/dita/RTC-NG/API/api_playerconfig_getjsonparameter.dita
new file mode 100644
index 00000000000..56b85c04422
--- /dev/null
+++ b/dita/RTC-NG/API/api_playerconfig_getjsonparameter.dita
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_playerconfig_getjsonparameter">
+    <title><ph keyref="GetJsonParameter_PlayerConfig"/></title>
+    <shortdesc id="short"><ph id="shortdesc">获取设置的媒体播放器的 JSON 配置信息。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="GetJsonParameter_PlayerConfig"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public String getJsonParameter() throws RteException;</codeblock>
+            <codeblock props="hmos" outputclass="language-arkts"/>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (NSString * _Nullable)jsonParameter:(AgoraRteError * _Nullable)error;</codeblock>
+            <codeblock props="cpp unreal" outputclass="language-cpp">std::string GetJsonParameter(Error *err = nullptr);</codeblock>
+            <codeblock props="bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从</dt>
+                <dd>v4.5.0</dd>
+            </dlentry>
+            </dl>
+            当你调用 <xref keyref="SetJsonParameter_PlayerConfig"/> 设置 JSON 配置信息后，你可以调用该方法获取已设置的配置信息。
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>调用时机</title>
+            <p>//TODO</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>调用限制</title>
+            <p>无。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details" props="cpp apple">
+            <title>参数</title>
+            <parml>
+            <plentry conkeyref="SetConfigs_Rte/err">
+                <pt/>
+                <pd/>
+            </plentry>
+            </parml> </section>
+        <section id="return_values" conkeyref="GetJsonParameter_Config/return_values"></section>
+        </refbody>
+</reference>
diff --git a/dita/RTC-NG/API/api_playerconfig_setjsonparameter.dita b/dita/RTC-NG/API/api_playerconfig_setjsonparameter.dita
new file mode 100644
index 00000000000..1b9b4492dcc
--- /dev/null
+++ b/dita/RTC-NG/API/api_playerconfig_setjsonparameter.dita
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
+<reference id="api_playerconfig_setjsonparameter">
+    <title><ph keyref="SetJsonParameter_PlayerConfig"/></title>
+    <shortdesc id="short"><ph id="shortdesc">设置播放器的 JSON 配置信息。</ph></shortdesc>
+    <prolog>
+        <metadata>
+            <keywords>
+                <indexterm keyref="SetJsonParameter_PlayerConfig"/>
+            </keywords>
+        </metadata>
+    </prolog>
+    <refbody>
+        <section id="prototype">
+            <p outputclass="codeblock">
+            <codeblock props="android" outputclass="language-java">public void setJsonParameter(String jsonParameter) throws RteException;</codeblock>
+            <codeblock props="hmos" outputclass="language-arkts"/>
+            <codeblock props="ios mac" outputclass="language-objectivec">- (void)setJsonParameter:(NSString * _Nonnull)jsonParameter error:(AgoraRteError * _Nullable)error;</codeblock>
+            <codeblock props="cpp unreal" outputclass="language-cpp">void SetJsonParameter(const char *json_parameter, Error *err = nullptr);</codeblock>
+            <codeblock props="bp" outputclass="language-cpp"/>
+            <codeblock props="electron" outputclass="language-typescript"/>
+            <codeblock props="unity cs" outputclass="language-csharp"/>
+            <codeblock props="rn" outputclass="language-typescript"/>
+            <codeblock props="flutter" outputclass="language-dart"/> </p>
+        </section>
+        <section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
+            <dl outputclass="since">
+            <dlentry props="native">
+                <dt>自从</dt>
+                <dd>v4.5.0</dd>
+            </dlentry>
+            </dl>
+            <p/>
+        </section>
+        <section id="scenario" deliveryTarget="details">
+            <title>适用场景</title>
+            <p>当你需要设置私有参数或使用定制功能时，可以调用该方法。</p>
+        </section>
+        <section id="timing" deliveryTarget="details">
+            <title>调用时机</title>
+            <p>//TODO</p>
+        </section>        
+        <section id="restriction" deliveryTarget="details">
+            <title>调用限制</title>
+            <p>无。</p>
+        </section>
+        <section id="parameters" deliveryTarget="details">
+            <title>参数</title>
+            <parml>
+            <plentry conkeyref="SetJsonParameter_Config/json">
+                <pt/>
+                <pd/>
+            </plentry>
+            <plentry props="cpp apple" conkeyref="SetConfigs_Rte/err">
+                <pt></pt>
+                <pd></pd>
+            </plentry>
+            </parml> </section>
+        <section id="return_values" props="android" conkeyref="SetJsonParameter_Config/return_values"/>
+        </refbody>
+</reference>
diff --git a/dita/RTC-NG/API/api_rte_setconfigs.dita b/dita/RTC-NG/API/api_rte_setconfigs.dita
index 953b5706d39..d5ea7da9996 100644
--- a/dita/RTC-NG/API/api_rte_setconfigs.dita
+++ b/dita/RTC-NG/API/api_rte_setconfigs.dita
@@ -31,7 +31,7 @@
             </dlentry>
             </dl>
             <p>你可以调用该方法来设置 App ID、SDK 日志文件、服务器的访问区域等信息。</p>
-            <p props="android" id="exception">调用失败时，SDK 会抛出 <xref keyref="RteException"/> 异常，并返回相应的错误信息。你需要捕获异常并进行处理。</p>
+            
         </section>
         <section id="timing" deliveryTarget="details">
             <title>调用时机</title>
@@ -54,13 +54,15 @@
                 <pd>状态或错误信息，详见 <xref keyref="Error"/>。</pd>
             </plentry>
             </parml> </section>
-        <section id="return_values" props="cpp apple framework">
-            <title><ph keyref="return-section-title"/></title>
+        <section id="return_values">
+            <title><ph keyref="return-section-title" props="cpp apple framework"/>
+            <ph props="android">异常</ph></title>
             <p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
             <p props="cpp apple unreal bp electron unity rn cs">配置是否成功：<ul>
                 <li><codeph><ph keyref="true"/></codeph>：配置成功。</li>
                 <li><codeph><ph keyref="false"/></codeph>：配置失败。</li>
                 </ul>
-            </p> </section>
+            </p>
+        <p props="android" id="exception">调用失败时，SDK 会抛出 <xref keyref="RteException"/> 异常，并返回相应的错误信息。你需要捕获异常并进行处理。</p></section>
         </refbody>
 </reference>
diff --git a/dita/RTC-NG/RTC_NG_API_CPP.ditamap b/dita/RTC-NG/RTC_NG_API_CPP.ditamap
index fa54026f12b..21f2f271e42 100644
--- a/dita/RTC-NG/RTC_NG_API_CPP.ditamap
+++ b/dita/RTC-NG/RTC_NG_API_CPP.ditamap
@@ -468,13 +468,15 @@
                 <topicref keyref="RegisterObserver_Player" toc="no"/>
                 <topicref keyref="Rte" toc="no"/>
                 <topicref keyref="SetAbrFallbackLayer" toc="no"/>
+                <topicref keyref="SetAbrSubscriptionLayer" toc="no"/>
                 <topicref keyref="SetAppId" toc="no"/>
                 <topicref keyref="SetAutoPlay" toc="no"/>
                 <topicref keyref="SetCanvas" toc="no"/>
                 <topicref keyref="SetConfigs_Rte" toc="no"/>
                 <topicref keyref="SetConfigs_Player" toc="no"/>
                 <topicref keyref="SetConfigs_Canvas" toc="no"/>
-                <topicref keyref="SetAbrSubscriptionLayer" toc="no"/>
+                <topicref keyref="SetJsonParameter_Config" toc="no"/>
+                <topicref keyref="SetJsonParameter_PlayerConfig" toc="no"/>
                 <topicref keyref="SetMirrorMode" toc="no"/>
                 <topicref keyref="SetRenderMode_CanvasConfig" toc="no"/>
                 <topicref keyref="Stop_Player" toc="no"/>
diff --git a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap
index b75d111519a..2c878e68226 100644
--- a/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap
+++ b/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap
@@ -1169,6 +1169,20 @@
                     </keywords>
                 </topicmeta>
             </keydef>
+            <keydef keys="SetJsonParameter_Config" href="../API/api_config_setjsonparameter.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>SetJsonParameter [1/2]</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="SetJsonParameter_PlayerConfig" href="../API/api_playerconfig_setjsonparameter.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>SetJsonParameter [2/2]</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
             <keydef keys="GetConfigs_Rte" href="../API/api_rte_getconfigs.dita">
                 <topicmeta>
                     <keywords>
@@ -1197,6 +1211,20 @@
                     </keywords>
                 </topicmeta>
             </keydef>
+            <keydef keys="GetJsonParameter_Config" href="../API/api_config_getjsonparameter.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>GetJsonParameter [1/2]</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
+            <keydef keys="GetJsonParameter_PlayerConfig" href="../API/api_playerconfig_getjsonparameter.dita">
+                <topicmeta>
+                    <keywords>
+                        <keyword>GetJsonParameter [2/2]</keyword>
+                    </keywords>
+                </topicmeta>
+            </keydef>
             <keydef keys="Pause_Player" href="../API/api_player_pause.dita">
                 <topicmeta>
                     <keywords>
diff --git a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap
index 69df4a31d27..0af40fce53c 100644
--- a/dita/RTC-NG/config/relations-rtc-ng-api.ditamap
+++ b/dita/RTC-NG/config/relations-rtc-ng-api.ditamap
@@ -3302,7 +3302,18 @@
                 <topicref keyref="GetConfigs_Rte"/>
             </relcell>
             <relcell>
-                <topicref keyref="RTE"/>
+                <topicref keyref="Rte"/>
+            </relcell>
+        </relrow>
+        <relrow>
+            <relcell>
+                <topicref keyref="GetAppId"/>
+                <topicref keyref="GetJsonParameter_Config"/>
+                <topicref keyref="SetAppId"/>
+                <topicref keyref="SetJsonParameter_Config"/>
+            </relcell>
+            <relcell>
+                <topicref keyref="Config"/>
             </relcell>
         </relrow>
         <relrow>
@@ -3340,8 +3351,10 @@
                 <topicref keyref="GetStats"/>
                 <topicref keyref="SetCanvas"/>
                 <topicref keyref="SetConfigs_Player"/>
+                <topicref keyref="SetJsonParameter_PlayerConfig"/>
                 <topicref keyref="Stop_Player"/>
                 <topicref keyref="GetConfigs_Player"/>
+                <topicref keyref="GetJsonParameter_PlayerConfig"/>
                 <topicref keyref="UnregisterObserver_Player"/>
             </relcell>
             <relcell>