Skip to content

Commit feef55b

Browse files
authored
4.6.0 non-aidoc (#3957)
* fix doc comments * renew token * delete APIs * add deprecated apis * Update rtc_api_sunset.dita * dual stream mode * update * update desc * update * update sunset api
1 parent b807dbe commit feef55b

12 files changed

+187
-71
lines changed

dita/RTC-NG/API/api_irtcengine_registerlocaluseraccount.dita

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
</p>
4141
<note type="attention">
4242
<ul>
43+
<li>自 v4.6.0 起,SDK 不再自动将 Int UID 映射到注册 User Account 时使用的 String <codeph>userAccount</codeph>。如果你希望使用注册时的原始 String <codeph>userAccount</codeph> 加入频道,请调用 <xref keyref="joinChannelWithUserAccount2" /> 方法加入频道,不要调用 <xref keyref="joinChannel2"/> 并传入通过该方法获取的 Int UID 加入频道。</li>
4344
<li>请确保在该方法中设置的 <parmname>userAccount</parmname> 在频道中的唯一性。</li>
4445
<li>为保证通信质量,请确保频道内使用同一类型的数据标识用户身份。即同一频道内需要统一使用 UID 或 User Account。如果有用户通过 Web SDK 加入频道,请确保 Web 加入的用户也是同样类型。</li>
4546
</ul> </note>

dita/RTC-NG/API/api_irtcengine_renewtoken.dita

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
2727
</section>
2828
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
29-
<p>该方法用于更新 Token。Token 会在一定时间后失效,此时 SDK 将无法和服务器建立连接。</p>
29+
<p>该方法用于更新 Token,成功调用该方法后 SDK 会触发 <xref keyref="onRenewTokenResult"/> 回调。Token 会在一定时间后失效,此时 SDK 将无法和服务器建立连接。</p>
3030
</section>
3131
<section id="timing" deliveryTarget="details">
3232
<title>调用时机</title>

dita/RTC-NG/API/api_irtcengine_setdualstreammode.dita

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<codeblock props="electron" outputclass="language-typescript"/>
2121
<codeblock props="unity cs" outputclass="language-csharp">public abstract int SetDualStreamMode(SIMULCAST_STREAM_MODE mode);</codeblock>
2222
<codeblock props="rn" outputclass="language-typescript"/>
23-
<codeblock props="flutter" outputclass="language-dart"/>
23+
<codeblock props="flutter" outputclass="language-dart"/>
2424
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
2525
</section>
2626
<section id="detailed_desc">
@@ -30,7 +30,7 @@
3030
<dd>v4.0.1</dd>
3131
</dlentry>
3232
</dl>
33-
<p id="desc">SDK 默认在发送端开启小流自适应模式 (<apiname keyref="AUTO_SIMULCAST_STREAM"/>),即发送端不主动发送小流,<b>主播身份</b>的接收端可以调用 <xref keyref="setRemoteVideoStreamType"/> 发起小流申请,发送端收到申请后开始自动发送小流。<ul>
33+
<p id="desc">默认情况下,SDK 在发送端启用小流自适应模式 (<apiname keyref="AUTO_SIMULCAST_STREAM"/>)。该模式下,发送端会根据订阅端用户的下行网络质量,自动决定发送或停止发送小流。若将 <parmname>mode</parmname> 设置为其他模式或显式配置了小流的宽度、高度、码率、帧率,则此自适应功能会失效。<ul>
3434
<li>如果你想修改此行为,可以调用该方法并修改 <parmname>mode</parmname> 为 <apiname keyref="DISABLE_SIMULCAST_STREAM"/>(始终不发送小流)或 <apiname keyref="ENABLE_SIMULCAST_STREAM"/>(始终发送小流)。</li>
3535
<li>如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 <parmname>mode</parmname> 设置为 <apiname keyref="AUTO_SIMULCAST_STREAM"/>。</li></ul></p>
3636
<note id="note" props="android cpp apple framework">该方法和 <xref keyref="enableDualStreamMode"/> 的区别与联系如下:

dita/RTC-NG/API/api_irtcengine_setremotevideostreamtype.dita

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
</dlentry>
4343
</dl>
4444
<p id="desc1">取决于发送端的默认行为和调用 <xref keyref="setDualStreamMode2"/> 的具体设置,接收端调用该方法分为以下几种情况:<ul>
45-
<li>SDK 默认在发送端开启小流自适应模式 (<apiname keyref="AUTO_SIMULCAST_STREAM"/>),即:发送端仅发送大流,仅<b>主播身份</b>的接收端可以调用该方法发起小流申请,发送端收到申请后开始自动发送小流,此时频道内所有用户均可调用该方法切换到小流订阅模式。</li>
45+
<li>SDK 默认在发送端开启小流自适应模式 (<apiname keyref="AUTO_SIMULCAST_STREAM"/>)。 该模式下,发送端会根据订阅端用户的下行网络质量,自动决定发送或停止发送小流。若将 <parmname>mode</parmname> 设置为其他模式,或显式配置了小流的宽度、高度、码率、帧率,则此自适应功能会失效。</li>
4646
<li>当发送端调用 <apiname keyref="setDualStreamMode2"/> 并将 <parmname>mode</parmname> 设置为 <apiname keyref="DISABLE_SIMULCAST_STREAM"/>(始终不发送小流),则调用该方法不生效。</li>
4747
<li>当发送端调用 <apiname keyref="setDualStreamMode2"/> 并将 <parmname>mode</parmname> 设置为 <apiname keyref="ENABLE_SIMULCAST_STREAM"/>(始终发送小流),则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。</li></ul></p>
4848
<p id="desc2">在接收视频小流时,SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。</p>

dita/RTC-NG/API/class_remotevideostats.dita

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25,41 +25,41 @@
2525
public long publishDuration;
2626
}</codeblock>
2727
<codeblock props="hmos" outputclass="language-arkts">export class RemoteVideoStats {
28-
28+
2929
public uid:number = 0;
30-
30+
3131
public delay:number = 0;
32-
32+
3333
public e2eDelay:number = 0;
34-
34+
3535
public width:number = 0;
36-
36+
3737
public height:number = 0;
38-
38+
3939
public receivedBitrate:number = 0;
40-
40+
4141
public decoderOutputFrameRate:number = 0;
42-
42+
4343
public rendererOutputFrameRate:number = 0;
44-
44+
4545
public frameLossRate:number = 0;
46-
46+
4747
public packetLossRate:number = 0;
48-
48+
4949
public rxStreamType:number = 0;
50-
50+
5151
public totalFrozenTime:number = 0;
52-
52+
5353
public frozenRate:number = 0;
54-
54+
5555
public avSyncTimeMs:number = 0;
56-
56+
5757
public totalActiveTime:bigint = BigInt(0);
58-
58+
5959
public publishDuration:bigint = BigInt(0);
60-
60+
6161
public mosValue:number = 0;
62-
62+
6363
public rxVideoBytes:number = 0;
6464
}</codeblock>
6565
<codeblock props="ios mac" outputclass="language-objectivec">__attribute__((visibility("default"))) @interface AgoraRtcRemoteVideoStats : NSObject
@@ -69,7 +69,6 @@
6969
@property(assign, nonatomic) NSUInteger width;
7070
@property(assign, nonatomic) NSUInteger height;
7171
@property(assign, nonatomic) NSUInteger receivedBitrate;
72-
@property(assign, nonatomic) NSUInteger receivedFrameRate;
7372
@property(assign, nonatomic) AgoraVideoStreamType rxStreamType;
7473
@property(assign, nonatomic) NSInteger decoderOutputFrameRate;
7574
@property(assign, nonatomic) NSInteger rendererOutputFrameRate;
@@ -392,10 +391,6 @@ class RemoteVideoStats {
392391
<pt>receivedBitrate</pt>
393392
<pd>(上次统计后)接收到的码率(Kbps)。</pd>
394393
</plentry>
395-
<plentry props="ios mac">
396-
<pt>receivedFramerate</pt>
397-
<pd>(上次统计后)接收到的帧率 (fps)。</pd>
398-
</plentry>
399394
<plentry>
400395
<pt>decoderOutputFrameRate</pt>
401396
<pd>远端视频解码器的输出帧率,单位为 fps。</pd>

0 commit comments

Comments
 (0)