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.4.0 #3703

Merged
merged 33 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
6def737
add codeph
Cilla-luodan Jul 12, 2024
fe57406
ios & mac
Cilla-luodan Jul 12, 2024
adfa4ec
Merge branch 'master' into release/rtc-ng/4.4.0
Cilla-luodan Jul 12, 2024
6637882
fix
Cilla-luodan Jul 12, 2024
dd3456f
Update release_android_ng.md
jinyuagora Jul 12, 2024
26e6d76
1
Cilla-luodan Jul 12, 2024
b932cc1
Merge branch 'release/rtc-ng/4.4.0' of github.com:AgoraIO/agora_doc_s…
Cilla-luodan Jul 12, 2024
10f645b
delete redundant content
Suri539 Jul 12, 2024
97069e3
Merge branch 'release/rtc-ng/4.4.0' of github.com:AgoraIO/agora_doc_s…
Suri539 Jul 12, 2024
a59ff10
windows 440
Suri539 Jul 12, 2024
6ea9403
fix
Cilla-luodan Jul 12, 2024
f72135e
Merge branch 'release/rtc-ng/4.4.0' of github.com:AgoraIO/agora_doc_s…
Cilla-luodan Jul 12, 2024
bb8c0ec
1
Cilla-luodan Jul 12, 2024
2e55d53
tiny fix
Cilla-luodan Jul 12, 2024
9330430
fix
Cilla-luodan Jul 15, 2024
149ea59
Update release_android_ng.md
jinyuagora Jul 15, 2024
3e87cee
add destroy_IMusicPlayer
Suri539 Jul 15, 2024
fa489a9
Merge branch 'release/rtc-ng/4.4.0' of github.com:AgoraIO/agora_doc_s…
Suri539 Jul 15, 2024
df3641b
Update api_irtcengine_setremotedefaultvideostreamtype2.dita
jinyuagora Jul 15, 2024
d8a29be
update release notes
Nero-Hu Jul 15, 2024
eb85266
sales link
Suri539 Jul 15, 2024
8b7ef48
update links
Suri539 Jul 15, 2024
77b40bb
1
Cilla-luodan Jul 15, 2024
3436356
1
Cilla-luodan Jul 15, 2024
b699d58
Merge branch 'release/rtc-ng/4.4.0' of github.com:AgoraIO/agora_doc_s…
Cilla-luodan Jul 15, 2024
c359428
CSD-54930
Suri539 Jul 15, 2024
aa24c41
Sync cn prototype to en prototype
Suri539 Jul 15, 2024
4982294
Merge pull request #3704 from AgoraIO/auto/sync-cn-proto-to-en-patch-…
github-actions[bot] Jul 15, 2024
70e94bc
NMS-20887
Cilla-luodan Jul 15, 2024
cc089ed
Merge branch 'release/rtc-ng/4.4.0' of github.com:AgoraIO/agora_doc_s…
Cilla-luodan Jul 15, 2024
dfab8d6
review comments
Cilla-luodan Jul 15, 2024
44aa193
Update release_notes.dita
Suri539 Jul 15, 2024
925dc18
Merge branch 'release/rtc-ng/4.4.0' of github.com:AgoraIO/agora_doc_s…
Suri539 Jul 15, 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
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@
<codeblock props="android" outputclass="language-java">public abstract int setRemoteDefaultVideoStreamType(Constants.VideoStreamType streamType);</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></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>
<dd>v4.4.0</dd>
</dlentry>
</dl>
<p conkeyref="setRemoteVideoStreamType/desc1"/>
<p conkeyref="setRemoteVideoStreamType/desc2"/>
<note type="attention" conkeyref="setRemoteDefaultVideoStreamType/note"/></section>
<section id="parameters">
<p conkeyref="setRemoteVideoStreamType/desc2"/></section>
<section id="timing" deliveryTarget="details" conkeyref="setRemoteDefaultVideoStreamType/timing"/>
<section id="restriction" deliveryTarget="details" conkeyref="setRemoteDefaultVideoStreamType/restriction"/>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry conkeyref="setRemoteVideoStreamType2/streamtype">
Expand Down
3 changes: 2 additions & 1 deletion dita/RTC-NG/API/api_irtcengine_statechanged.dita
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,9 @@
<pd>
<p>设备状态:
<ul>
<li>0:设备插入,但未使用。</li>
<li>0:设备就绪。</li>
<li>1:设备正在使用。</li>
<li>3:设备已插入。</li>
<li>8:设备被拔出。</li>
</ul></p>
</pd>
Expand Down
4 changes: 4 additions & 0 deletions dita/RTC-NG/API/enum_mediadevicestatetype.dita
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@
<pt><ph keyref="MEDIA_DEVICE_STATE_DISABLED"/></pt>
<pd>2: 设备被禁用。</pd>
</plentry>
<plentry>
<pt><ph keyref="MEDIA_DEVICE_STATE_PLUGGED_IN"/></pt>
<pd>3: 设备已插入。</pd>
</plentry>
<plentry>
<pt><ph keyref="MEDIA_DEVICE_STATE_NOT_PRESENT"/></pt>
<pd>4: 没有此设备。</pd>
Expand Down
210 changes: 193 additions & 17 deletions dita/RTC-NG/API/rtc_api_sunset.dita

Large diffs are not rendered by default.

21 changes: 11 additions & 10 deletions dita/RTC-NG/API/rtc_lite_api.dita
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<refbody>
<section><note type="attention">如果在本页中无法查询到你要使用的 API,则代表 Lite SDK 不支持该 API,调用该 API 时会返回错误码 -2。</note></section>
<section>
<title><ph keyref="IRtcEngine"/></title>
<title><apiname keyref="IRtcEngine"/></title>
<ul>
<li props="android electron flutter rn unity"><xref keyref="addHandler"/></li>
<li><xref keyref="adjustAudioMixingPlayoutVolume"/></li>
Expand Down Expand Up @@ -335,7 +335,7 @@
</ul>
</section>
<section>
<title><ph keyref="IRtcEngineEx"/></title>
<title><apiname keyref="IRtcEngineEx"/></title>
<ul>
<li props="unity flutter"><xref keyref="createAgoraRtcEngineEx"/></li>
<li props="android cpp unreal unity"><xref keyref="createDataStreamEx1"/></li>
Expand Down Expand Up @@ -390,7 +390,7 @@
</ul>
</section>
<section>
<title><ph keyref="IRtcEngineEventHandler"/></title>
<title><apiname keyref="IRtcEngineEventHandler"/></title>
<ul>
<li><xref keyref="onActiveSpeaker"/></li>
<li props="cpp unreal bp electron unity flutter"><xref keyref="onAudioDeviceStateChanged"/></li>
Expand Down Expand Up @@ -479,7 +479,7 @@
</ul>
</section>
<section props="android apple">
<title><ph keyref="IMediaExtensionObserver"/></title>
<title><apiname keyref="IMediaExtensionObserver"/></title>
<ul>
<li><xref keyref="onExtensionErrorWithContext"/></li>
<li><xref keyref="onExtensionEventWithContext"/></li>
Expand All @@ -488,7 +488,7 @@
</ul>
</section>
<section>
<title><ph keyref="IMediaPlayer"/></title>
<title><apiname keyref="IMediaPlayer"/></title>
<note type="attention">媒体播放器中的 API 仅支持处理音频媒体文件、不支持处理视频媒体文件。</note>
<ul>
<li><xref keyref="adjustPlayoutVolume"/></li>
Expand Down Expand Up @@ -547,28 +547,29 @@
</ul>
</section>
<section>
<title><ph keyref="IVideoEncodedFrameObserver"/></title>
<title><apiname keyref="IVideoEncodedFrameObserver"/></title>
<ul>
<li><xref keyref="onEncodedVideoFrameReceived"/></li>
</ul>
</section>
<section>
<title><ph keyref="IVideoFrameObserver"/></title>
<title><apiname keyref="IVideoFrameObserver"/></title>
<note type="attention">通过 <xref keyref="onCaptureVideoFrame"/>、<xref keyref="onPreEncodeVideoFrame"/> 和 <xref keyref="onRenderVideoFrame"/> 回调返回的视频数据中,<parmname>alphabuffer</parmname> 为 <codeph><ph keyref="NULL"/></codeph>。</note>
<ul>
<li props="native unreal bp"><xref keyref="getMirrorApplied"/></li>
<li props="native unreal bp"><xref keyref="getObservedFramePosition"/></li>
<li props="native unreal bp"><xref keyref="getRotationApplied"/></li>
<li props="native unreal bp"><xref keyref="getVideoFormatPreference"/></li>
<li props="native unreal bp"><xref keyref="getVideoFrameProcessMode"/></li>
<li><xref keyref="onCaptureVideoFrame"/></li>
<li props="cpp unreal bp"><xref keyref="onFrame_IVideoFrameObserver"/></li>
<li props="hide"><xref keyref="onMediaPlayerVideoFrame"/></li>
<li><xref keyref="onCaptureVideoFrame"/></li>
<li><xref keyref="onPreEncodeVideoFrame"/></li>
<li><xref keyref="onRenderVideoFrame"/></li>
</ul>
</section>
<section>
<title><ph keyref="IMediaExtensionObserver"/></title>
<title><apiname keyref="IMediaExtensionObserver"/></title>
<ul>
<li><xref keyref="onExtensionErrorWithContext"/></li>
<li><xref keyref="onExtensionEventWithContext"/></li>
Expand All @@ -577,7 +578,7 @@
</ul>
</section>
<section>
<title><ph keyref="IMusicPlayer"/></title>
<title><apiname keyref="IMusicPlayer"/></title>
<ul>
<li props="android"><xref keyref="getPlaySrc"/></li>
<li><xref keyref="open_IMusicPlayer"/></li>
Expand Down
7 changes: 7 additions & 0 deletions dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -9728,6 +9728,13 @@
</keywords>
</topicmeta>
</keydef>
<keydef keys="MEDIA_DEVICE_STATE_PLUGGED_IN">
<topicmeta>
<keywords>
<keyword>MEDIA_DEVICE_STATE_PLUGGED_IN</keyword>
</keywords>
</topicmeta>
</keydef>
<keydef keys="MEDIA_DEVICE_STATE_NOT_PRESENT">
<topicmeta>
<keywords>
Expand Down
1 change: 0 additions & 1 deletion dita/RTC-NG/config/keys-rtc-ng-links-unity.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,5 @@
</keywords>
</topicmeta>
</keydef>
<keydef keys="ticket-link" href="https://agora-ticket.agora.io/" scope="external" format="html"/>
</topichead>
</map>
4 changes: 2 additions & 2 deletions dita/RTC-NG/config/keys-rtc-ng-links.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,14 @@
</keydef>
</topichead>
<topichead navtitle="External">
<keydef keys="mailto-link" href="mailto:sales@shengwang.cn" scope="external" format="html">
<keydef keys="mailto-link" href="https://www.shengwang.cn/contact-sales/" scope="external" format="html">
<topicmeta>
<keywords>
<keyword>[email protected]</keyword>
</keywords>
</topicmeta>
</keydef>
<keydef keys="ticket-link" href="ticket.shengwang.cn" scope="external" format="html">
<keydef keys="ticket-link" href="https://ticket.shengwang.cn/" scope="external" format="html">
<topicmeta>
<keywords>
<keyword>联系技术支持</keyword>
Expand Down
18 changes: 10 additions & 8 deletions dita/RTC-NG/release/release_notes.dita
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@
<stentry>现有回调</stentry>
</sthead>
<strow>
<stentry><codeph>onExtensionEvent</codeph></stentry>
<stentry><codeph props="cpp">onExtensionEvent</codeph><codeph props="apple android">onEvent</codeph></stentry>
<stentry><codeph><apiname keyref="onExtensionEventWithContext"/></codeph></stentry>
</strow>
<strow>
<stentry><codeph>onExtensionStarted</codeph></stentry>
<stentry><codeph props="apple cpp">onExtensionStarted</codeph><codeph props="android">onStarted</codeph></stentry>
<stentry><codeph><apiname keyref="onExtensionStartedWithContext"/></codeph></stentry>
</strow>
<strow>
<stentry><codeph>onExtensionStopped</codeph></stentry>
<stentry><codeph props="apple cpp">onExtensionStopped</codeph><codeph props="android">onStopped</codeph></stentry>
<stentry><codeph><apiname keyref="onExtensionStoppedWithContext"/></codeph></stentry>
</strow>
<strow>
<stentry><codeph>onExtensionError</codeph></stentry>
<stentry><codeph props="apple cpp">onExtensionError</codeph><codeph props="android">onError</codeph></stentry>
<stentry><codeph><apiname keyref="onExtensionErrorWithContext"/></codeph></stentry>
</strow>
</simpletable>
Expand All @@ -42,11 +42,13 @@
<li props="android">该版本删除了 <codeph><apiname keyref="onMetadataReceived"/></codeph> 回调中的 <codeph>buffer</codeph>、<codeph>uid</codeph>、<codeph>timeStampMs</codeph> 参数,你可以通过新增的 <codeph>metadata</codeph> 参数来获取 Metadata 的相关信息,包括 <codeph>timeStampMs</codeph>(发送数据的时间戳)、<codeph>uid</codeph>(用户 ID)、<codeph>channelId</codeph>(源频道名称)等。</li>
<li props="cpp">该版本修改了 <xref keyref="ExternalVideoFrame"/> 中的以下成员名称:
<ul>
<li><parmname>d3d11_texture_2d</parmname> 更名为 <parmname>d3d11Texture2d</parmname>。</li>
<li><parmname>texture_slice_index</parmname> 更名为 <parmname>textureSliceIndex</parmname>。</li>
<li><parmname>metadata_buffer</parmname> 更名为 <parmname>metadataBuffer</parmname>。</li>
<li><parmname>metadata_size</parmname> 更名为 <parmname>metadataSize</parmname>。</li>
<li><codeph>d3d11_texture_2d</codeph> 更名为 <codeph>d3d11Texture2d</codeph>。</li>
<li><codeph>texture_slice_index</codeph> 更名为 <codeph>textureSliceIndex</codeph>。</li>
<li><codeph>metadata_buffer</codeph> 更名为 <codeph>metadataBuffer</codeph>。</li>
<li><codeph>metadata_size</codeph> 更名为 <codeph>metadataSize</codeph>。</li>
</ul></li>
<li props="windows">在 v4.4.0 之前,音视频设备已插入、已就绪均会通过 <codeph><apiname keyref="MEDIA_DEVICE_STATE_TYPE"/></codeph> 中的 <codeph><apiname keyref="MEDIA_DEVICE_STATE_IDLE"/></codeph>(0)状态报告。为进一步区分设备状态,自 v4.4.0 起,SDK 会通过新增的 <codeph><apiname keyref="MEDIA_DEVICE_STATE_PLUGGED_IN"/></codeph>(3)报告设备已插入。</li>
<li props="mac">在 v4.4.0 之前,音视频设备已插入、已就绪均会通过 <codeph><apiname keyref="stateChanged"/></codeph> 回调中的 <codeph>state</codeph> 参数报告状态码 <codeph>0</codeph>。为进一步区分设备状态,自 v4.4.0 起,SDK 会通过新增的状态码 <codeph>3</codeph> 报告设备已插入。</li>
</ol>
</body>
</topic>
Expand Down
4 changes: 2 additions & 2 deletions en-US/dita/RTC-NG/API/rtc_api_sunset.dita
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
<row>
<entry><xref keyref="setLogFileSize"/></entry>
<entry><ph conkeyref="setLogFileSize/shortdesc"/></entry>
<entry>Use the <codeph>logConfig</codeph> parameter in <xref keyref="initialize" /></entry>
<entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize" /></entry>
<entry>v4.0.0</entry>
</row>
<row props="android apple">
Expand Down Expand Up @@ -120,7 +120,7 @@
<row>
<entry><xref keyref="setLogFile"/></entry>
<entry><ph conkeyref="setLogFile/shortdesc"/></entry>
<entry>Use the <codeph>logConfig</codeph> parameter in <xref keyref="initialize" /></entry>
<entry>Use the <parmname>logConfig</parmname> parameter in <xref keyref="initialize" /></entry>
<entry>v4.0.0</entry>
</row>
<row>
Expand Down
7 changes: 7 additions & 0 deletions en-US/dita/RTC-NG/config/keys-rtc-ng-api-cpp.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -9728,6 +9728,13 @@
</keywords>
</topicmeta>
</keydef>
<keydef keys="MEDIA_DEVICE_STATE_PLUGGED_IN">
<topicmeta>
<keywords>
<keyword>MEDIA_DEVICE_STATE_PLUGGED_IN</keyword>
</keywords>
</topicmeta>
</keydef>
<keydef keys="MEDIA_DEVICE_STATE_NOT_PRESENT">
<topicmeta>
<keywords>
Expand Down
Loading
Loading