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

New YiCAT updates #3656

Merged
merged 40 commits into from
Jul 11, 2024
Merged

New YiCAT updates #3656

merged 40 commits into from
Jul 11, 2024

Conversation

Cilla-luodan
Copy link
Collaborator

No description provided.

@@ -29,7 +30,7 @@
<dl outputclass="deprecated">
<dlentry>
<dt>Deprecated:</dt>
<dd>Use the <codeph>mLogConfig</codeph> parameter in <xref keyref="initialize" /> method instead.</dd>
<dd>Use the <codeph>logConfig</codeph> parameter in <xref keyref="initialize" /> instead.</dd>
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

这里好像有问题,这个参数在 andorid 和 cpp 的名字不一样,android 是 mLogConfig,原文可能要改下

Copy link
Collaborator

Choose a reason for hiding this comment

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

这个是 initialize 参数的名字
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

这里说的是调用 initialize 然后设置 config(对应 RtcEngineConfig 类)里的 logConfig (mLogConfig)

只不过我们一般写的时候不会写那么冗长而已,它也不是在 initialize 里的参数名字

<dd>Use <xref keyref="startAudioMixing2" /> instead.</dd>
</dlentry>
</dl>
<p props="cpp apple framework">For the audio file formats supported by this method, see <xref keyref="audio-format">What formats of audio files does the Agora RTC SDK support</xref>. If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports 701.</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.

701 是个啥?现在 SDK 已经没有警告码了,可能需要确认下在这种情况下是否有错误码

Copy link
Collaborator

Choose a reason for hiding this comment

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

image 是一个枚举值 701,之后把这个AUDIO_MIXING_REASON_CAN_NOT_OPEN补上

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

嗯原文的“警告码”字眼可能要改下,一般在这种时候我们会写为,触发 xxx(enum,enum) 回调报告 xxx 信息

<section id="parameters">
<section id="timing" deliveryTarget="details">
<title>Trigger timing</title>
<p>This callback is triggered when a remote user (in the communication profile) or host (in the live streaming profile) leaves a channel.</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

in a communication profile 冠词用 a

Copy link
Collaborator

Choose a reason for hiding this comment

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

这个就是特指 channel profile 里面的 communication

en-US/dita/RTC-NG/API/class_advanceoptions.dita Outdated Show resolved Hide resolved
Copy link
Collaborator

@Nero-Hu Nero-Hu left a comment

Choose a reason for hiding this comment

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

1

en-US/dita/RTC-NG/API/class_advanceoptions.dita Outdated Show resolved Hide resolved
<pt props="cpp android">alphaBuffer</pt>
<pt props="apple">alphaBuf</pt>
<pd>
<p>The alpha channel data output using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait).</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

using → uses

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

改成 by using 是不是也行

Copy link
Collaborator

@Nero-Hu Nero-Hu left a comment

Choose a reason for hiding this comment

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

1

en-US/dita/RTC-NG/API/class_externalvideoframe.dita Outdated Show resolved Hide resolved
<parml>
<li>After registering the <apiname keyref="onPlaybackAudioFrame"/> callback, the SDK sends the audio data to the app through the callback. Any delay in processing the audio frames may result in audio jitter.</li>
</ul></p>
<p>This method is only used for retrieving audio data after remote mixing. If you need to get audio data from different audio processing stages such as capture and playback, you can register the corresponding callbacks by calling <xref keyref="registerAudioFrameObserver"/>.</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

我觉得 retrieve data 比 pull 要好(pull data 有点迷,但应该也是前人的 legacy),上面和 shortdesc 里面可以考虑看看要不要改(

Copy link
Collaborator

@jinyuagora jinyuagora Jul 11, 2024

Choose a reason for hiding this comment

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

pull/push data 的用法我感觉也还好,和函数命名也一致,你觉得可以接受的话 shortdesc 就不动了

</section>
<section id="scenario" deliveryTarget="details">
<title>Applicable scenarios</title>
<p>After registering the raw video observer, you can use the obtained raw video data in various video pre-processing scenarios, such as virtual backgrounds and image enhacement by yourself.</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

by yourself 可以删掉

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

这里主要是想突出“自行实现”(不通过 SDK)的意思……

<li>In this mode, the SDK uses Agora's custom encryption algorithm to shorten the time required to establish transmission links, and the security is reduced compared to the standard DTLS (Datagram Transport Layer Security). If the application scenario requires higher security standards, Agora recommends that you do not use this method.</li>
</ul>
</note></p>
<p>After successfully calling this method, the SDK enables the instant frame rendering mode, which can speed up the first frame rendering speed after the user joins the channel.</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

speed up the first frame rendering 就可以,后面那个 speed 不需要

Copy link
Collaborator

Choose a reason for hiding this comment

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

上面的 short desc 里面写的是 audio and video rendering,这里的描述只写了 video,是不是应该加上 audio

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

哈?这句里是概括成了 first frame rendering,也没有只说 video 的意思

<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_irtcengine_enablevoiceaituner">
<title><ph keyref="enableVoiceAITuner"/></title>
<shortdesc id="short"><ph id="shortdesc">Enables or disables the voice AI tuner.</ph></shortdesc>
Copy link
Collaborator

Choose a reason for hiding this comment

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

应该是 AI voice tuner?把 voice tuner 拆开中间插 AI 感觉怪怪的,这样 AI 就只修饰 tuner 了,但 voice tuner 是一个固定搭配

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.

关于这个东西咱不要僭越就行了 🤐

@Cilla-luodan Cilla-luodan merged commit 245206e into master Jul 11, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants