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

Release/rtc ng/4.5.0 framework #3843

Merged
merged 53 commits into from
Nov 25, 2024
Merged
Changes from 3 commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
775331a
Update keys-rtc-ng-api-blueprint.ditamap
lemon-chen Nov 15, 2024
3d4a73d
add 4.5.0 app methods and enums
lemon-chen Nov 18, 2024
99d28f6
RN/Electron: proto 1 and 3
Nero-Hu Nov 18, 2024
f1ac001
++
Suri539 Nov 18, 2024
59754da
section 1
Suri539 Nov 18, 2024
31eb573
section 3
Suri539 Nov 18, 2024
e8ff300
Electron/RN: proto 2
Nero-Hu Nov 18, 2024
f705ae6
Merge branch 'release/rtc-ng/4.5.0-framework' of https://github.com/A…
Nero-Hu Nov 18, 2024
297eefe
add props for faceshape
Nero-Hu Nov 18, 2024
1349111
add proto
Suri539 Nov 18, 2024
2ef827a
Merge branch 'release/rtc-ng/4.5.0-framework' of github.com:AgoraIO/a…
Suri539 Nov 18, 2024
2aaa70a
add bp keys and prototype
lemon-chen Nov 19, 2024
5c6669d
change key map
lemon-chen Nov 19, 2024
e5db5a2
bp updates
lemon-chen Nov 19, 2024
f7a97b3
add area code for hamonyos
Suri539 Nov 19, 2024
f636ee1
RN: add setExternalRemoteEglContext
Nero-Hu Nov 19, 2024
a88bb65
RN/Electron: add color space
Nero-Hu Nov 19, 2024
818d059
add color space in external video frame
Suri539 Nov 19, 2024
3a62680
more color
Suri539 Nov 19, 2024
95fcaa6
bp keys and framework
lemon-chen Nov 20, 2024
22fecc1
shipei
Nero-Hu Nov 20, 2024
7379bad
fix
Nero-Hu Nov 20, 2024
7312546
450 framework
Suri539 Nov 20, 2024
f96c0da
pr review comment
lemon-chen Nov 20, 2024
19f0e76
done
Suri539 Nov 20, 2024
7254d0c
Merge branch 'release/rtc-ng/4.5.0-framework' into 4.5.0-framework-fyy
Suri539 Nov 20, 2024
2db229b
Merge pull request #3835 from AgoraIO/4.5.0-chenmeng
lemon-chen Nov 20, 2024
8d8085e
Update class_mediarecorderconfiguration.dita
Suri539 Nov 20, 2024
fbe62f0
fix
Nero-Hu Nov 20, 2024
7e8bc4c
Merge pull request #3838 from AgoraIO/4.5.0-framework-fyy
Suri539 Nov 20, 2024
53ffe6b
Merge pull request #3836 from AgoraIO/4.5.0-rnelectron
Nero-Hu Nov 20, 2024
6337543
fix advanced-beauty
Nero-Hu Nov 20, 2024
6b893e9
exclude rte
Suri539 Nov 20, 2024
29ca0e0
Merge branch 'release/rtc-ng/4.5.0-framework' of github.com:AgoraIO/a…
Suri539 Nov 20, 2024
0785662
rn: add setExternalMediaProjection
Nero-Hu Nov 20, 2024
9d7e82b
map reorg
Suri539 Nov 20, 2024
c2dcfbc
unreal and bp api
lemon-chen Nov 20, 2024
58927f3
Merge branch 'release/rtc-ng/4.5.0-framework' of https://github.com/A…
lemon-chen Nov 20, 2024
84c60ed
prototype updates
lemon-chen Nov 21, 2024
43430ff
Create RTC_NG_Release_Blueprint.ditamap
lemon-chen Nov 21, 2024
6f6d418
update unity proto
Suri539 Nov 21, 2024
caf6b1f
Merge branch 'release/rtc-ng/4.5.0-framework' of github.com:AgoraIO/a…
Suri539 Nov 21, 2024
02bf048
add props
Suri539 Nov 21, 2024
4620648
remove hide props for set/getrecordingdevicemute
Suri539 Nov 21, 2024
5401a29
Electron: add get/setRecordingDeviceMute
Nero-Hu Nov 21, 2024
ec05fe9
Merge branch 'release/rtc-ng/4.5.0-framework' of https://github.com/A…
Nero-Hu Nov 21, 2024
2b1cefe
RN/Electron: reorder dualstream and video transcoder
Nero-Hu Nov 21, 2024
9ba5dfb
RN/Electron: move toc_mediaplayer_cache
Nero-Hu Nov 21, 2024
07271cb
Update release_notes.dita
Suri539 Nov 21, 2024
4aab2fd
Merge branch 'release/rtc-ng/4.5.0-framework' of github.com:AgoraIO/a…
Suri539 Nov 21, 2024
9377afb
delete desc about android screen share in release
Suri539 Nov 21, 2024
44ec53e
restore xpr file
Suri539 Nov 25, 2024
f9c5aa3
Merge branch 'master' into release/rtc-ng/4.5.0-framework
Suri539 Nov 25, 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
14 changes: 7 additions & 7 deletions dita/RTC-NG/API/api_irtcengine_getfaceshapeareaoptions.dita
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (AgoraFaceShapeAreaOptions * _Nullable)getFaceShapeAreaOptions:(AgoraFaceShapeArea) area sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(getFaceShapeAreaOptions(_:sourceType:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getFaceShapeAreaOptions(agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA shapeArea, FaceShapeAreaOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int GetFaceShapeAreaOptions(EUABT_FACE_SHAPE_AREA shapeArea, FUABT_FaceShapeAreaOptions& options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
int GetFaceShapeAreaOptions(EUABT_FACE_SHAPE_AREA shapeArea, FUABT_FaceShapeAreaOptions&amp; options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getFaceShapeAreaOptions(
shapeArea: FaceShapeArea,
type?: MediaSourceType
@@ -58,8 +58,8 @@
<title>参数</title>
<parml>
<plentry id="area">
<pt props="android ios">shapeArea</pt>
<pt props="cpp unreal bp unity flutter rn electron cs">area</pt>
<pt props="ios mac">area</pt>
<pt props="android cpp unreal bp unity flutter rn electron cs">shapeArea</pt>
<pd>
<p props="cpp ios mac unreal bp unity flutter electron rn cs">美型部位。详见 <xref keyref="FACE_SHAPE_AREA" />。</p>
<p props="android hmos">美型部位:
@@ -81,7 +81,7 @@
</p>
</pd>
</plentry>
<plentry conkeyref="setFaceShapeAreaOptions/options" props="cpp">
<plentry conkeyref="setFaceShapeAreaOptions/options" props="cpp unreal bp unity cs">
<pt/>
<pd/>
</plentry>
@@ -92,12 +92,12 @@
</parml> </section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="cpp unreal bp electron unity rn cs">
<p props="flutter">方法成功调用时,返回 <apiname keyref="FaceShapeAreaOptions"/> 对象;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="cpp unreal bp unity cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<ul props="apple android">
<ul props="apple android electron rn">
<li>方法调用成功,返回 <apiname keyref="FaceShapeAreaOptions"/> 对象。</li>
<li>方法调用失败,返回 <ph keyref="NULL"/>。</li>
</ul> </section>
10 changes: 5 additions & 5 deletions dita/RTC-NG/API/api_irtcengine_getfaceshapebeautyoptions.dita
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (AgoraFaceShapeBeautyOptions * _Nullable)getFaceShapeBeautyOptions:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(getFaceShapeBeautyOptions(_:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getFaceShapeBeautyOptions(FaceShapeBeautyOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int GetFaceShapeBeautyOptions(FUABT_FaceShapeBeautyOptions & options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
int GetFaceShapeBeautyOptions(FUABT_FaceShapeBeautyOptions &amp; options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getFaceShapeBeautyOptions(
type?: MediaSourceType
): FaceShapeBeautyOptions;</codeblock>
@@ -54,7 +54,7 @@
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry conkeyref="setFaceShapeBeautyOptions/options" props="cpp">
<plentry conkeyref="setFaceShapeBeautyOptions/options" props="cpp unreal bp unity cs">
<pt/>
<pd/>
</plentry>
@@ -66,12 +66,12 @@
</section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p props="flutter">方法成功调用时,无返回值;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="cpp unreal bp electron unity rn cs">
<p props="flutter">方法成功调用时,返回 <apiname keyref="FaceShapeBeautyOptions"/> 对象;方法调用失败时,会抛出 <xref keyref="AgoraRtcException"/> 异常,你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="cpp unreal bp unity cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul>
<ul props="apple android">
<ul props="apple android electron rn">
<li>方法调用成功,返回 <apiname keyref="FaceShapeBeautyOptions"/> 对象。</li>
<li>方法调用失败,返回 <ph keyref="NULL"/>。</li>
</ul> </section>
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@
<dd>v4.5.0</dd>
</dlentry>
</dl>
<note type="attention" props="cpp">该方法仅适用于 Android。</note>
<note type="attention" props="cpp unreal unity rn flutter">该方法仅适用于 Android。</note>
<p>成功调用该方法后,你设置的外部 <codeph>MediaProjection</codeph> 会替换掉 SDK 申请的 <codeph>MediaProjection</codeph> 采集屏幕视频流。</p>
<p>当停止屏幕共享或销毁 <xref keyref="IRtcEngine"/> 时,SDK 会自动释放 MediaProjection。</p>
</section>
@@ -44,7 +44,7 @@
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法需要在 <xref keyref="startScreenCapture"/> 之前调用。</p>
</section>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>在调用该方法前,必须先申请 <codeph>MediaProjection</codeph> 权限。</p>
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/api_irtcengine_setfaceshapeareaoptions.dita
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (int)setFaceShapeAreaOptions:(AgoraFaceShapeAreaOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setFaceShapeAreaOptions(_:sourceType:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setFaceShapeAreaOptions(const FaceShapeAreaOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetFaceShapeAreaOptions(const FUABT_FaceShapeAreaOptions& options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
int SetFaceShapeAreaOptions(const FUABT_FaceShapeAreaOptions&amp; options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setFaceShapeAreaOptions(
options: FaceShapeAreaOptions,
type?: MediaSourceType
@@ -72,7 +72,7 @@
<li>-4:当前设备不支持该功能,可能的原因有:
<ul>
<li>当前设备能力不满足美颜的使用要求,建议更换性能更高的设备。</li>
<li props="android rn unity flutter cs">当前设备版本低于 Android 4.4,不支持该操作,建议更换设备或升级操作系统。</li>
<li props="android rn unity flutter cpp bp unreal">当前设备版本低于 Android 4.4,不支持该操作,建议更换设备或升级操作系统。</li>
</ul>
</li>
</ul>
7 changes: 4 additions & 3 deletions dita/RTC-NG/API/api_irtcengine_setfaceshapebeautyoptions.dita
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (int)setFaceShapeBeautyOptions:(BOOL)enable options:(AgoraFaceShapeBeautyOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setFaceShapeBeautyOptions(_:options:sourceType:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setFaceShapeBeautyOptions(bool enabled, const FaceShapeBeautyOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetFaceShapeBeautyOptions(bool enabled, const FUABT_FaceShapeBeautyOptions& options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
int SetFaceShapeBeautyOptions(bool enabled, const FUABT_FaceShapeBeautyOptions&amp; options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setFaceShapeBeautyOptions(
enabled: boolean,
options: FaceShapeBeautyOptions,
@@ -54,7 +54,8 @@
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<ul>
<li props="android cpp">该方法仅适用于 Android 4.4 及以上版本。</li>
<li props="android">该方法仅适用于 Android 4.4 及以上版本。</li>
<li props="cpp rn unity flutter unreal bp">在 Android 平台上,该方法仅适用于 Android 4.4 及以上版本。</li>
<li>该方法依赖于视频增强动态库 <codeph><ph keyref="clearvision"/></codeph>,如果删除该动态库会导致无法正常开启该功能。</li>
<li>该功能对设备性能要求较高,调用该方法时 SDK 会自动对当前设备能力进行检查。</li>
</ul>
@@ -91,7 +92,7 @@
<li>-4:当前设备不支持该功能,可能的原因有:
<ul>
<li>当前设备能力不满足美颜的使用要求,建议更换性能更高的设备。</li>
<li props="android rn unity flutter cs">当前设备版本低于 Android 4.4,不支持该操作,建议更换设备或升级操作系统。</li>
<li props="android rn unity flutter cpp unreal bp">当前设备版本低于 Android 4.4,不支持该操作,建议更换设备或升级操作系统。</li>
</ul>
</li>
</ul>
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengine_setfiltereffectoptions.dita
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (int)setFilterEffectOptions:(BOOL)enable options:(AgoraFilterEffectOptions* _Nullable)options sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(setFilterEffectOptions(_:options:sourceType:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setFilterEffectOptions(bool enabled, const FilterEffectOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetFilterEffectOptions(bool enabled, const FUABT_FilterEffectOptions & options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
int SetFilterEffectOptions(bool enabled, const FUABT_FilterEffectOptions&amp; options, EUABT_MEDIA_SOURCE_TYPE type = EUABT_MEDIA_SOURCE_TYPE::PRIMARY_CAMERA_SOURCE);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setFilterEffectOptions(
enabled: boolean,
options: FilterEffectOptions,
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setLowlightEnhanceOptions(bool enabled, const LowlightEnhanceOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetLowlightEnhanceOptions(bool enabled, const FUABT_LowlightEnhanceOptions& options, EUABT_MEDIA_SOURCE_TYPE type);</codeblock>
int SetLowlightEnhanceOptions(bool enabled, const FUABT_LowlightEnhanceOptions&amp; options, EUABT_MEDIA_SOURCE_TYPE type);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setLowlightEnhanceOptions(
enabled: boolean,
options: LowlightEnhanceOptions,
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setVideoDenoiserOptions(bool enabled, const VideoDenoiserOptions&amp; options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SetVideoDenoiserOptions(bool enabled, const FUABT_VideoDenoiserOptions& options, EUABT_MEDIA_SOURCE_TYPE type);</codeblock>
int SetVideoDenoiserOptions(bool enabled, const FUABT_VideoDenoiserOptions&amp; options, EUABT_MEDIA_SOURCE_TYPE type);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setVideoDenoiserOptions(
enabled: boolean,
options: VideoDenoiserOptions,
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengine_startlocalaudiomixer.dita
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (int)startLocalAudioMixer:(AgoraLocalAudioMixerConfiguration* _Nonnull)config NS_SWIFT_NAME(startLocalAudioMixer(_:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int startLocalAudioMixer(const LocalAudioMixerConfiguration&amp; config) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int StartLocalAudioMixer(const FUABT_LocalAudioMixerConfiguration& config);</codeblock>
int StartLocalAudioMixer(const FUABT_LocalAudioMixerConfiguration&amp; config);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract startLocalAudioMixer(config: LocalAudioMixerConfiguration): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int StartLocalAudioMixer(LocalAudioMixerConfiguration config);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract startLocalAudioMixer(config: LocalAudioMixerConfiguration): number;</codeblock>
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengine_takesnapshot2.dita
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@
<codeblock props="ios mac">- (NSInteger)takeSnapshotWithConfig:(NSInteger)uid config:(AgoraSnapshotConfig* _Nonnull)config NS_SWIFT_NAME(takeSnapshotWithConfig(_:config:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int takeSnapshot(uid_t uid, const media::SnapshotConfig&amp; config) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int TakeSnapshotWithConfig(int64 uid, const FUABT_SnapshotConfig& config);</codeblock>
int TakeSnapshotWithConfig(int64 uid, const FUABT_SnapshotConfig&amp; config);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract takeSnapshotWithConfig(uid: number, config: SnapshotConfig): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp"> public abstract int TakeSnapshot(uint uid, SnapshotConfig config);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract takeSnapshotWithConfig(uid: number, config: SnapshotConfig): number;</codeblock>
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (int)updateLocalAudioMixerConfiguration:(AgoraLocalAudioMixerConfiguration* _Nonnull)config NS_SWIFT_NAME(updateLocalAudioMixerConfiguration(_:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int updateLocalAudioMixerConfiguration(const LocalAudioMixerConfiguration&amp; config) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int UpdateLocalAudioMixerConfiguration(const FUABT_LocalAudioMixerConfiguration& config);</codeblock>
int UpdateLocalAudioMixerConfiguration(const FUABT_LocalAudioMixerConfiguration&amp; config);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract updateLocalAudioMixerConfiguration(
config: LocalAudioMixerConfiguration
): number;</codeblock>
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengineex_takesnapshotex2.dita
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (NSInteger)takeSnapshotExWithConfig:(AgoraRtcConnection * _Nonnull)connection uid:(NSInteger)uid config:(AgoraSnapshotConfig* _Nonnull)config NS_SWIFT_NAME(takeSnapshotExWithConfig(_:uid:config:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int takeSnapshotEx(const RtcConnection&amp; connection, uid_t uid, const media::SnapshotConfig&amp; config) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int TakeSnapshotWithConfigEx(const FUABT_RtcConnection& connection, int64 uid, const FUABT_SnapshotConfig& config);</codeblock>
int TakeSnapshotWithConfigEx(const FUABT_RtcConnection&amp; connection, int64 uid, const FUABT_SnapshotConfig&amp; config);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract takeSnapshotWithConfigEx(
connection: RtcConnection,
uid: number,
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/class_localaudiomixerconfiguration.dita
Original file line number Diff line number Diff line change
@@ -45,7 +45,7 @@ struct FUABT_LocalAudioMixerConfiguration {
public:

UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
TArray<FUABT_MixedAudioStream> sourceStreams;
TArray&lt;FUABT_MixedAudioStream> sourceStreams;

UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
bool syncWithLocalMic;
19 changes: 18 additions & 1 deletion dita/RTC-NG/API/rtc_api_data_type_unreal.dita
Original file line number Diff line number Diff line change
@@ -42,6 +42,9 @@
<li><xref keyref="EncryptionConfig"/></li>
<li><xref keyref="ExtensionContext"/></li>
<li><xref keyref="ExternalVideoFrame"/></li>
<li props="cn"><xref keyref="FaceShapeAreaOptions"/></li>
<li props="cn"><xref keyref="FaceShapeBeautyOptions"/></li>
<li><xref keyref="FilterEffectOptions"/></li>
<li><xref keyref="FocalLengthInfo"/></li>
<li><xref keyref="ImageTrackOptions"/></li>
<li props="hide"><xref keyref="InjectStreamConfig"/></li>
@@ -52,6 +55,7 @@
<li><xref keyref="LiveStreamAdvancedFeature"/></li>
<li><xref keyref="LiveTranscoding"/></li>
<li props="cn"><xref keyref="LocalAccessPointConfiguration"/></li>
<li><xref keyref="LocalAudioMixerConfiguration"/></li>
<li><xref keyref="LocalAudioStats"/></li>
<li><xref keyref="LocalTranscoderConfiguration"/></li>
<li><xref keyref="LocalSpatialAudioConfig"/></li>
@@ -62,6 +66,7 @@
<li props="cn"><xref keyref="MediaRecorderConfiguration"/></li>
<li><xref keyref="MediaSource"/></li>
<li><xref keyref="Metadata"/></li>
<li><xref keyref="MixedAudioStream"/></li>
<li props="cn"><xref keyref="Music"/></li>
<li props="cn"><xref keyref="MusicCacheInfo"/></li>
<li props="cn"><xref keyref="MusicChartInfo"/></li>
@@ -104,6 +109,7 @@
<li><xref keyref="SegmentationProperty"/></li>
<li><xref keyref="SimulcastStreamConfig"/></li>
<li props="hide"><xref keyref="SIZE"/></li>
<li><xref keyref="SnapshotConfig"/></li>
<li><xref keyref="SpatialAudioParams"/></li>
<li><xref keyref="SpatialAudioZone"/></li>
<li><xref keyref="SrcInfo"/></li>
@@ -162,6 +168,9 @@
<li><xref keyref="EncryptionConfig"/></li>
<li><xref keyref="ExtensionContext"/></li>
<li props="reserve"><xref keyref="ExternalVideoFrame"/></li>
<li props="cn"><xref keyref="FaceShapeAreaOptions"/></li>
<li props="cn"><xref keyref="FaceShapeBeautyOptions"/></li>
<li><xref keyref="FilterEffectOptions"/></li>
<li><xref keyref="FocalLengthInfo"/></li>
<li><xref keyref="ImageTrackOptions"/></li>
<li props="hide"><xref keyref="InjectStreamConfig"/></li>
@@ -224,6 +233,7 @@
<li><xref keyref="SegmentationProperty"/></li>
<li><xref keyref="SimulcastStreamConfig"/></li>
<li props="hide"><xref keyref="SIZE"/></li>
<li><xref keyref="SnapshotConfig"/></li>
<li props="reserve"><xref keyref="SpatialAudioParams"/></li>
<li props="reserve"><xref keyref="SpatialAudioZone"/></li>
<li><xref keyref="SrcInfo"/></li>
@@ -275,6 +285,7 @@
<li><xref keyref="AUDIO_SCENARIO_TYPE"/></li>
<li><xref keyref="AUDIO_SESSION_OPERATION_RESTRICTION"/></li>
<li><xref keyref="AUDIO_TRACK_TYPE"/></li>
<li><xref keyref="AUDIO_SOURCE_TYPE"/></li>
<li><xref keyref="BACKGROUND_SOURCE_TYPE"/></li>
<li><xref keyref="BACKGROUND_BLUR_DEGREE"/></li>
<li><xref keyref="CAMERA_DIRECTION"/></li>
@@ -305,6 +316,8 @@
<li><xref keyref="EXPERIENCE_POOR_REASON"/></li>
<li><xref keyref="EXPERIENCE_QUALITY_TYPE"/></li>
<li><xref keyref="EXTERNAL_VIDEO_SOURCE_TYPE"/></li>
<li props="cn"><xref keyref="FACE_SHAPE_AREA"/></li>
<li props="cn"><xref keyref="FACE_SHAPE_BEAUTY_STYLE"/></li>
<li><xref keyref="FeatureType"/></li>
<li><xref keyref="FRAME_RATE"/></li>
<li><xref keyref="HEADPHONE_EQUALIZER_PRESET"/></li>
@@ -350,6 +363,7 @@
<li><xref keyref="RAW_AUDIO_FRAME_OP_MODE_TYPE"/></li>
<li><xref keyref="RecorderReasonCode"/></li>
<li><xref keyref="RecorderState"/></li>
<li props="cn"><xref keyref="RecorderStreamType"/></li>
<li><xref keyref="REMOTE_AUDIO_STATE_REASON"/></li>
<li><xref keyref="REMOTE_AUDIO_STATE"/></li>
<li><xref keyref="REMOTE_VIDEO_STATE_REASON"/></li>
@@ -420,6 +434,7 @@
<li><xref keyref="AUDIO_SCENARIO_TYPE"/></li>
<li><xref keyref="AUDIO_SESSION_OPERATION_RESTRICTION"/></li>
<li props="reserve"><xref keyref="AUDIO_TRACK_TYPE"/></li>
<li><xref keyref="AUDIO_SOURCE_TYPE"/></li>
<li><xref keyref="BACKGROUND_SOURCE_TYPE"/></li>
<li><xref keyref="BACKGROUND_BLUR_DEGREE"/></li>
<li><xref keyref="CAMERA_DIRECTION"/></li>
@@ -450,6 +465,8 @@
<li props="reserve"><xref keyref="EXPERIENCE_POOR_REASON"/></li>
<li props="reserve"><xref keyref="EXPERIENCE_QUALITY_TYPE"/></li>
<li><xref keyref="EXTERNAL_VIDEO_SOURCE_TYPE"/></li>
<li props="cn"><xref keyref="FACE_SHAPE_AREA"/></li>
<li props="cn"><xref keyref="FACE_SHAPE_BEAUTY_STYLE"/></li>
<li><xref keyref="FeatureType"/></li>
<li props="reserve"><xref keyref="FRAME_RATE"/></li>
<li><xref keyref="HEADPHONE_EQUALIZER_PRESET"/></li>
@@ -542,4 +559,4 @@
</ul>
</section>
</refbody>
</reference>
</reference>
11 changes: 10 additions & 1 deletion dita/RTC-NG/RTC_NG_API_Blueprint.ditamap
Original file line number Diff line number Diff line change
@@ -320,7 +320,9 @@
<topicref keyref="enableContentInspect" toc="no"/>
<topicref keyref="enableContentInspectEx" toc="no"/>
<topicref keyref="takeSnapshot" toc="no"/>
<topicref keyref="takeSnapshot2" toc="no"/>
<topicref keyref="takeSnapshotEx" toc="no"/>
<topicref keyref="takeSnapshotEx2" toc="no"/>
<topicref keyref="onContentInspectResult" toc="no" props="hide"/>
<topicref keyref="onSnapshotTaken" toc="no"/>
</topicref>
@@ -334,8 +336,13 @@
<topicref keyref="onLocalVideoTranscoderError" toc="no"/>
</topicref>
<topicref href="API/toc_video_enhance_option.dita" chunk="to-content">
<topicref keyref="getFaceShapeAreaOptions" toc="no" props="cn"/>
<topicref keyref="getFaceShapeBeautyOptions" toc="no" props="cn"/>
<topicref keyref="setBeautyEffectOptions" toc="no"/>
<topicref keyref="setColorEnhanceOptions" toc="no"/>
<topicref keyref="setFaceShapeAreaOptions" toc="no" props="cn"/>
<topicref keyref="setFaceShapeBeautyOptions" toc="no" props="cn"/>
<topicref keyref="setFilterEffectOptions" toc="no"/>
<topicref keyref="setLowlightEnhanceOptions" toc="no"/>
<topicref keyref="setVideoDenoiserOptions" toc="no"/>
</topicref>
@@ -366,9 +373,11 @@
<topicref keyref="enableInstantMediaRendering" toc="no"/>
<topicref keyref="setLocalRenderMode1" toc="no" props="reserve"/>
<topicref keyref="setLocalRenderMode2" toc="no"/>
<topicref keyref="setLocalRenderTargetFps" toc="no"/>
<topicref keyref="setLocalVideoMirrorMode" toc="no"/>
<topicref keyref="setRemoteRenderMode2" toc="no"/>
<topicref keyref="setRemoteRenderModeEx" toc="no"/>
<topicref keyref="setRemoteRenderTargetFps" toc="no"/>
<topicref keyref="setRenderMode" toc="no"/>
<topicref keyref="setupLocalVideo" toc="no"/>
<topicref keyref="setupRemoteVideo" toc="no"/>
@@ -821,4 +830,4 @@
</topicref>
<topicref href="API/rtc_api_data_type_unreal.dita"/>
</topichead>
</map>
</map>
15 changes: 15 additions & 0 deletions dita/RTC-NG/RTC_NG_API_Unreal.ditamap
Original file line number Diff line number Diff line change
@@ -210,6 +210,11 @@
<topicref keyref="enableSpatialAudio" toc="no"/>
</topicref>
</topicref>
<topicref href="API/toc_audiomixer.dita" chunk="to-content">
<topicref keyref="startLocalAudioMixer" toc="no"/>
<topicref keyref="stopLocalAudioMixer" toc="no"/>
<topicref keyref="updateLocalAudioMixerConfiguration" toc="no"/>
</topicref>
<topicref href="API/toc_audio_raw.dita" chunk="to-content">
<topicref keyref="registerAudioFrameObserver" toc="no"/>
<topicref keyref="setEarMonitoringAudioFrameParameters" toc="no"/>
@@ -316,7 +321,9 @@
<topicref keyref="enableContentInspect" toc="no"/>
<topicref keyref="enableContentInspectEx" toc="no"/>
<topicref keyref="takeSnapshot" toc="no"/>
<topicref keyref="takeSnapshot2" toc="no"/>
<topicref keyref="takeSnapshotEx" toc="no"/>
<topicref keyref="takeSnapshotEx2" toc="no"/>
<topicref keyref="onContentInspectResult" toc="no" props="hide"/>
<topicref keyref="onSnapshotTaken" toc="no"/>
</topicref>
@@ -330,8 +337,13 @@
<topicref keyref="onLocalVideoTranscoderError" toc="no"/>
</topicref>
<topicref href="API/toc_video_enhance_option.dita" chunk="to-content">
<topicref keyref="getFaceShapeAreaOptions" toc="no" props="cn"/>
<topicref keyref="getFaceShapeBeautyOptions" toc="no" props="cn"/>
<topicref keyref="setBeautyEffectOptions" toc="no"/>
<topicref keyref="setColorEnhanceOptions" toc="no"/>
<topicref keyref="setFaceShapeAreaOptions" toc="no" props="cn"/>
<topicref keyref="setFaceShapeBeautyOptions" toc="no" props="cn"/>
<topicref keyref="setFilterEffectOptions" toc="no"/>
<topicref keyref="setLowlightEnhanceOptions" toc="no"/>
<topicref keyref="setVideoDenoiserOptions" toc="no"/>
</topicref>
@@ -362,9 +374,11 @@
<topicref keyref="enableInstantMediaRendering" toc="no"/>
<topicref keyref="setLocalRenderMode1" toc="no"/>
<topicref keyref="setLocalRenderMode2" toc="no"/>
<topicref keyref="setLocalRenderTargetFps" toc="no"/>
<topicref keyref="setLocalVideoMirrorMode" toc="no"/>
<topicref keyref="setRemoteRenderMode2" toc="no"/>
<topicref keyref="setRemoteRenderModeEx" toc="no"/>
<topicref keyref="setRemoteRenderTargetFps" toc="no"/>
<topicref keyref="setRenderMode" toc="no"/>
<topicref keyref="setupLocalVideo" toc="no"/>
<topicref keyref="setupRemoteVideo" toc="no"/>
@@ -396,6 +410,7 @@
<topicref keyref="destroyCustomVideoTrack" toc="no"/>
<topicref keyref="pushEncodedVideoImage" toc="no" props="hide"/>
<topicref keyref="pushVideoFrame" toc="no"/>
<topicref keyref="setExternalRemoteEglContext" toc="no"/>
<topicref keyref="setExternalVideoSource" toc="no"/>
</topicref>
</topicref>