Skip to content

Commit

Permalink
Merge pull request #3859 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
Suri539 authored Dec 5, 2024
2 parents 2258285 + 524c880 commit 57729c2
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 114 deletions.
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
</plentry>
<plentry>
<pt>elapsed</pt>
<pd>Time delay (ms) from the local user calling <apiname keyref="joinChannel2" /> until this callback is triggered.</pd>
<pd><ph props="electron flutter rn">Time delay (ms) from the local user calling <apiname keyref="joinChannel2" /> until this callback is triggered. </ph><ph props="native bp unity cs unreal">Time delay (ms) from the local user calling <apiname keyref="joinChannel1" /> or <apiname keyref="joinChannel2" /> until this callback is triggered.</ph></pd>
</plentry>
</parml> </section>
</refbody>
Expand Down
67 changes: 0 additions & 67 deletions en-US/dita/RTC-NG/API/class_canvas.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,71 +3,4 @@
<reference id="class_canvas">
<title><ph keyref="Canvas"/></title>
<shortdesc id="short"><ph id="shortdesc">This class provides methods for video rendering.</ph></shortdesc>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public class Canvas {
public Canvas(Rte rte, CanvasInitialConfig config);
public void addView(View view, ViewConfig viewConfig) throws RteException;
public void removeView(View view, ViewConfig viewConfig) throws RteException;
public void getConfigs(CanvasConfig config) throws RteException;
public void setConfigs(CanvasConfig config) throws RteException;
}</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">@interface AgoraRteCanvas : NSObject
- (instancetype _Nonnull)initWithRte:(AgoraRte* _Nonnull)rte initialConfig:(AgoraRteCanvasInitialConfig * _Nullable)config;
- (BOOL)getConfigs:(AgoraRteCanvasConfig* _Nonnull)config error:(AgoraRteError* _Nullable)error;
- (BOOL)setConfigs:(AgoraRteCanvasConfig* _Nonnull)config error:(AgoraRteError* _Nullable)error;
- (BOOL)addView:(AgoraRteView * _Nonnull)view config:(AgoraRteViewConfig* _Nullable)config error:(AgoraRteError* _Nullable)error;
- (BOOL)removeView:(AgoraRteView * _Nonnull)view config:(AgoraRteViewConfig* _Nullable)config error:(AgoraRteError* _Nullable)error;
@end</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">class Canvas {
public:
Canvas(Rte *rte, CanvasInitialConfig *initial_config);
bool GetConfigs(CanvasConfig *config, Error *err);
bool SetConfigs(CanvasConfig *config, Error *err);
bool AddView(View *view, ViewConfig *config, rte::Error *err)
bool RemoveView(View *view, ViewConfig *config, rte::Error *err);

};</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">
<dl outputclass="since">
<dlentry props="native">
<dt>Since</dt>
<dd>v4.5.0</dd>
</dlentry>
</dl>
<p/>
</section>
<section id="sub-method">
<title>Method</title>
<parml>
<plentry>
<pt><ph keyref="Canvas_Canvas"/></pt>
<pd>Creates a Canvas object. See <xref keyref="Canvas_Canvas"/>.</pd>
</plentry>
<plentry>
<pt><ph keyref="SetConfigs_Canvas"/></pt>
<pd>Sets the vide render mode. See <xref keyref="SetConfigs_Canvas"/>.</pd>
</plentry>
<plentry>
<pt><ph keyref="GetConfigs_Canvas"/></pt>
<pd>Gets the current video render mode. See <xref keyref="GetConfigs_Canvas"/>.</pd>
</plentry>
<plentry>
<pt><ph keyref="AddView"/></pt>
<pd>Adds a view. See <xref keyref="AddView"/>.</pd>
</plentry>
<plentry>
<pt><ph keyref="RemoveView"/></pt>
<pd>Removes a view. See <xref keyref="RemoveView"/>.</pd>
</plentry>
</parml> </section>
</refbody>
</reference>
94 changes: 48 additions & 46 deletions en-US/dita/RTC-NG/API/rtc_api_data_type.dita
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<li><xref keyref="BeautyOptions"/></li>
<li><xref keyref="CameraCapturerConfiguration"/></li>
<li><xref keyref="CacheStatistics"/></li>
<li><xref keyref="CanvasConfig"/></li>
<li props="cn"><xref keyref="CanvasConfig"/></li>
<li><xref keyref="ChannelMediaInfo"/></li>
<li><xref keyref="ChannelMediaOptions"/></li>
<li><xref keyref="ChannelMediaRelayConfiguration"/></li>
Expand All @@ -31,7 +31,7 @@
<li><xref keyref="ColorEnhanceOptions"/></li>
<li><xref keyref="CodecCapInfo"/></li>
<li><xref keyref="CodecCapLevels"/></li>
<li><xref keyref="Config"/></li>
<li props="cn"><xref keyref="Config"/></li>
<li><xref keyref="ContentInspectConfig"/></li>
<li><xref keyref="ContentInspectModule"/></li>
<li><xref keyref="DataStreamConfig"/></li>
Expand All @@ -42,7 +42,7 @@
<li><xref keyref="EncodedAudioFrameInfo"/></li>
<li><xref keyref="EncodedVideoFrameInfo"/></li>
<li><xref keyref="EncryptionConfig"/></li>
<li><xref keyref="Error"/></li>
<li props="cn"><xref keyref="Error"/></li>
<li><xref keyref="ExtensionContext"/></li>
<li><xref keyref="ExternalVideoFrame"/></li>
<li props="cn"><xref keyref="FaceShapeAreaOptions"/></li>
Expand Down Expand Up @@ -90,6 +90,7 @@
<li props="cn"><xref keyref="MusicContentCenterConfiguration"/></li>
<li props="hide"><xref keyref="MvProperty"/></li>
<li><xref keyref="Packet"/></li>
<li props="cn"><xref keyref="PlayerConfig"/></li>
<li><xref keyref="PlayerPlaybackStats"/></li>
<li><xref keyref="PlayerStreamInfo"/></li>
<li><xref keyref="PlayerUpdatedInfo"/></li>
Expand All @@ -104,8 +105,8 @@
<li><xref keyref="RtcConnection"/></li>
<li><xref keyref="RtcImage"/></li>
<li><xref keyref="RtcStats"/></li>
<li><xref keyref="RtePlayerInfo"/></li>
<li><xref keyref="RtePlayerStats"/></li>
<li props="cn"><xref keyref="RtePlayerInfo"/></li>
<li props="cn"><xref keyref="RtePlayerStats"/></li>
<li><xref keyref="ScreenCaptureConfiguration"/></li>
<li><xref keyref="ScreenCaptureParameters"/></li>
<li><xref keyref="ScreenCaptureParameters2"/></li>
Expand Down Expand Up @@ -154,7 +155,7 @@
<li><xref keyref="BeautyOptions"/></li>
<li><xref keyref="CacheStatistics"/></li>
<li><xref keyref="CameraCapturerConfiguration"/></li>
<li><xref keyref="CanvasConfig"/></li>
<li props="cn"><xref keyref="CanvasConfig"/></li>
<li><xref keyref="ChannelMediaInfo"/></li>
<li><xref keyref="ChannelMediaOptions"/></li>
<li><xref keyref="ChannelMediaRelayConfiguration"/>
Expand All @@ -173,19 +174,18 @@
<li><xref keyref="ContentInspectModule"/></li>
<li><xref keyref="ClientRoleOptions"/></li>
<li props="cn"><xref keyref="ClimaxSegment"/></li>
<li><xref keyref="CanvasConfig"/></li>
<li><xref keyref="CodecCapInfo"/></li>
<li><xref keyref="CodecCapLevels"/></li>
<li><xref keyref="ColorEnhanceOptions"/></li>
<li><xref keyref="Config"/></li>
<li props="cn"><xref keyref="Config"/></li>
<li><xref keyref="DataStreamConfig"/></li>
<li><xref keyref="DeviceInfo"/></li>
<li><xref keyref="DirectCdnStreamingMediaOptions"/></li>
<li><xref keyref="DirectCdnStreamingStats"/></li>
<li><xref keyref="EchoTestConfiguration"/></li>
<li><xref keyref="EncodedVideoFrameInfo"/></li>
<li><xref keyref="EncryptionConfig"/></li>
<li><xref keyref="Error"/></li>
<li props="cn"><xref keyref="Error"/></li>
<li><xref keyref="ExtensionContext"/></li>
<li><xref keyref="ExternalVideoFrame"/></li>
<li props="cn"><xref keyref="FaceShapeAreaOptions"/></li>
Expand Down Expand Up @@ -237,6 +237,7 @@
<li><xref keyref="Metadata"/></li>
<li><xref keyref="MixedAudioStream"/></li>
<li props="cn"><xref keyref="MusicCacheInfo"/></li>
<li props="cn"><xref keyref="PlayerConfig"/></li>
<li><xref keyref="PlayerPlaybackStats"/></li>
<li><xref keyref="PlayerStreamInfo"/></li>
<li><xref keyref="PlayerUpdatedInfo"/></li>
Expand All @@ -253,10 +254,9 @@
<li><xref keyref="RtcConnection"/></li>
<li><xref keyref="RtcImage"/></li>
<li><xref keyref="RtcStats"/></li>
<li><xref keyref="RteErrorCode"/></li>
<li><xref keyref="RteException"/></li>
<li><xref keyref="RtePlayerInfo"/></li>
<li><xref keyref="RtePlayerStats"/></li>
<li props="cn"><xref keyref="RteException"/></li>
<li props="cn"><xref keyref="RtePlayerInfo"/></li>
<li props="cn"><xref keyref="RtePlayerStats"/></li>
<li><xref keyref="ScreenCaptureParameters2"/></li>
<li><xref keyref="ScreenAudioParameters"/></li>
<li><xref keyref="ScreenVideoParameters"/></li>
Expand Down Expand Up @@ -399,7 +399,7 @@
<li><xref keyref="BeautyOptions"/></li>
<li><xref keyref="CameraCapturerConfiguration"/></li>
<li><xref keyref="CacheStatistics"/></li>
<li><xref keyref="CanvasConfig"/></li>
<li props="cn"><xref keyref="CanvasConfig"/></li>
<li><xref keyref="ChannelMediaInfo"/></li>
<li><xref keyref="ChannelMediaOptions"/></li>
<li><xref keyref="ChannelMediaRelayConfiguration"/>
Expand All @@ -412,7 +412,7 @@
<li><xref keyref="ColorEnhanceOptions"/></li>
<li><xref keyref="CodecCapInfo"/></li>
<li><xref keyref="CodecCapLevels"/></li>
<li><xref keyref="Config"/></li>
<li props="cn"><xref keyref="Config"/></li>
<li><xref keyref="ContentInspectConfig"/></li>
<li><xref keyref="ContentInspectModule"/></li>
<li><xref keyref="DataStreamConfig"/></li>
Expand All @@ -422,7 +422,7 @@
<li><xref keyref="EncodedAudioFrameInfo"/></li>
<li><xref keyref="EncodedVideoFrameInfo"/></li>
<li><xref keyref="EncryptionConfig"/></li>
<li><xref keyref="Error"/></li>
<li props="cn"><xref keyref="Error"/></li>
<li><xref keyref="ExtensionContext"/></li>
<li><xref keyref="ExternalVideoFrame"/></li>
<li props="cn"><xref keyref="FaceShapeAreaOptions"/></li>
Expand Down Expand Up @@ -461,6 +461,7 @@
<li props="cn"><xref keyref="MusicCollection"/></li>
<li props="cn"><xref keyref="MusicContentCenterConfiguration"/></li>
<li props="hide"><xref keyref="MvProperty"/></li>
<li props="cn"><xref keyref="PlayerConfig"/></li>
<li><xref keyref="PlayerStreamInfo"/></li>
<li><xref keyref="PlayerPlaybackStats"/></li>
<li><xref keyref="PlayerUpdatedInfo"/></li>
Expand All @@ -473,8 +474,8 @@
<li><xref keyref="RtcConnection"/></li>
<li><xref keyref="RtcImage"/></li>
<li><xref keyref="RtcStats"/></li>
<li><xref keyref="RtePlayerInfo"/></li>
<li><xref keyref="RtePlayerStats"/></li>
<li props="cn"><xref keyref="RtePlayerInfo"/></li>
<li props="cn"><xref keyref="RtePlayerStats"/></li>
<li><xref keyref="ScreenCaptureParameters2"/></li>
<li><xref keyref="ScreenAudioParameters"/></li>
<li><xref keyref="ScreenVideoParameters"/></li>
Expand Down Expand Up @@ -518,7 +519,7 @@
<li><xref keyref="BeautyOptions"/></li>
<li><xref keyref="CameraCapturerConfiguration"/></li>
<li><xref keyref="CacheStatistics"/></li>
<li><xref keyref="CanvasConfig"/></li>
<li props="cn"><xref keyref="CanvasConfig"/></li>
<li><xref keyref="ChannelMediaInfo"/></li>
<li><xref keyref="ChannelMediaOptions"/></li>
<li><xref keyref="ChannelMediaRelayConfiguration"/>
Expand All @@ -530,7 +531,7 @@
<li><xref keyref="ColorEnhanceOptions"/></li>
<li><xref keyref="CodecCapInfo"/></li>
<li><xref keyref="CodecCapLevels"/></li>
<li><xref keyref="Config"/></li>
<li props="cn"><xref keyref="Config"/></li>
<li><xref keyref="ContentInspectConfig"/></li>
<li><xref keyref="ContentInspectModule"/></li>
<li><xref keyref="DataStreamConfig"/></li>
Expand All @@ -540,7 +541,7 @@
<li><xref keyref="EncodedAudioFrameInfo"/></li>
<li><xref keyref="EncodedVideoFrameInfo"/></li>
<li><xref keyref="EncryptionConfig"/></li>
<li><xref keyref="Error"/></li>
<li props="cn"><xref keyref="Error"/></li>
<li><xref keyref="ExtensionContext"/></li>
<li><xref keyref="ExternalVideoFrame"/></li>
<li props="cn"><xref keyref="FaceShapeAreaOptions"/></li>
Expand Down Expand Up @@ -574,6 +575,7 @@
<li><xref keyref="MixedAudioStream"/></li>
<li><xref keyref="Metadata"/></li>
<li><xref keyref="MediaSource"/></li>
<li props="cn"><xref keyref="PlayerConfig"/></li>
<li><xref keyref="PlayerPlaybackStats"/></li>
<li><xref keyref="PlayerStreamInfo"/></li>
<li><xref keyref="PlayerUpdatedInfo"/></li>
Expand All @@ -586,8 +588,8 @@
<li><xref keyref="RtcConnection"/></li>
<li><xref keyref="RtcImage"/></li>
<li><xref keyref="RtcStats"/></li>
<li><xref keyref="RtePlayerInfo"/></li>
<li><xref keyref="RtePlayerStats"/></li>
<li props="cn"><xref keyref="RtePlayerInfo"/></li>
<li props="cn"><xref keyref="RtePlayerStats"/></li>
<li><xref keyref="ScreenCaptureConfiguration"/></li>
<li><xref keyref="ScreenCaptureSourceInfo"/></li>
<li><xref keyref="ScreenCaptureParameters"/></li>
Expand Down Expand Up @@ -1320,12 +1322,12 @@
<li><xref keyref="RHYTHM_PLAYER_STATE_TYPE"/></li>
<li props="cn"><xref keyref="RteAbrFallbackLayer"/></li>
<li props="cn"><xref keyref="RteAbrSubscriptionLayer"/></li>
<li><xref keyref="RteErrorCode"/></li>
<li><xref keyref="RtePlayerMetadataType"/></li>
<li><xref keyref="RtePlayerEvent"/></li>
<li><xref keyref="RtePlayerState"/></li>
<li><xref keyref="RteVideoMirrorMode"/></li>
<li><xref keyref="RteVideoRenderMode"/></li>
<li props="cn"><xref keyref="RteErrorCode"/></li>
<li props="cn"><xref keyref="RtePlayerMetadataType"/></li>
<li props="cn"><xref keyref="RtePlayerEvent"/></li>
<li props="cn"><xref keyref="RtePlayerState"/></li>
<li props="cn"><xref keyref="RteVideoMirrorMode"/></li>
<li props="cn"><xref keyref="RteVideoRenderMode"/></li>
<li><xref keyref="RTMP_STREAM_LIFE_CYCLE_TYPE"/></li>
<li><xref keyref="RTMP_STREAM_PUBLISH_REASON"/></li>
<li><xref keyref="RTMP_STREAM_PUBLISH_STATE"/></li>
Expand Down Expand Up @@ -1404,11 +1406,11 @@
<li props="cn"><xref keyref="PreloadState"/></li>
<li props="cn"><xref keyref="RteAbrFallbackLayer"/></li>
<li props="cn"><xref keyref="RteAbrSubscriptionLayer"/></li>
<li><xref keyref="RteErrorCode"/></li>
<li><xref keyref="RtePlayerEvent"/></li>
<li><xref keyref="RtePlayerState"/></li>
<li><xref keyref="RteVideoMirrorMode"/></li>
<li><xref keyref="RteVideoRenderMode"/></li>
<li props="cn"><xref keyref="RteErrorCode"/></li>
<li props="cn"><xref keyref="RtePlayerEvent"/></li>
<li props="cn"><xref keyref="RtePlayerState"/></li>
<li props="cn"><xref keyref="RteVideoMirrorMode"/></li>
<li props="cn"><xref keyref="RteVideoRenderMode"/></li>
<li><xref keyref="SCREEN_SCENARIO_TYPE"/></li>
<li><xref keyref="STREAM_FALLBACK_OPTIONS"/></li>
<li><xref keyref="STREAM_PUBLISH_STATE"/></li>
Expand Down Expand Up @@ -1571,12 +1573,12 @@
<li><xref keyref="RHYTHM_PLAYER_STATE_TYPE"/></li>
<li props="cn"><xref keyref="RteAbrFallbackLayer"/></li>
<li props="cn"><xref keyref="RteAbrSubscriptionLayer"/></li>
<li><xref keyref="RteErrorCode"/></li>
<li><xref keyref="RtePlayerMetadataType"/></li>
<li><xref keyref="RtePlayerEvent"/></li>
<li><xref keyref="RtePlayerState"/></li>
<li><xref keyref="RteVideoMirrorMode"/></li>
<li><xref keyref="RteVideoRenderMode"/></li>
<li props="cn"><xref keyref="RteErrorCode"/></li>
<li props="cn"><xref keyref="RtePlayerMetadataType"/></li>
<li props="cn"><xref keyref="RtePlayerEvent"/></li>
<li props="cn"><xref keyref="RtePlayerState"/></li>
<li props="cn"><xref keyref="RteVideoMirrorMode"/></li>
<li props="cn"><xref keyref="RteVideoRenderMode"/></li>
<li><xref keyref="RTMP_STREAM_LIFE_CYCLE_TYPE"/></li>
<li><xref keyref="RTMP_STREAM_PUBLISH_REASON"/></li>
<li><xref keyref="RTMP_STREAM_PUBLISH_STATE"/></li>
Expand Down Expand Up @@ -1711,12 +1713,12 @@
<li><xref keyref="RHYTHM_PLAYER_STATE_TYPE"/></li>
<li props="cn"><xref keyref="RteAbrFallbackLayer"/></li>
<li props="cn"><xref keyref="RteAbrSubscriptionLayer"/></li>
<li><xref keyref="RteErrorCode"/></li>
<li><xref keyref="RtePlayerMetadataType"/></li>
<li><xref keyref="RtePlayerEvent"/></li>
<li><xref keyref="RtePlayerState"/></li>
<li><xref keyref="RteVideoMirrorMode"/></li>
<li><xref keyref="RteVideoRenderMode"/></li>
<li props="cn"><xref keyref="RteErrorCode"/></li>
<li props="cn"><xref keyref="RtePlayerMetadataType"/></li>
<li props="cn"><xref keyref="RtePlayerEvent"/></li>
<li props="cn"><xref keyref="RtePlayerState"/></li>
<li props="cn"><xref keyref="RteVideoMirrorMode"/></li>
<li props="cn"><xref keyref="RteVideoRenderMode"/></li>
<li><xref keyref="RTMP_STREAM_LIFE_CYCLE_TYPE"/></li>
<li><xref keyref="RTMP_STREAM_PUBLISH_REASON"/></li>
<li><xref keyref="RTMP_STREAM_PUBLISH_STATE"/></li>
Expand Down

0 comments on commit 57729c2

Please sign in to comment.