Skip to content

Commit

Permalink
Merge pull request #3842 from AgoraIO/translation/4.x-api-ref
Browse files Browse the repository at this point in the history
New YiCAT updates
  • Loading branch information
Suri539 authored Nov 25, 2024
2 parents fb24621 + 9de747c commit 4ac9bd8
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 1 deletion.
58 changes: 58 additions & 0 deletions en-US/dita/RTC-NG/API/api_rte_destroy.dita
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_rte_destroy">
<title><ph keyref="Destroy_Rte"/></title>
<shortdesc id="short"><ph id="shortdesc">Destroys an RTE object.</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="Destroy_Rte"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public synchronized void destroy() throws RteException;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)destroy:(AgoraRteError * _Nullable)error;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">bool Destroy(Error *err = nullptr){
return RteDestroy(&amp;c_rte, err != nullptr ? err->get_underlying_impl() : 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>Since</dt>
<dd>v4.5.0</dd>
</dlentry>
</dl>
<p>This method releases all resources used by the RTE object.</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>Restrictions</title>
<p>None.</p>
</section>
<section id="parameters" deliveryTarget="details">
<title><ph props="cpp apple">Parameters</ph></title>
<parml props="cpp apple">
<plentry conkeyref="SetConfigs_Rte/err">
<pt/>
<pd/>
</plentry>
</parml> </section>
<section id="return_values" props="apple cpp framework">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">When the method call succeeds, there is no return value; when fails, the <xref keyref="AgoraRtcException"/> exception is thrown. You need to catch the exception and handle it accordingly. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></p>
<p props="cpp apple unreal bp electron unity rn cs">Whether the RTE object is successfully destroyed:<ul>
<li><codeph><ph keyref="true"/></codeph>: The RTE object is destroyed.</li>
<li><codeph><ph keyref="false"/></codeph>: The RTE object is not destroyed.</li>
</ul>
</p> </section>
<section props="android" conkeyref="SetAppId/exception"/>
</refbody>
</reference>
8 changes: 7 additions & 1 deletion en-US/dita/RTC-NG/API/class_videoframe.dita
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,13 @@ class VideoFrame {
</plentry>
<plentry id="colorspace">
<pt>colorSpace</pt>
<pd>By default, the color space properties of video frames will apply the Full Range and BT.709 standard configurations. You can configure the settings according your needs for custom video capturing and rendering. See <xref keyref="videocolorspace-link"/>.</pd>
<pd props="ios mac cpp cs unity flutter electron rn unreal bp">By default, the color space properties of video frames will apply the Full Range and BT.709 standard configurations. You can configure the settings according your needs for custom video capturing and rendering. See <xref
keyref="videocolorspace-link"/>.</pd>
<pd props="android hmos">By default, the color space properties of video frames will apply the Full Range and BT.709 standard configurations. You can configure the settings according your needs for custom video capturing and rendering. See <xref
keyref="videocolorspace-link"/>. The methods associated with this parameter are as follows:<ul>
<li><codeph>getColorSpace</codeph>: Get the color space attribute of the video frame.</li>
<li><codeph>setColorSpace</codeph>:Set the color space attribute of the video frame.</li>
</ul></pd>
</plentry>
<plentry props="android hmos">
<pt>sourceType</pt>
Expand Down

0 comments on commit 4ac9bd8

Please sign in to comment.