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.

Sign up for GitHub

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

4.5.0 bugfix 1205 #3857

Merged
merged 4 commits into from
Dec 5, 2024
Merged

4.5.0 bugfix 1205 #3857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
623cc68
update
Suri539 Dec 3, 2024
9695432
DOC-3471
Suri539 Dec 3, 2024
104f1c7
add props cn for rte
Suri539 Dec 5, 2024
a1f8ed7
update relations
Suri539 Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion dita/RTC-NG/API/callback_irtcengineeventhandler_onuserjoined.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@
</plentry>
<plentry>
<pt>elapsed</pt>
<pd>从本地用户调用 <apiname keyref="joinChannel2" /> 到该回调触发的延迟（毫秒）。
<pd><ph props="electron flutter rn">从本地用户调用 <apiname keyref="joinChannel2" /> 到该回调触发的延迟（毫秒）。</ph>
<ph props="native bp unity cs unreal">从本地用户调用 <apiname keyref="joinChannel1" /> 或 <apiname keyref="joinChannel2" /> 到该回调触发的延迟（毫秒）。</ph>
</pd>
</plentry>
</parml> </section>
Expand Down
67 changes: 0 additions & 67 deletions dita/RTC-NG/API/class_canvas.dita
View file
Open in desktop
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">该类提供设置播放器视频渲染的方法。</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>自从</dt>
<dd>v4.5.0</dd>
</dlentry>
</dl>
<p/>
</section>
<section id="sub-method">
<title>方法</title>
<parml>
<plentry>
<pt><ph keyref="Canvas_Canvas"/></pt>
<pd>构造一个 Canvas 对象。详见 <xref keyref="Canvas_Canvas"/>。</pd>
</plentry>
<plentry>
<pt><ph keyref="SetConfigs_Canvas"/></pt>
<pd>设置视频的渲染模式。详见 <xref keyref="SetConfigs_Canvas"/>。</pd>
</plentry>
<plentry>
<pt><ph keyref="GetConfigs_Canvas"/></pt>
<pd>获取当前设置的视频渲染模式。详见 <xref keyref="GetConfigs_Canvas"/>。</pd>
</plentry>
<plentry>
<pt><ph keyref="AddView"/></pt>
<pd>添加一个视图。详见 <xref keyref="AddView"/>。</pd>
</plentry>
<plentry>
<pt><ph keyref="RemoveView"/></pt>
<pd>移除一个视图。详见 <xref keyref="RemoveView"/>。</pd>
</plentry>
</parml> </section>
</refbody>
</reference>
94 changes: 48 additions & 46 deletions dita/RTC-NG/API/rtc_api_data_type.dita
View file
Open in desktop
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
Loading
Loading