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

bugfix 0801 #3728

Merged
merged 19 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
23 changes: 13 additions & 10 deletions dita/RTC-NG/API/api_irtcengine_setcameracapturerconfiguration.dita
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,19 @@
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">
<p props="native flutter unity rn unreal bp">在调整摄像头的焦距配置前,建议先调用 <xref keyref="queryCameraFocalLengthCapability"/> 查询设备支持的焦距能力,再根据查询结果进行配置。</p>
<p props="android cpp unreal bp flutter unity rn">由于部分 Android 设备的限制,即使根据 <apiname keyref="queryCameraFocalLengthCapability"/> 的查询结果设置焦距类型,设置结果也可能不生效。</p>
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这句是不是更适合放到调用限制里?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

可以

</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>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry props="native unreal bp flutter unity rn cs">
Expand Down
4 changes: 3 additions & 1 deletion dita/RTC-NG/API/api_irtcengine_setlocalrendermode2.dita
Original file line number Diff line number Diff line change
Expand Up @@ -66,14 +66,16 @@
<pt props="ios mac">mirror</pt>
<pd>
<p props="ios mac cpp unreal bp unity flutter rn electron cs">本地视图的镜像模式,详见 <xref keyref="VIDEO_MIRROR_MODE_TYPE" />。
<note type="attention" props="unreal bp" id="mirror">该参数不生效。如需实现镜像显示效果,请在 Unreal Engine 中进行镜像设置。</note>
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

要说怎么设置、或者给个链接啥的么

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

我觉得可以不用,就引擎里自带的,一定要加的话我再去确认下,不过不影响其他平台发

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

刚才忘了发,relations 里也要解放一下 setCameraCapturerConfiguration

