Skip to content

Commit

Permalink
Merge pull request #3702 from AgoraIO/translation/4.x-api-ref
Browse files Browse the repository at this point in the history 
New YiCAT updates
  • Loading branch information
@Cilla-luodan
Cilla-luodan authored Jul 15, 2024
2 parents a5c1a80 + e772cb7 commit 8ada853
Show file tree
Hide file tree
Showing 5 changed files with 215 additions and 33 deletions.
10 changes: 5 additions & 5 deletions en-US/dita/RTC-NG/API/api_irtcengine_setremotedefaultvideostreamtype2.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@
<codeblock props="android" outputclass="language-java">public abstract int setRemoteDefaultVideoStreamType(Constants.VideoStreamType streamType);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<dl outputclass="since">
<dlentry props="native">
<dt>Since</dt>
<dd>v4.4.0</dd>
</dlentry>
</dl>
<p conkeyref="setRemoteVideoStreamType/desc1"/>
<p conkeyref="setRemoteVideoStreamType/desc2"/>
<note type="attention" conkeyref="setRemoteDefaultVideoStreamType/note"/></section>
<section id="parameters">
<p conkeyref="setRemoteVideoStreamType/desc2"/></section>
<section id="timing" deliveryTarget="details" conkeyref="setRemoteDefaultVideoStreamType/timing"/>
<section id="restriction" deliveryTarget="details" conkeyref="setRemoteDefaultVideoStreamType/restriction"/>
<section id="parameters" deliveryTarget="details">
<title>Parameters</title>
<parml>
<plentry conkeyref="setRemoteVideoStreamType2/streamtype">
Expand Down
3 changes: 2 additions & 1 deletion en-US/dita/RTC-NG/API/api_irtcengine_statechanged.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@
<pt>state</pt>
<pd>
<p>Media device states:<ul>
<li>0: The device is connected but not in use.</li>
<li>0: The device is ready for use.</li>
<li>1: The device is in use.</li>
<li>3: The device is plugged in.</li>
<li>8: The devive is disconnected.</li>
</ul></p>
</pd>
Expand Down
4 changes: 4 additions & 0 deletions en-US/dita/RTC-NG/API/enum_mediadevicestatetype.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@
<pt><ph keyref="MEDIA_DEVICE_STATE_DISABLED"/></pt>
<pd>2: The device is disabled.</pd>
</plentry>
<plentry>
<pt><ph keyref="MEDIA_DEVICE_STATE_PLUGGED_IN"/></pt>
<pd>3: The device is plugged in.</pd>
</plentry>
<plentry>
<pt><ph keyref="MEDIA_DEVICE_STATE_NOT_PRESENT"/></pt>
<pd>4: The device is not found.</pd>
Expand Down
210 changes: 193 additions & 17 deletions en-US/dita/RTC-NG/API/rtc_api_sunset.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@
<section>
<title>Deprecated APIs</title>
<p>The deprecated APIs are expected to be officially deleted in approximately one year. Agora recommends that you promptly replace them with the recommended APIs to avoid any impact on your online services.</p>
<table frame="all" rowsep="1" colsep="1">
<table frame="all" rowsep="1" colsep="1" props="cn">
<!--由于 table 中的 row 不能分级打 props，所以 cn 和 en 需要分两个表格维护：仅发 cn/en 的 API 只需要在对应表格中增加；cn 和 en 都发的 API 需要在两个表格中都加。-->
<tgroup cols="4">
<colspec colname="c1" colnum="1" colwidth="1*" />
<colspec colname="c2" colnum="2" colwidth="1*" />
<colspec colname="c3" colnum="3" colwidth="1*" />
<colspec colname="c4" colnum="4" colwidth="1*" />
<colspec colname="c1" colnum="1" colwidth="1*"/>
<colspec colname="c2" colnum="2" colwidth="1*"/>
<colspec colname="c3" colnum="3" colwidth="1*"/>
<colspec colname="c4" colnum="4" colwidth="1*"/>
<thead>
<row>
<entry>API</entry>
Expand Down Expand Up @@ -45,6 +46,12 @@
<entry><xref keyref="setRemoteVideoStreamTypeEx2"/></entry>
<entry>v4.4.0</entry>
</row>
<row props="android">
<entry><xref keyref="destroy_IMusicPlayer"/></entry>
<entry><ph conkeyref="destroy_IMusicPlayer/shortdesc"/></entry>
<entry><xref keyref="destroyMusicPlayer"/></entry>
<entry>v4.4.0</entry>
</row>
<row props="apple">
<entry><xref keyref="pushExternalAudioFrameSampleBuffer1"/></entry>
<entry><ph conkeyref="pushExternalAudioFrameSampleBuffer1/shortdesc"/></entry>
Expand Down Expand Up @@ -78,19 +85,19 @@
<row>
<entry><xref keyref="setLogFileSize"/></entry>
<entry><ph conkeyref="setLogFileSize/shortdesc"/></entry>
<entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize" /></entry>
<entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="android apple">
<entry><xref keyref="setExternalAudioSource"/></entry>
<entry><ph conkeyref="setExternalAudioSource/shortdesc"/></entry>
<entry><xref keyref="createCustomAudioTrack" /></entry>
<entry><xref keyref="createCustomAudioTrack"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setExternalAudioSource2"/></entry>
<entry><ph conkeyref="setExternalAudioSource2/shortdesc"/></entry>
<entry><xref keyref="createCustomAudioTrack" /></entry>
<entry><xref keyref="createCustomAudioTrack"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
Expand All @@ -102,13 +109,13 @@
<row>
<entry><xref keyref="setLocalVideoMirrorMode"/></entry>
<entry><ph conkeyref="setLocalVideoMirrorMode/shortdesc"/></entry>
<entry><xref keyref="setupLocalVideo" /> or <xref keyref="setLocalRenderMode2" /></entry>
<entry><xref keyref="setupLocalVideo"/> or <xref keyref="setLocalRenderMode2"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="cpp">
<entry><xref keyref="startScreenCaptureByScreenRect"/></entry>
<entry><ph conkeyref="startScreenCaptureByScreenRect/shortdesc"/></entry>
<entry><xref keyref="startScreenCaptureByDisplayId" /></entry>
<entry><xref keyref="startScreenCaptureByDisplayId"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
Expand All @@ -120,20 +127,189 @@
<row>
<entry><xref keyref="setLogFile"/></entry>
<entry><ph conkeyref="setLogFile/shortdesc"/></entry>
<entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize" /></entry>
<entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setAudioProfile"/></entry>
<entry><ph conkeyref="setAudioProfile/shortdesc"/></entry>
<entry><xref keyref="setAudioProfile2" /> or <xref keyref="setAudioScenario" /></entry>
<entry><xref keyref="setAudioProfile2"/> or <xref keyref="setAudioScenario"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="android ios cpp">
<entry props="cn"><xref keyref="preload"/></entry>
<entry props="cn"><ph conkeyref="preload/shortdesc"/></entry>
<entry props="cn"><xref keyref="preload2"/></entry>
<entry props="cn">v4.0.0</entry>
<entry><xref keyref="preload"/></entry>
<entry><ph conkeyref="preload/shortdesc"/></entry>
<entry><xref keyref="preload2"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="addVideoWatermark1"/></entry>
<entry><ph conkeyref="addVideoWatermark1/shortdesc"/></entry>
<entry><xref keyref="addVideoWatermark2"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="getBlue"/></entry>
<entry><ph conkeyref="getBlue/shortdesc"/></entry>
<entry>-</entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="getGreen"/></entry>
<entry><ph conkeyref="getGreen/shortdesc"/></entry>
<entry>-</entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="getRed"/></entry>
<entry><ph conkeyref="getRed/shortdesc"/></entry>
<entry>-</entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="setBlue"/></entry>
<entry><ph conkeyref="setBlue/shortdesc"/></entry>
<entry>-</entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="setGreen"/></entry>
<entry><ph conkeyref="setGreen/shortdesc"/></entry>
<entry>-</entry>
<entry>v4.0.0</entry>
</row>
<row props="android">
<entry><xref keyref="setRed"/></entry>
<entry><ph conkeyref="setRed/shortdesc"/></entry>
<entry>-</entry>
<entry>v4.0.0</entry>
</row>
</tbody>
</tgroup>
</table>
<table frame="all" rowsep="1" colsep="1" props="en">
<!--由于 table 中的 row 不能分级打 props，所以 cn 和 en 需要分两个表格维护：仅发 cn/en 的 API 只需要在对应表格中增加；cn 和 en 都发的 API 需要在两个表格中都加。-->
<tgroup cols="4">
<colspec colname="c1" colnum="1" colwidth="1*"/>
<colspec colname="c2" colnum="2" colwidth="1*"/>
<colspec colname="c3" colnum="3" colwidth="1*"/>
<colspec colname="c4" colnum="4" colwidth="1*"/>
<thead>
<row>
<entry>API</entry>
<entry>Description</entry>
<entry>Alternative API</entry>
<entry>Deprecated version</entry>
</row>
</thead>
<tbody>
<row props="android">
<entry><xref keyref="setRemoteSubscribeFallbackOption"/></entry>
<entry><ph conkeyref="setRemoteSubscribeFallbackOption/shortdesc"/></entry>
<entry><xref keyref="setRemoteSubscribeFallbackOption2"/></entry>
<entry>v4.4.0</entry>
</row>
<row props="android">
<entry><xref keyref="setRemoteVideoStreamType"/></entry>
<entry><ph conkeyref="setRemoteVideoStreamType/shortdesc"/></entry>
<entry><xref keyref="setRemoteVideoStreamType2"/></entry>
<entry>v4.4.0</entry>
</row>
<row props="android">
<entry><xref keyref="setRemoteDefaultVideoStreamType"/></entry>
<entry><ph conkeyref="setRemoteDefaultVideoStreamType/shortdesc"/></entry>
<entry><xref keyref="setRemoteDefaultVideoStreamType2"/></entry>
<entry>v4.4.0</entry>
</row>
<row props="android">
<entry><xref keyref="setRemoteVideoStreamTypeEx"/></entry>
<entry><ph conkeyref="setRemoteVideoStreamTypeEx/shortdesc"/></entry>
<entry><xref keyref="setRemoteVideoStreamTypeEx2"/></entry>
<entry>v4.4.0</entry>
</row>
<row props="apple">
<entry><xref keyref="pushExternalAudioFrameSampleBuffer1"/></entry>
<entry><ph conkeyref="pushExternalAudioFrameSampleBuffer1/shortdesc"/></entry>
<entry><xref keyref="pushExternalAudioFrameSampleBuffer2"/></entry>
<entry>v4.3.1</entry>
</row>
<row>
<entry><xref keyref="enableDualStreamMode"/></entry>
<entry><ph conkeyref="enableDualStreamMode/shortdesc"/></entry>
<entry><xref keyref="setDualStreamMode"/></entry>
<entry>v4.2.0</entry>
</row>
<row>
<entry><xref keyref="enableDualStreamMode"/></entry>
<entry><ph conkeyref="enableDualStreamMode/shortdesc"/></entry>
<entry><xref keyref="setDualStreamMode"/></entry>
<entry>v4.2.0</entry>
</row>
<row>
<entry><xref keyref="enableDualStreamModeEx"/></entry>
<entry><ph conkeyref="enableDualStreamModeEx/shortdesc"/></entry>
<entry><xref keyref="setDualStreamModeEx"/></entry>
<entry>v4.2.0</entry>
</row>
<row>
<entry><xref keyref="enableWebSdkInteroperability"/></entry>
<entry><ph conkeyref="enableWebSdkInteroperability/shortdesc"/></entry>
<entry>-</entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLogFileSize"/></entry>
<entry><ph conkeyref="setLogFileSize/shortdesc"/></entry>
<entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="android apple">
<entry><xref keyref="setExternalAudioSource"/></entry>
<entry><ph conkeyref="setExternalAudioSource/shortdesc"/></entry>
<entry><xref keyref="createCustomAudioTrack"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setExternalAudioSource2"/></entry>
<entry><ph conkeyref="setExternalAudioSource2/shortdesc"/></entry>
<entry><xref keyref="createCustomAudioTrack"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="createDataStreamEx1"/></entry>
<entry><ph conkeyref="createDataStreamEx1/shortdesc"/></entry>
<entry><xref keyref="createDataStreamEx2"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLocalVideoMirrorMode"/></entry>
<entry><ph conkeyref="setLocalVideoMirrorMode/shortdesc"/></entry>
<entry><xref keyref="setupLocalVideo"/> or <xref keyref="setLocalRenderMode2"/></entry>
<entry>v4.0.0</entry>
</row>
<row props="cpp">
<entry><xref keyref="startScreenCaptureByScreenRect"/></entry>
<entry><ph conkeyref="startScreenCaptureByScreenRect/shortdesc"/></entry>
<entry><xref keyref="startScreenCaptureByDisplayId"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLocalRenderMode1"/></entry>
<entry><ph conkeyref="setLocalRenderMode1/shortdesc"/></entry>
<entry><xref keyref="setLocalRenderMode2"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setLogFile"/></entry>
<entry><ph conkeyref="setLogFile/shortdesc"/></entry>
<entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="setAudioProfile"/></entry>
<entry><ph conkeyref="setAudioProfile/shortdesc"/></entry>
<entry><xref keyref="setAudioProfile2"/> or <xref keyref="setAudioScenario"/></entry>
<entry>v4.0.0</entry>
</row>
<row>
<entry><xref keyref="addVideoWatermark1"/></entry>
Expand Down Expand Up @@ -285,7 +461,7 @@
<entry><xref keyref="onExtensionErrorWithContext"/></entry>
<entry>v4.4.0</entry>
</row>
</tbody>
</tbody>
</tgroup>
</table>
</section>
Expand Down
Loading

0 comments on commit 8ada853

Please sign in to comment.