Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New YiCAT updates #3356

Merged
merged 7 commits into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_channelmediarelayconfiguration_getdestchannelmediainfos">
<title><ph keyref="getDestChannelMediaInfos" /></title>
<title><ph keyref="getDestChannelMediaInfos"/></title>
<shortdesc id="short"><ph id="shortdesc">Gets the information of the target channel.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getDestChannelMediaInfos" />
<indexterm keyref="getDestChannelMediaInfos"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public Map&lt;String, ChannelMediaInfo&gt; getDestChannelMediaInfos() {
<codeblock props="android" outputclass="language-java">public Map&lt;String, ChannelMediaInfo> getDestChannelMediaInfos() {
return destInfos;
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" 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" />
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" 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"/>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="return_values">
<title>Returns</title>
<p>The information of the target channel. See <xref keyref="ChannelMediaInfo" />.</p>
<p>The information of the target channel. See <xref keyref="ChannelMediaInfo"/>.</p>
</section>
</refbody>
</reference>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
destInfos.remove(channelName);
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName;</codeblock>
<codeblock props="cpp unreal" 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" />
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="cpp unreal" 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"/>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="parameters">
<title>Parameters</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName;
</codeblock>
<codeblock props="cpp unreal" 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" />
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="cpp unreal" 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"/>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="parameters">
<title>Parameters</title>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_channelmediarelayconfiguration_setsrcchannelinfo">
<title><ph keyref="setSrcChannelInfo" /></title>
<title><ph keyref="setSrcChannelInfo"/></title>
<shortdesc id="short"><ph id="shortdesc">Sets the information of the source channel.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="setSrcChannelInfo" />
<indexterm keyref="setSrcChannelInfo"/>
</keywords>
</metadata>
</prolog>
Expand All @@ -16,24 +16,24 @@
<codeblock props="android" outputclass="language-java">public void setSrcChannelInfo(ChannelMediaInfo srcInfo) {
this.srcInfo = srcInfo;
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" 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" />
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" 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"/>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="parameters">
<title>Parameters</title>
<parml>
<plentry>
<pt>srcInfo</pt>
<pd>
<p>The information of the source channel <xref keyref="ChannelMediaInfo" />. It contains the following members:<ul>
<li><parmname>channelName</parmname>: The name of the source channel. The default value is <codeph><ph keyref="NULL" /></codeph>, which means the SDK applies the name of the current channel.</li>
<p>The information of the source channel <xref keyref="ChannelMediaInfo"/>. It contains the following members:<ul>
<li><parmname>channelName</parmname>: The name of the source channel. The default value is <codeph><ph keyref="NULL"/></codeph>, which means the SDK applies the name of the current channel.</li>
<li><parmname>token</parmname>: The <parmname>token</parmname> for joining the source channel. This token is generated with the <parmname>channelName</parmname> and <parmname>uid</parmname> you set in <parmname>srcInfo</parmname>.<ul>
<li>If you have not enabled the App Certificate, set this parameter as the default value <codeph><ph keyref="NULL" /></codeph>, which means the SDK applies the App ID.</li>
<li>If you have not enabled the App Certificate, set this parameter as the default value <codeph><ph keyref="NULL"/></codeph>, which means the SDK applies the App ID.</li>
<li>If you have enabled the App Certificate, you must use the <parmname>token</parmname> generated with the <parmname>channelName</parmname> and <parmname>uid</parmname>, and the <parmname>uid</parmname> must be set as 0.</li>
</ul> </li>
<li><parmname>uid</parmname>: The unique user ID to identify the relay stream in the source channel. Agora recommends leaving the default value of 0 unchanged.</li>
Expand All @@ -42,4 +42,4 @@
</plentry>
</parml> </section>
</refbody>
</reference>
</reference>
26 changes: 13 additions & 13 deletions en-US/dita/RTC-NG/API/api_createagorartcengine.dita
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_createagorartcengine">
<title><ph keyref="createAgoraRtcEngine" /></title>
<shortdesc id="short"><ph id="shortdesc" props="cpp unreal bp unity rn flutter cs">Creates one <apiname keyref="IRtcEngine" /> object. </ph><ph id="shortdescele" props="electron">Creates one <apiname keyref="IRtcEngineEx" /> object.</ph></shortdesc>
<title><ph keyref="createAgoraRtcEngine"/></title>
<shortdesc id="short"><ph id="shortdesc" props="cpp unreal bp unity rn flutter cs">Creates one <apiname keyref="IRtcEngine"/> object. </ph><ph id="shortdescele" props="electron">Creates one <apiname keyref="IRtcEngineEx"/> object.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="createAgoraRtcEngine" />
<indexterm keyref="createAgoraRtcEngine"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java" />
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="android" outputclass="language-java"/>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine ()</codeblock>
<codeblock props="electron" outputclass="language-typescript">export function createAgoraRtcEngine(): IRtcEngineEx {
return instance;
Expand All @@ -29,19 +29,19 @@
<codeblock props="flutter" outputclass="language-dart">RtcEngine createAgoraRtcEngine() {
return impl.RtcEngineImpl.create();
}</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
<p props="electron">Currently, the Agora RTC SDK v4.x supports creating only one <apiname keyref="IRtcEngineEx" /> object for each app.</p>
<p props="cpp unreal bp rn unity cs">Currently, the Agora RTC SDK v4.x supports creating only one <apiname keyref="IRtcEngine" /> object for each app.</p>
<p props="flutter">Currently, the Agora RTC SDK v6.x supports creating only one <apiname keyref="IRtcEngine" /> object for each app.</p>
<p props="electron">Currently, the Agora RTC SDK v4.x supports creating only one <apiname keyref="IRtcEngineEx"/> object for each app.</p>
<p props="cpp unreal bp rn unity cs">Currently, the Agora RTC SDK v4.x supports creating only one <apiname keyref="IRtcEngine"/> object for each app.</p>
<p props="flutter">Currently, the Agora RTC SDK v6.x supports creating only one <apiname keyref="IRtcEngine"/> object for each app.</p>
</section>
<section id="return_values">
<title>Returns</title>
<p props="cpp unreal bp">Pointer to the <apiname keyref="IRtcEngine" /> object.</p>
<p props="electron">One <apiname keyref="IRtcEngineEx" /> object.</p>
<p props="unity rn flutter cs">One <apiname keyref="IRtcEngine" /> object.</p>
<p props="cpp unreal bp">Pointer to the <apiname keyref="IRtcEngine"/> object.</p>
<p props="electron">One <apiname keyref="IRtcEngineEx"/> object.</p>
<p props="unity rn flutter cs">One <apiname keyref="IRtcEngine"/> object.</p>
</section>
</refbody>
</reference>
</reference>
24 changes: 12 additions & 12 deletions en-US/dita/RTC-NG/API/api_createagorartcengineex.dita
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_createagorartcengineex">
<title><ph keyref="createAgoraRtcEngineEx" /></title>
<shortdesc id="short"><ph id="shortdesc">Creates one <apiname keyref="IRtcEngineEx" /> object.</ph></shortdesc>
<title><ph keyref="createAgoraRtcEngineEx"/></title>
<shortdesc id="short"><ph id="shortdesc">Creates one <apiname keyref="IRtcEngineEx"/> object.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="createAgoraRtcEngineEx" />
<indexterm keyref="createAgoraRtcEngineEx"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java" />
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" outputclass="language-cpp" />
<codeblock props="electron" outputclass="language-typescript" />
<codeblock props="android" outputclass="language-java"/>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp">public static IRtcEngineEx CreateAgoraRtcEngineEx()
{
return (IRtcEngineEx)(instance ?? (instance = new RtcEngine(IntPtr.Zero)));
}</codeblock>
<codeblock props="rn" outputclass="language-typescript" />
<codeblock props="rn" outputclass="language-typescript"/>
<codeblock props="flutter" outputclass="language-dart">RtcEngineEx createAgoraRtcEngineEx() {
return impl.RtcEngineImpl.create();
}</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
<p props="unity cs">Currently, the Agora RTC v4.x SDK supports creating only one <apiname keyref="IRtcEngineEx" /> object for each app.</p>
<p props="flutter">Currently, the Agora RTC v6.x SDK supports creating only one <apiname keyref="IRtcEngineEx" /> object for each app.</p>
<p props="unity cs">Currently, the Agora RTC v4.x SDK supports creating only one <apiname keyref="IRtcEngineEx"/> object for each app.</p>
<p props="flutter">Currently, the Agora RTC v6.x SDK supports creating only one <apiname keyref="IRtcEngineEx"/> object for each app.</p>
</section>
<section id="return_values">
<title>Returns</title>
<p props="electron unity rn flutter cs">One <apiname keyref="IRtcEngineEx" /> object.</p>
<p props="electron unity rn flutter cs">One <apiname keyref="IRtcEngineEx"/> object.</p>
</section>
</refbody>
</reference>
4 changes: 2 additions & 2 deletions en-US/dita/RTC-NG/API/api_getmediaplayercachemanager.dita
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
return new IMediaPlayerCacheManagerImpl();
}</codeblock>
<codeblock props="flutter" outputclass="language-dart">MediaPlayerCacheManager getMediaPlayerCacheManager()</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
Expand All @@ -37,4 +37,4 @@
<p>The <xref keyref="IMediaPlayerCacheManager" /> instance.</p>
</section>
</refbody>
</reference>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<codeblock props="unity cs" outputclass="language-csharp">abstract DeviceInfo[] EnumerateRecordingDevices();</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract enumerateRecordingDevices(): AudioDeviceInfo[];</codeblock>
<codeblock props="flutter" outputclass="language-dart">List&lt;AudioDeviceInfo&gt; enumerateRecordingDevices();</codeblock>
<codeblock props="reserve" outputclass="language-cpp" /></p>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java" />
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="android" outputclass="language-java"/>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int followSystemLoopbackDevice(bool enable) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract followSystemLoopbackDevice(enable: boolean): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int FollowSystemLoopbackDevice(bool enable);</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java" />
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="android" outputclass="language-java"/>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getLoopbackDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getLoopbackDevice(): string;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetLoopbackDevice(ref string deviceId);</codeblock>
Expand Down
Loading
Loading