<note type="attention" props="unity cs">该参数仅对 SDK 自渲染生效,如果你想要设置视图镜像,可以将 GameObject 的 scaleX 设为 <codeph>-1</codeph> 或 <codeph>+1</codeph>。</note></p>
<p props="android hmos">本地视图的镜像模式。
<ul id="videomirrormodetype">
<li><ph keyref="VIDEO_MIRROR_MODE_AUTO" /> (0):SDK 决定镜像模式。如果你使用前置摄像头,默认启动本地视图镜像模式;如果你启用后置摄像头,默认关闭本地视图镜像模式。</li>
<li><ph keyref="VIDEO_MIRROR_MODE_ENABLED" /> (1):开启本地视图的镜像模式。</li>
<li><ph keyref="VIDEO_MIRROR_MODE_DISABLED" /> (2):关闭本地视图的镜像模式。</li>
</ul> </p>
<note type="attention">如果你使用前置摄像头,默认启动本地用户视图镜像模式;如果你使用后置摄像头,默认关闭本地视图镜像模式。</note> </pd>
<note type="attention">如果你使用前置摄像头,默认启动本地用户视图镜像模式;如果你使用后置摄像头,默认关闭本地视图镜像模式。</note>
</pd>
</plentry>
</parml> </section>
<section id="return_values">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
<ul conkeyref="setLocalRenderMode2/videomirrormodetype">
<li />
</ul> </p>
<note conkeyref="setLocalRenderMode2/mirror" props="unreal bp"/>
</pd>
</plentry>
</parml> </section>
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_irtcengine_setremoterendermode2.dita
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@
<ul conkeyref="setLocalRenderMode2/videomirrormodetype">
<li />
</ul> </p>
<note conkeyref="setLocalRenderMode2/mirror" props="unreal bp"/>
</pd>
</plentry>
</parml> </section>
Expand Down
9 changes: 5 additions & 4 deletions dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,14 @@
</section>
<section id="detailed_desc">
<title>详情</title>
<p id="desc1">SDK 默认在发送端开启小流自适应模式 (<apiname keyref="AUTO_SIMULCAST_STREAM"/>),即:发送端仅发送大流,<b>主播身份</b>的接收端可以调用该方法发起小流申请,发送端收到申请后开始自动发送小流。</p>
<p id="desc1">取决于发送端的默认行为和调用 <xref keyref="setDualStreamMode2"/> 的具体设置,接收端调用该方法分为以下几种情况:<ul>
<li>SDK 默认在发送端开启小流自适应模式 (<apiname keyref="AUTO_SIMULCAST_STREAM"/>),即:发送端仅发送大流,仅<b>主播身份</b>的接收端可以调用该方法发起小流申请,发送端收到申请后开始自动发送小流,此时频道内所有用户均可调用该方法切换到小流订阅模式。</li>
<li>当发送端调用 <apiname keyref="setDualStreamMode2"/> 并将 <parmname>mode</parmname> 设置为 <apiname keyref="DISABLE_SIMULCAST_STREAM"/>(始终不发送小流),则调用该方法不生效。</li>
<li>当发送端调用 <apiname keyref="setDualStreamMode2"/> 并将 <parmname>mode</parmname> 设置为 <apiname keyref="ENABLE_SIMULCAST_STREAM"/>(始终发送小流),则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。</li></ul></p>
<p id="desc2">在接收视频小流时,SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。</p>
<note type="attention"><ul>
<li>该方法在加入频道前后都能调用。</li>
<li>如果发送端已调用 <xref keyref="setDualStreamMode2"/> 并将 <parmname>mode</parmname> 设置为 <apiname keyref="DISABLE_SIMULCAST_STREAM"/>(始终不发送小流),则调用该方法不生效,你需要在发送端重新调用 <apiname keyref="setDualStreamMode2"/> 修改设置。</li>
<li><b>观众角色</b>的接收端调用该方法不生效。</li>
<li>如果既调用了 <apiname keyref="setRemoteVideoStreamType"/>,也调用了 <xref keyref="setRemoteDefaultVideoStreamType"/>,则 SDK 以 <apiname keyref="setRemoteVideoStreamType"/> 中的设置为准。</li></ul></note> </section>
<li>如果既调用了该方法,也调用了 <xref keyref="setRemoteDefaultVideoStreamType"/>,则 SDK 以该方法中的设置为准。</li></ul></note> </section>
<section id="parameters">
<title>参数</title>
<parml>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
<pt>mirrorMode</pt>
<pd>
<p props="ios mac cpp unreal bp unity electron rn flutter cs">远端用户视图的镜像模式,详见 <xref keyref="VIDEO_MIRROR_MODE_TYPE" />。</p>
<note conkeyref="setLocalRenderMode2/mirror" props="unreal bp"/>
<p props="android hmos">远端用户视图的镜像模式:
<ul conkeyref="setLocalRenderMode2/videomirrormodetype">
<li />
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/class_videocanvas.dita
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@ class VideoCanvas {
<pt>mirrorMode</pt>
<pd>
<p props="ios mac cpp unity electron rn flutter cs bp">视图镜像模式,详见 <xref keyref="VIDEO_MIRROR_MODE_TYPE" />。</p>
<note conkeyref="setLocalRenderMode2/mirror" props="unreal bp"/>
<p props="android hmos">
<ul conkeyref="setLocalRenderMode2/videomirrormodetype">
<li/>
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/class_videoencoderconfiguration.dita
Original file line number Diff line number Diff line change
Expand Up @@ -618,6 +618,7 @@ struct FVideoEncoderConfiguration
<pt>mirrorMode</pt>
<pd>
<p props="ios mac cpp framework">发送编码视频时是否开启镜像模式,只影响远端用户看到的视频画面。详见 <xref keyref="VIDEO_MIRROR_MODE_TYPE"/>。</p>
<note conkeyref="setLocalRenderMode2/mirror" props="unreal bp"/>
<p props="android hmos">发送编码视频时是否开启镜像模式,只影响远端用户看到的视频画面。
<ul>
<li><ph keyref="VIDEO_MIRROR_MODE_AUTO" /> (0):SDK 决定镜像模式。默认关闭远端用户的镜像模式。</li>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/enum_audioprocessingchannels.dita
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<p>立体声设置仅在媒体音量下生效。</p>
<p props="cn">如需了解媒体音量和通话音量的区别,<ph props="android ios cpp unreal bp flutter unity rn">详见<xref keyref="volume-type"/>。</ph></p>
</li>
<li props="cpp unreal bp ios rn unity flutter">在 iOS 上,立体声对设备性能要求较高。仅支持在 iOS 14.0 及以上版本的如下设备中实现立体声
<li props="cpp unreal bp ios rn unity flutter">在 iOS 上,实现立体声 iOS 系统版本为 14.0 及以上。最低设备要求如下


<ul>
Expand Down
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/rtc_api_overview.dita
Original file line number Diff line number Diff line change
Expand Up @@ -2211,9 +2211,9 @@
<stentry><xref keyref="switchCamera2"/></stentry>
<stentry><ph conkeyref="switchCamera2/shortdesc"/></stentry>
</strow>
<strow props="ios android hmos cpp unreal bp flutter unity rn">
<strow>
<stentry><xref keyref="setCameraCapturerConfiguration"/></stentry>
<stentry><ph conkeyref="setCameraCapturerConfiguration/shortdesc"/><ph props="cpp unreal bp flutter unity rn">(仅适用于 Android 和 iOS)</ph></stentry>
<stentry><ph conkeyref="setCameraCapturerConfiguration/shortdesc"/></stentry>
</strow>
<strow props="ios android cpp unreal bp flutter unity rn">
<stentry><xref keyref="isCameraZoomSupported"/></stentry>
Expand Down
3 changes: 2 additions & 1 deletion dita/RTC-NG/RTC_NG_API_Electron.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -621,13 +621,14 @@
<topicref href="API/toc_audio_route.dita" chunk="to-content">
<topicref keyref="onAudioRoutingChanged" toc="no"/>
</topicref>
<topicref href="API/toc_pc_video_device_management.dita" chunk="to-content">
<topicref href="API/toc_video_device.dita" chunk="to-content">
<topicref keyref="enumerateVideoDevices" toc="no"/>
<topicref keyref="getCapability" toc="no"/>
<topicref keyref="getDevice_IVideoDeviceManager" toc="no"/>
<topicref keyref="getVideoDeviceManager" toc="no"/>
<topicref keyref="numberOfCapabilities" toc="no"/>
<topicref keyref="setDevice_IVideoDeviceManager" toc="no"/>
<topicref keyref="setCameraCapturerConfiguration" toc="no"/>
<topicref keyref="setCameraDeviceOrientation" toc="no"/>
<topicref keyref="onCameraReady" toc="no"/>
<topicref keyref="onVideoDeviceStateChanged" toc="no"/>
Expand Down
7 changes: 7 additions & 0 deletions dita/RTC-NG/config/keys-rtc-ng-api-electron.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -3407,6 +3407,13 @@
</keydef>
</topichead>
<topichead navtitle="其他视频控制">
<keydef keys="setCameraCapturerConfiguration" href="../API/api_irtcengine_setcameracapturerconfiguration.dita">
Copy link
Collaborator Author

@Cilla-luodan Cilla-luodan Aug 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

还有 mac 是不是也要加

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

是的,electron 找胡师傅加了,mac 我以为本来就有就没和你说

你加一下吧,mac 的 device toc 好像和其他平台不太一样,我不确定加哪里合适,别给你加错了

<topicmeta>
<keywords>
<keyword>setCameraCapturerConfiguration</keyword>
</keywords>
</topicmeta>
</keydef>
<keydef keys="setLocalVideoMirrorMode" href="../API/api_irtcengine_setlocalvideomirrormode.dita">
<topicmeta>
<keywords>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/config/keys-rtc-ng-api-ios.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@
<keydef keys="IBaseSpatialAudioEngine" href="../API/class_ibasespatialaudioengine.dita">
<topicmeta>
<keywords>
<keyword>AgoraBaseSpatialAudioKit</keyword>
<keyword>AgoraSpatialAudioKitBase</keyword>
</keywords>
</topicmeta>
</keydef>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/config/keys-rtc-ng-api-macos.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@
<keydef keys="IBaseSpatialAudioEngine" href="../API/class_ibasespatialaudioengine.dita">
<topicmeta>
<keywords>
<keyword>AgoraBaseSpatialAudioKit</keyword>
<keyword>AgoraSpatialAudioKitBase</keyword>
</keywords>
</topicmeta>
</keydef>
Expand Down