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

4.5.0 #3790

Open
wants to merge 18 commits into
base: release/rtc-ng/4.5.0
Choose a base branch
from
Open

4.5.0 #3790

wants to merge 18 commits into from

Conversation

Suri539
Copy link
Collaborator

@Suri539 Suri539 commented Oct 12, 2024

No description provided.

</plentry>
<plentry props="apple cpp" id="err">
<pt props="cpp">err</pt>
<pt props="apple">error</pt>
Copy link
Collaborator

Choose a reason for hiding this comment

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

RTE 上来就不拉齐,都叫 error 是犯法么,如果可以的话,提 jira 请研发修改一下

<plentry props="apple cpp" id="err">
<pt props="cpp">err</pt>
<pt props="apple">error</pt>
<pd>状态或错误信息,详见 <xref keyref="Error"/>。</pd>
Copy link
Collaborator

Choose a reason for hiding this comment

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

细节问题,当前的常规写法是:

状态或错误信息。详见 xxx。

可以的话,批量修改一下。

<title>方法</title>
<parml>
<plentry>
<pt><apiname keyref="Code"/></pt>
Copy link
Collaborator

Choose a reason for hiding this comment

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

按照规范,pt 这里直接写成员名字就可以 Code

Copy link
Collaborator

Choose a reason for hiding this comment

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

下同

<parml>
<plentry>
<pt><apiname keyref="Code"/></pt>
<pd>获取接口调用返回的错误码,详见 <xref keyref="Code"/>。</pd>
Copy link
Collaborator

Choose a reason for hiding this comment

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

可精简描述:

获取错误码。详见 xxx。

</plentry>
<plentry>
<pt><apiname keyref="Message"/></pt>
<pd>获取接口调用返回的具体错误信息,详见 <xref keyref="Message"/>。</pd>
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="GetConfigs_Player"/> 之后调用。</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

不太理解为啥一个 get 方法要在另一个 get 方法之后调用,按说 get 只是获取又不是设置,还能影响到另一个 get 的结果咩?

<dd>v4.5.0</dd>
</dlentry>
</dl>
当你调用 <xref keyref="SetJsonParameter_PlayerConfig"/> 设置 JSON 配置信息后,你可以调用该方法获取已设置的配置信息。
Copy link
Collaborator

Choose a reason for hiding this comment

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

裸奔了,请包裹 p,否则不一定保证它能渲染出来

<dd>v4.5.0</dd>
</dlentry>
</dl>
<p>当你调用 <xref keyref="OpenWithUrl"/> 打开媒体流之前,你可以调用该方法设置是否自动播放。如不设置,默认会启用自动播放。</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

感觉这里可以顺一下逻辑:

SDK 默认在 xx 之后自动播放媒体资源。如果需要修改此行为,可以调用该方法关闭自动播放。

<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_rte_getfrombridge">
<title><ph keyref="GetFromBridge"/></title>
<shortdesc id="short"><ph id="shortdesc">从 RTC 引擎中桥接出一个 RTE 对象。</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.

“RTC 引擎” 改用<ph keyref="IRtcEngine"/> 何如?

<dd>v4.5.0</dd>
</dlentry>
</dl>
<p>调用该方法创建的 RTE 对象,无需再通过 <xref keyref="InitMediaEngine"/> 进行初始化。如果你之前未创建并初始化 RTC 引擎, 可以先调用 <xref keyref="Rte"/> 创建一个 RTE对象,然后再调用 <xref keyref="InitMediaEngine"/> 进行初始化。</p>
Copy link
Collaborator

Choose a reason for hiding this comment

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

RTE 对象

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

Choose a reason for hiding this comment

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

可以优化一下描述,把这个方法的重心思想概括出来:
如果你已经创建了 xx,则可以调用该方法桥接出一个 xx 对象,无需再通过 xx 进行初始化操作。

Copy link
Collaborator

Choose a reason for hiding this comment

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

后面的那句话其实都不是这个方法的强相关信息,可有可无,在自己的地盘讲清楚就好了。因为没创建 RTC 引擎的话,自然就不符合这个方法的前提了

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.

2 participants