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

J api batch6,7 #3706

Merged
merged 13 commits into from
Jul 22, 2024
Merged

J api batch6,7 #3706

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8a72670
+
jinyuagora Jul 8, 2024
cb9704b
setEffectsVolume
jinyuagora Jul 9, 2024
d76307d
setVolumeOfEffect
jinyuagora Jul 9, 2024
be218a4
unloadEffect
jinyuagora Jul 9, 2024
46b6357
switchCamera 1、2
jinyuagora Jul 15, 2024
1aa8f07
setCameraCapturerConfiguration
jinyuagora Jul 15, 2024
7f71de9
isCameraZoomSupported
jinyuagora Jul 15, 2024
eefc3dd
setCameraAutoFocusFaceModeEnabled
jinyuagora Jul 15, 2024
ebbbaae
getCurrentMonotonicTimeInMs
jinyuagora Jul 15, 2024
deeab17
minor fix
jinyuagora Jul 16, 2024
b92f27f
+
jinyuagora Jul 16, 2024
fa65420
Update api_irtcengine_unloadeffect.dita
jinyuagora Jul 16, 2024
85a05b2
Update api_irtcengine_setcameracapturerconfiguration.dita
jinyuagora Jul 18, 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
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_irtcengine_adjustuserplaybacksignalvolume.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>你可以在通话中调用该方法调节指定远端用户在本地播放的音量。如需调节多个用户在本地播放的音量，则需多次调用该方法。</p>
<p id="desc">你可以在通话中调用该方法调节指定远端用户在本地播放的音量。如需调节多个用户在本地播放的音量，则需多次调用该方法。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
Expand Down
17 changes: 12 additions & 5 deletions dita/RTC-NG/API/api_irtcengine_getcurrentmonotonictimeinms.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,14 @@
<codeblock props="hmos" outputclass="language-arkts">public abstract getCurrentMonotonicTimeInMs(): number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int64_t)getCurrentMonotonicTimeInMs NS_SWIFT_NAME(getCurrentMonotonicTimeInMs());</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int64_t getCurrentMonotonicTimeInMs() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int64 GetCurrentMonotonicTimeInMs();</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int64 GetCurrentMonotonicTimeInMs();</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getCurrentMonotonicTimeInMs(): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract long GetCurrentMonotonicTimeInMs();</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract getCurrentMonotonicTimeInMs(): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;int> getCurrentMonotonicTimeInMs();</codeblock> </p>
</section>
<section id="detailed_desc">
<title>详情</title>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<dl outputclass="since">
<dlentry props="native">
<dt>自从</dt>
Expand All @@ -35,10 +34,18 @@
<p>Monotonic Time 是指一个单调递增的时间序列，它的值会随着时间的推移而增加。单位为毫秒。</p>
<p>在自定义视频采集、自定义音频采集场景中，为确保音视频同步，声网建议你调用该方法获取 SDK 当前的 Monotonic Time 后，将该值传入采集的视频帧（<xref keyref="VideoFrame"/>）、音频帧（<xref keyref="AudioFrame"/>）的时间戳参数。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="return_values">
<title>返回值</title>
<ul>
<li props="native unreal bp electron unity rn flutter">≥0: 方法调用成功，返回 SDK 当前的 Monotonic Time（毫秒）。</li>
<li>≥ 0: 方法调用成功，返回 SDK 当前的 Monotonic Time（毫秒）。</li>
<li>&lt; 0: 方法调用失败。<ph props="cn">详见<xref keyref="error-code-link"/>了解详情和解决建议。</ph></li>
</ul> </section>
</refbody>
Expand Down
20 changes: 12 additions & 8 deletions dita/RTC-NG/API/api_irtcengine_iscamerazoomsupported.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,25 @@
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)isCameraZoomSupported;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual bool isCameraZoomSupported() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
bool IsCameraZoomSupported();</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract isCameraZoomSupported(): boolean;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract bool IsCameraZoomSupported();</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract isCameraZoomSupported(): boolean;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;bool&gt; isCameraZoomSupported();</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<note type="attention">
<ul>
<li props="cpp unreal bp unity flutter cs">该方法仅适用于 Android 和 iOS。</li>
<li conkeyref="isCameraExposureSupported/sequence" />
</ul></note> </section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<note type="attention" props="cpp unreal bp unity flutter">该方法仅适用于 Android 和 iOS。</note>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法必须在 SDK 触发 <xref keyref="onLocalVideoStateChanged"/> 回调，返回本地视频状态为 <apiname keyref="LOCAL_VIDEO_STREAM_STATE_ENCODING"/> (2) 之后调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="return_values">
<title>返回值</title>
<ul>
Expand Down
33 changes: 16 additions & 17 deletions dita/RTC-NG/API/api_irtcengine_setcameraautofocusfacemodeenabled.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,35 +16,34 @@
<codeblock props="android" outputclass="language-java">public abstract int setCameraAutoFocusFaceModeEnabled(boolean enabled);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0;
</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int SetCameraAutoFocusFaceModeEnabled(bool enabled);</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int SetCameraAutoFocusFaceModeEnabled(bool enabled);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int SetCameraAutoFocusFaceModeEnabled(bool enabled);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setCameraAutoFocusFaceModeEnabled(bool enabled);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<p props="android hmos">SDK 默认关闭人脸自动对焦。如需自行设置人脸自动对焦，请调用该方法。</p>
<p props="ios">SDK 默认开启人脸自动对焦。如需自行设置人脸自动对焦，请调用该方法。</p>
<p props="rn flutter">SDK 默认在 Android 平台关闭人脸自动对焦，在 iOS 平台开启人脸自动对焦。如需自行设置人脸自动对焦，请调用该方法。</p>
<note type="attention">
<ul>
<li props="cpp unreal bp unity flutter cs">该方法仅适用于 Android 和 iOS。</li>
<li conkeyref="setCameraExposureFactor/sequence" />
</ul></note> </section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p props="android">SDK 默认关闭人脸自动对焦。如需开启人脸自动对焦，请调用该方法。</p>
<p props="ios">SDK 默认开启人脸自动对焦。如需关闭人脸自动对焦，请调用该方法。</p>
<p props="cpp unreal bp flutter unity rn">SDK 默认在 Android 平台关闭人脸自动对焦，在 iOS 平台开启人脸自动对焦。如需自行设置人脸自动对焦，请调用该方法。</p>
<note type="attention" props="cpp unreal bp unity flutter">该方法仅适用于 Android 和 iOS。</note>
</section>
<section id="timing" deliveryTarget="details" conkeyref="isCameraZoomSupported/timing"/>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
<pt props="android cpp unreal bp unity rn flutter electron cs">enabled</pt>
<pt props="android cpp framework">enabled</pt>
<pt props="ios">enable</pt>
<pd>
<p>是否开启人脸对焦：

