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

wording #3650

Merged
merged 10 commits into from
Jun 13, 2024
Merged

wording #3650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
75eb1c1
wording
Suri539 Jun 13, 2024
a11ef36
remove note for Electron in VideoCanvas
Nero-Hu Jun 13, 2024
43e260f
add rn videocanvas note
Nero-Hu Jun 13, 2024
f43cc60
delete redundant
Cilla-luodan Jun 13, 2024
b513658
rm publishScreenTrack in RN proto
Nero-Hu Jun 13, 2024
c489d26
Merge branch '4.3.2-bugfix-0613' of https://github.com/AgoraIO/agora_…
Nero-Hu Jun 13, 2024
2eeca1d
fix videocanvas
Nero-Hu Jun 13, 2024
b8c18d3
CSD-65720
Cilla-luodan Jun 13, 2024
dd3ec6e
1
Cilla-luodan Jun 13, 2024
0630d89
Merge branch '4.3.2-bugfix-0613' of github.com:AgoraIO/agora_doc_sour…
Cilla-luodan Jun 13, 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_startdirectcdnstreaming.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<p>SDK 不支持同一时间向同一个 URL 重复推流。</p>
<p><b>媒体选项说明</b></p>
<p>SDK 不支持 <parmname>publishCameraTrack</parmname> 和 <parmname>publishCustomVideoTrack</parmname> 同时为 <codeph><ph keyref="true" /></codeph>，也不支持 <parmname>publishMicrophoneTrack</parmname> 和 <parmname>publishCustomAudioTrack</parmname> 同时为 <codeph><ph keyref="true" /></codeph>。你可以根据场景需求设置媒体选项 (<xref keyref="DirectCdnStreamingMediaOptions" />)。示例如下：</p>
<p>如果你想推送主播端采集的音视频流，请将媒体选项进行如下设置：</p>
<p>如果你想推送主播端自定义采集的音视频流，请将媒体选项进行如下设置：</p>
<ul>
<li props="android cpp unreal bp electron unity cs rn flutter"><parmname>publishCustomAudioTrack</parmname> 设为 <codeph><ph keyref="true" /></codeph> 并调用 <xref props="android" keyref="pushAudioFrame2" /><xref props="cpp unreal bp unity cs rn flutter electron" keyref="pushAudioFrame" /></li>
<li props="ios mac"><parmname>publishCustomAudioTrack</parmname> 设为 <codeph><ph keyref="true" /></codeph> 并调用 <xref keyref="pushExternalAudioFrameSampleBuffer2" /> 或 <xref keyref="pushAudioFrame2" /></li>
Expand Down
3 changes: 3 additions & 0 deletions dita/RTC-NG/API/callback_irtcengineeventhandler_onfirstremotevideoframe.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@
int height, int elapsed)? onFirstRemoteVideoFrame;</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<note type="attention">该回调只在 SDK 渲染时才会触发；如果用户采用自定义视频渲染则不会触发，客户需要通过 SDK 以外的方法自行实现。</note>
</section>
<section id="parameters">
<title><ph keyref="callback-section-title" /></title>
<parml>
Expand Down
2 changes: 0 additions & 2 deletions dita/RTC-NG/API/class_channelmediaoptions.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,8 +360,6 @@ struct FChannelMediaOptions

publishScreenCaptureAudio?: boolean;

publishScreenTrack?: boolean;

publishSecondaryScreenTrack?: boolean;

publishThirdScreenTrack?: boolean;
Expand Down
11 changes: 5 additions & 6 deletions dita/RTC-NG/API/class_videocanvas.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,9 @@ class VideoCanvas {
<plentry>
<pt>uid</pt>
<pd>发布视频源的用户 ID。</pd>
<pd props="cpp unity rn flutter">对于 Android 和 iOS 平台，当视频源为合图视频流 (<apiname keyref="VIDEO_SOURCE_TRANSCODED"/>) 时，该参数表示发布合图视频流的用户 ID。</pd>
<pd props="cpp unity rn flutter">对于 Android 和 iOS 平台，当视频源为合图视频流 (<apiname keyref="VIDEO_SOURCE_TRANSCODED"/>) 时，该参数表示发布合图视频流的用户 ID。
<note type="attention" props="rn">本地用户 <parmname>uid</parmname> 默认为 0。如果你想使用自定义的 <parmname>uid</parmname> 渲染本地视图，你还需要同时传入 <parmname>souceType</parmname>。</note>
</pd>
<pd props="android ios">当视频源为合图视频流 (<apiname keyref="VIDEO_SOURCE_TRANSCODED"/>) 时，该参数表示发布合图视频流的用户 ID。</pd>
</plentry>
<plentry>
Expand All @@ -255,7 +257,8 @@ class VideoCanvas {
<plentry>
<pt>view</pt>
<pd props="native flutter unity cs electron rn">视频显示窗口。<ph props="android">必须为一个 <xref keyref="SurfaceView-link"/> 或 <xref keyref="TextureView-link"/> 对象。</ph>
<note type="attention">在一个 <apiname keyref="VideoCanvas"/> 中，你只能选择 <parmname>view</parmname> 或 <parmname>surfaceTexture</parmname> 其中一个进行设置，如果同时设置，只有 <parmname>view</parmname> 中的设置会生效。</note></pd>
<note type="attention" props="native flutter unity cs rn">在一个 <apiname keyref="VideoCanvas"/> 中，你只能选择 <parmname>view</parmname> 或 <parmname>surfaceTexture</parmname> 其中一个进行设置，如果同时设置，只有 <parmname>view</parmname> 中的设置会生效。</note>
</pd>
<pd props="unreal bp">视频图像。你需要定义 UImage 类型的指针，并传入该参数，示例代码如下：
<codeblock props="unreal bp" outputclass="language-cpp">agora::rtc::VideoCanvas videoCanvas;
UImage* LocalVideo;
Expand Down Expand Up @@ -288,10 +291,6 @@ class VideoCanvas {
</note>
</pd>
</plentry>
<plentry>
<pt>uid</pt>
<pd>用户 ID。</pd>
</plentry>
<plentry id="sourcetype">
<pt>sourceType</pt>
<pd>视频源的类型，详见 <xref keyref="VIDEO_SOURCE_TYPE"/>。</pd>
Expand Down
Loading