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 hh #3793

Merged
merged 31 commits into from
Oct 31, 2024
Merged

4.5.0 hh #3793

Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
bd9ab6d
CSD-65366
Nero-Hu Oct 12, 2024
88bf000
CSD-65010
Nero-Hu Oct 12, 2024
20cdf76
CSD-64354
Nero-Hu Oct 14, 2024
2b96b2e
fix wording
Nero-Hu Oct 14, 2024
30c3d3e
fix enable
Nero-Hu Oct 14, 2024
0e3c3cc
fix Lut size note
Nero-Hu Oct 14, 2024
431edfc
fix
Nero-Hu Oct 14, 2024
7f45c81
shift filter 1 & 2
Nero-Hu Oct 17, 2024
03b9805
add type
Nero-Hu Oct 17, 2024
ed1e827
fix typo
Nero-Hu Oct 18, 2024
122497f
NMS-22321
Nero-Hu Oct 18, 2024
eb5c5e9
update position
Nero-Hu Oct 18, 2024
6a67560
update datatype
Nero-Hu Oct 18, 2024
4dfe138
NMS-21559
Nero-Hu Oct 21, 2024
058e1de
TO review comments
Nero-Hu Oct 21, 2024
a292c04
update videodenoise
Nero-Hu Oct 21, 2024
cac3e59
fix publish errors
Nero-Hu Oct 21, 2024
ba15702
fix
Nero-Hu Oct 21, 2024
175c885
update wording
Nero-Hu Oct 21, 2024
b7ae6b1
remove redundant word
Nero-Hu Oct 21, 2024
0807000
remove period
Nero-Hu Oct 22, 2024
b1183ed
update desc
Nero-Hu Oct 24, 2024
e17b93b
fix type/sourcetype
Nero-Hu Oct 28, 2024
b6ec2c5
update links
Nero-Hu Oct 28, 2024
5d08313
peer review fixes
Nero-Hu Oct 28, 2024
b1b70a4
update keys links
Nero-Hu Oct 28, 2024
d6bf99d
revert unnec changes
Nero-Hu Oct 28, 2024
57e191d
update takesnapshot
Nero-Hu Oct 29, 2024
dff08e5
peer review fixes
Nero-Hu Oct 30, 2024
ec24f34
peer review fixes
Nero-Hu Oct 31, 2024
5588f56
add cn props
Nero-Hu Oct 31, 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
11 changes: 3 additions & 8 deletions dita/RTC-NG/API/api_irtcengine_enablevirtualbackground.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,9 @@
<pt props="ios mac">segData</pt>
<pd>背景图像的处理属性。详见 <xref keyref="SegmentationProperty"/>。</pd>
</plentry>
<plentry id="type" props="cpp unreal bp unity rn electron flutter cs">
<pt>type</pt>
<pd>视频源类型。详见 <xref keyref="MEDIA_SOURCE_TYPE"/>。
<note type="attention">在该方法中，该参数仅支持以下两种设置：
<ul>
<li>默认值为 <apiname keyref="PRIMARY_CAMERA_SOURCE"/>。</li>
<li>如果要使用第二个摄像头采集视频，将该参数设置为 <apiname keyref="SECONDARY_CAMERA_SOURCE"/>。</li>
</ul></note></pd>
<plentry conkeyref="setLowlightEnhanceOptions/type" props="cpp unreal bp rn unity electron flutter cs">
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
<pt/>
<pd/>
</plentry>
</parml> </section>
<section id="return_values">
Expand Down
7 changes: 6 additions & 1 deletion dita/RTC-NG/API/api_irtcengine_enablevirtualbackground2.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,12 @@
</plentry>
<plentry id="sourcetype">
<pt props="android apple">sourceType</pt>
<pd>应用效果的媒体源。详见 <xref keyref="MEDIA_SOURCE_TYPE" />。</pd>
<pd>效果应用的媒体源类型。详见 <xref keyref="MEDIA_SOURCE_TYPE" />。
<note type="attention">在该方法中，该参数仅支持以下两种设置：
<ul>
<li>默认值为 <apiname keyref="PRIMARY_CAMERA_SOURCE"/>。</li>
<li>如果要使用自定义采集的视频，将该参数设置为 <apiname keyref="CUSTOM_VIDEO_SOURCE"/>。</li>
</ul></note></pd>
</plentry>
</parml> </section>
<section id="return_values">
Expand Down
92 changes: 92 additions & 0 deletions dita/RTC-NG/API/api_irtcengine_getfaceshapeareaoptions.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_getfaceshapeareaoptions">
<title><ph keyref="getFaceShapeAreaOptions" /></title>
<shortdesc id="short"><ph id="shortdesc">获取美型部位选项。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getFaceShapeAreaOptions"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract FaceShapeAreaOptions getFaceShapeAreaOptions(
int shapeArea, Constants.MediaSourceType sourceType);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<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"/>
<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>自从</dt>
<dd>v4.5.0</dd>
</dlentry>
</dl>
<p>调用该方法可以获取美型部位当前设置的参数信息。</p>
</section>
<section id="scenario" deliveryTarget="details">
<title>适用场景</title>
<p>用户在 App 中打开美型部位和修饰力度菜单时，可以调用该方法获取并刷新当前美型部位选项的值，从而记住用户上次调整的结果并更新 UI。</p>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>请在 <xref keyref="enableVideo" /> 之后调用该方法。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry id="area">
<pt props="android ios">shapeArea</pt>
<pt props="cpp unreal bp unity flutter rn electron cs">area</pt>
<pd>
<p props="cpp ios mac unreal bp unity flutter electron rn cs">美型部位，详见 <xref keyref="FACE_SHAPE_AREA" />。</p>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
<p props="android hmos">美型部位：
<ul>
<li><ph keyref="FACE_SHAPE_AREA_NONE" /> (-1)：（默认）无效部位，美型效果不生效。</li>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
<li><ph keyref="FACE_SHAPE_AREA_HEADSCALE" /> (0)：头部，用于实现小头效果。对应修饰力度范围为 [0,100]，值越大头越小，预设值为 100。</li>
<li><ph keyref="FACE_SHAPE_AREA_FOREHEAD" /> (1)：额头，修饰发际线高度。对应修饰力度范围为 [-100,100]，正值为调高，负值为调低，绝对值越大修饰效果越强，预设值为 50。</li>
<li><ph keyref="FACE_SHAPE_AREA_FACECONTOUR" /> (2)：脸部轮廓，用于实现瘦脸效果。对应修饰力度范围为 [0,100]，值越大瘦脸效果越强，预设值为 10。</li>
<li><ph keyref="FACE_SHAPE_AREA_FACELENGTH" /> (3)：脸部长度，用于实现长脸效果。对应修饰力度范围为 [-100,100]，正值为拉长，负值为变短，绝对值越大修饰效果越强，预设值为 0。</li>
<li><ph keyref="FACE_SHAPE_AREA_FACEWIDTH" /> (4)：脸部宽度，用于实现窄脸效果。对应修饰力度范围为 [0,100]，值越大窄脸效果越强，预设值为 10。</li>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
<li><ph keyref="FACE_SHAPE_AREA_CHEEKBONE" /> (5)：颧骨，修饰颧骨宽度。对应修饰力度范围为 [0,100]，值越大颧骨越窄，预设值为 43。</li>
<li><ph keyref="FACE_SHAPE_AREA_CHEEK" /> (6)：脸颊，修饰脸颊宽度。对应修饰力度范围为 [0,100]，值越大脸颊越窄，预设值为 50。</li>
<li><ph keyref="FACE_SHAPE_AREA_CHIN" /> (7)：下巴，修饰下巴长度。对应修饰力度范围为 [-100,100]，正值为拉长，负值为变短，绝对值越大修饰效果越强，预设值为 -20。</li>
<li><ph keyref="FACE_SHAPE_AREA_EYESCALE" /> (8)：眼睛，用于实现大眼效果。对应修饰力度范围为 [0,100]，值越大，眼睛尺寸越大，预设值为 53，。</li>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
<li><ph keyref="FACE_SHAPE_AREA_NOSELENGTH" /> (9)：鼻子长度，用于实现长鼻效果。对应修饰力度范围为 [-100,100]，正值为拉长，负值为变短，绝对值越大修饰效果越强，预设值为 -10。</li>
<li><ph keyref="FACE_SHAPE_AREA_NOSEWIDTH" /> (10)：鼻子宽度，用于实现瘦鼻效果。对应修饰力度范围为 [-100,100]，正值为变胖/变宽，负值为变瘦/变窄，绝对值越大修饰效果越强，预设值为 72。</li>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
<li><ph keyref="FACE_SHAPE_AREA_MOUTHSCALE" /> (11)：嘴巴，修饰嘴巴尺寸。对应修饰力度范围为 [-100,100]，正值为变大，负值为变小，绝对值越大修饰效果越强，预设值为 20。</li>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
</ul>
</p>
</pd>
</plentry>
<plentry conkeyref="setFaceShapeAreaOptions/options" props="cpp">
<pt/>
<pd/>
</plentry>
<plentry conkeyref="setFilterEffectOptions/type">
<pt />
<pd />
</plentry>
</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="native unreal bp electron unity rn cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
55 changes: 55 additions & 0 deletions dita/RTC-NG/API/api_irtcengine_getfaceshapeareaoptions2.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_getfaceshapeareaoptions2">
<title><ph keyref="getFaceShapeAreaOptions2" /></title>
<shortdesc id="short"><ph id="shortdesc">获取美型部位选项。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getFaceShapeAreaOptions2"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract FaceShapeAreaOptions getFaceShapeAreaOptions(
int shapeArea, Constants.MediaSourceType sourceType);</codeblock>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
<codeblock props="hmos" outputclass="language-arkts"/>
<codeblock props="ios mac" outputclass="language-objectivec">- (AgoraFaceShapeAreaOptions * _Nullable)getFaceShapeAreaOptions:(AgoraFaceShapeArea) area NS_SWIFT_NAME(getFaceShapeAreaOptions(_:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp"></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" conkeyref="getFaceShapeAreaOptions/detailed_desc"/>
<section id="scenario" deliveryTarget="details" conkeyref="getFaceShapeAreaOptions/scenario"/>
<section id="timing" deliveryTarget="details" conkeyref="getFaceShapeAreaOptions/timing"/>
<section id="restriction" deliveryTarget="details" conkeyref="getFaceShapeAreaOptions/restriction"/>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry conkeyref="getFaceShapeAreaOptions/area">
<pt />
<pd />
</plentry>
<plentry conkeyref="setFaceShapeAreaOptions/options" props="cpp">
<pt/>
<pd/>
</plentry>
<plentry conkeyref="setFilterEffectOptions/type">
<pt />
<pd />
</plentry>
</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="native unreal bp electron unity rn cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
69 changes: 69 additions & 0 deletions dita/RTC-NG/API/api_irtcengine_getfaceshapebeautyoptions.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_getfaceshapebeautyoptions">
<title><ph keyref="getFaceShapeBeautyOptions" /></title>
<shortdesc id="short"><ph id="shortdesc">获取美型效果选项。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getFaceShapeBeautyOptions"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract FaceShapeBeautyOptions getFaceShapeBeautyOptions(
Constants.MediaSourceType sourceType);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<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"/>
<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>自从</dt>
<dd>v4.5.0</dd>
</dlentry>
</dl>
<p>调用该方法可以获取美型效果当前设置的参数信息。</p>
</section>
<section id="scenario" deliveryTarget="details">
<title>适用场景</title>
<p>用户在 App 中打开美型风格和风格强度菜单时，可以调用该方法获取并刷新当前美型效果选项的值，从而记住用户上次调整的结果并更新 UI。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>请在 <xref keyref="enableVideo" /> 之后调用该方法。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry conkeyref="setFaceShapeBeautyOptions/options" props="cpp">
<pt/>
<pd/>
</plentry>
<plentry conkeyref="setFilterEffectOptions/type">
<pt />
<pd />
</plentry>
</parml>
</section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
Nero-Hu marked this conversation as resolved.
Show resolved Hide resolved
<p props="flutter">方法成功调用时，无返回值；方法调用失败时，会抛出 <xref keyref="AgoraRtcException"/> 异常，你需要捕获异常并进行处理。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></p>
<ul props="native unreal bp electron unity rn cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
52 changes: 52 additions & 0 deletions dita/RTC-NG/API/api_irtcengine_getfaceshapebeautyoptions2.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_getfaceshapebeautyoptions">
<title><ph keyref="getFaceShapeBeautyOptions" /></title>
<shortdesc id="short"><ph id="shortdesc">获取美型效果选项。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="getFaceShapeBeautyOptions"/>
</keywords>
</metadata>
</prolog>
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract FaceShapeBeautyOptions getFaceShapeBeautyOptions(
Constants.MediaSourceType sourceType);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"/>
<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"/>
<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" conkeyref="getFaceShapeBeautyOptions/detailed_desc"/>
<section id="scenario" deliveryTarget="details" conkeyref="getFaceShapeBeautyOptions/scenario"/>
<section id="timing" deliveryTarget="details" conkeyref="getFaceShapeBeautyOptions/timing"/>
<section id="restriction" deliveryTarget="details" conkeyref="getFaceShapeBeautyOptions/restriction"/>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry conkeyref="setFaceShapeBeautyOptions/options" props="cpp">
<pt/>
<pd/>
</plentry>
<plentry conkeyref="setFilterEffectOptions/type">
<pt />
<pd />
</plentry>
</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="native unreal bp electron unity rn cs">
<li>0: 方法调用成功。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
</reference>
Loading
Loading