<ul>
<li><codeph><ph keyref="true" /></codeph>: 开启人脸对焦功能。</li>
<li><codeph><ph keyref="false" /></codeph>: 关闭人脸对焦功能。</li>
Expand Down
31 changes: 17 additions & 14 deletions dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
<codeblock props="hmos" outputclass="language-arkts">public abstract setCameraCapturerConfiguration(config: CameraCapturerConfiguration): number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)setCameraCapturerConfiguration:(AgoraCameraCapturerConfiguration * _Nullable)config;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration&amp; config) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int SetCameraCapturerConfiguration(const FCameraCapturerConfiguration&amp; config);</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int SetCameraCapturerConfiguration(const FCameraCapturerConfiguration&amp; config);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setCameraCapturerConfiguration(
config: CameraCapturerConfiguration
): number;</codeblock>
Expand All @@ -30,22 +30,25 @@
CameraCapturerConfiguration config);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<note type="attention">
<ul>
<li props="cpp unreal bp unity flutter">该方法仅适用于 Android 和 iOS。</li>
<li>该方法必须在开启本地摄像头采集前调用，如 <xref keyref="startPreview2"/> 和 <xref keyref="joinChannel2"/> 前调用。</li>
<li props="android ios cpp unreal bp flutter unity rn">在调整摄像头的焦距配置前，建议先调用 <xref keyref="queryCameraFocalLengthCapability"/> 查询设备支持的焦距能力，再根据查询结果进行配置。</li>
<li props="android cpp unreal bp flutter unity rn">由于部分 Android 设备的限制，即使根据 <apiname keyref="queryCameraFocalLengthCapability"/> 的查询结果设置焦距类型，设置结果也可能不生效。</li>
</ul></note> </section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<note type="attention" props="cpp unreal bp unity flutter">该方法仅适用于 Android 和 iOS。</note>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法必须在开启本地摄像头采集前调用，如 <xref keyref="startPreview2"/> 和 <xref keyref="joinChannel2"/> 前调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>在调整摄像头的焦距配置前，建议先调用 <xref keyref="queryCameraFocalLengthCapability"/> 查询设备支持的焦距能力，再根据查询结果进行配置。</p>
jinyuagora marked this conversation as resolved.
Show resolved Hide resolved
<p props="android cpp unreal bp flutter unity rn">由于部分 Android 设备的限制，即使根据 <apiname keyref="queryCameraFocalLengthCapability"/> 的查询结果设置焦距类型，设置结果也可能不生效。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry props="native unreal bp flutter unity rn cs">
<plentry>
<pt>config</pt>
<pd>摄像头采集配置，详见 <xref keyref="CameraCapturerConfiguration" />。
<note props="cpp flutter unreal bp unity cs">在该方法中，不需要设置 <parmname>deviceId</parmname> 参数。</note></pd>
<note props="ios cpp unreal bp flutter unity rn" type="attention">在该方法中，不需要设置 <parmname>deviceId</parmname> 参数。</note></pd>
</plentry>
</parml> </section>
<section id="return_values">
Expand Down
18 changes: 12 additions & 6 deletions dita/RTC-NG/API/api_irtcengine_seteffectsvolume.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,24 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (int)setEffectsVolume:(NSInteger)volume;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setEffectsVolume(int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int SetEffectsVolume(int volume);</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int SetEffectsVolume(int volume);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setEffectsVolume(volume: number): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int SetEffectsVolume(int volume);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract setEffectsVolume(volume: number): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setEffectsVolume(int volume);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<note type="attention">该方法需要在 <xref keyref="playEffect3" /> 后调用。</note> </section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title"/>
jinyuagora marked this conversation as resolved.
Show resolved Hide resolved
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法需要在 <xref keyref="playEffect3" /> 后调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
17 changes: 13 additions & 4 deletions dita/RTC-NG/API/api_irtcengine_setvolumeofeffect.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_setvolumeofeffect">
<title><ph keyref="setVolumeOfEffect" /></title>
<shortdesc id="short"><ph id="shortdesc">实时调整音效文件的播放音量。</ph></shortdesc>
<shortdesc id="short"><ph id="shortdesc">设置指定音效文件的播放音量。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
Expand All @@ -20,15 +20,24 @@
withVolume:(int)volume;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setVolumeOfEffect(int soundId, int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int SetVolumeOfEffect(int soundId, int volume);</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|RtcEngineProxy&quot;)
int SetVolumeOfEffect(int soundId, int volume);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract setVolumeOfEffect(soundId: number, volume: number): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int SetVolumeOfEffect(int soundId, int volume);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract setVolumeOfEffect(soundId: number, volume: number): number;</codeblock>
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setVolumeOfEffect({required int soundId, required int volume});</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="parameters">
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title"/>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法需要在 <xref keyref="playEffect3" /> 后调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
Expand Down
Loading
Loading