Skip to content

Commit f1cae27

Browse files
Nero-Hulemon-chen
Nero-Hu
authored and
lemon-chen
committed
update framework dita 13
1 parent 65cfb0e commit f1cae27

4 files changed

Lines changed: 587 additions & 273 deletions

‎dita/RTC-AIDOC-FRAMEWORK/API/api_imusiccontentcenter_getinternalsongcode.dita‎

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,12 @@
3535
<plentry props="electron">
3636
<pt>jsonOption</pt>
3737
<pd>
38-
<note>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。</note><ph>扩展 JSON 字段，默认为 null。目前支持传入下列值：</ph><ph>| Key 值 | Value 值 | 示例 |</ph><ph>| --- | --- | --- |</ph><ph>| sceneType | 场景类型：</ph>
38+
<note>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。</note><ph>扩展 JSON 字段，默认为 null。目前支持传入下列值：</ph>
3939
<ul>
40-
<li>1：直播场景：K 歌及背景音乐播放。</li>
41-
<li>2：直播场景：背景音乐播放。</li>
42-
<li>3：（默认）语聊场景：K 歌。</li>
43-
<li>4：语聊场景：背景音乐播放。</li>
44-
<li>5：VR 场景：K 歌及背景音乐播放。</li>
45-
</ul><ph>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。 | {"sceneType":1} |</ph><ph>| highPart | 副歌片段的索引。你可以从 <xref keyref="onMusicCollectionResult"/> 回调中获取副歌片段的索引然后传值。索引序号从 0 开始。 | {"format": {"highpart": 0}} |</ph></pd>
40+
<li>sceneType：场景类型。1：直播场景，在线 K 歌房和背景音乐播放；2：直播场景，背景音乐播放；3：（默认）声动语聊场景，在线 K 歌房；4：声动语聊场景，背景音乐播放；5：VR 场景，在线 K 歌房和背景音乐播放。示例：<codeph>{"sceneType":1}</codeph>。</li>
41+
<li>highPart：副歌片段的索引，从 <xref keyref="onMusicCollectionResult"/> 回调中获取，索引从 0 开始。示例：<codeph>{"format": {"highpart": 0}}</codeph>。</li>
42+
</ul>
43+
</pd>
4644
</plentry>
4745
<plentry props="rn">
4846
<pt>songCode</pt>
@@ -51,14 +49,12 @@
5149
<plentry props="rn">
5250
<pt>jsonOption</pt>
5351
<pd>
54-
<note>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。</note><ph>扩展 JSON 字段，默认为 null。目前支持传入下列值：</ph><ph>| Key 值 | Value 值 | 示例 |</ph><ph>| --- | --- | --- |</ph><ph>| sceneType | 场景类型：</ph>
52+
<note>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。</note><ph>扩展 JSON 字段，默认为 null。目前支持传入下列值：</ph>
5553
<ul>
56-
<li>1：直播场景：K 歌及背景音乐播放。</li>
57-
<li>2：直播场景：背景音乐播放。</li>
58-
<li>3：（默认）语聊场景：K 歌。</li>
59-
<li>4：语聊场景：背景音乐播放。</li>
60-
<li>5：VR 场景：K 歌及背景音乐播放。</li>
61-
</ul><ph>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。 | {"sceneType":1} |</ph><ph>| highPart | 副歌片段的索引。你可以从 <xref keyref="onMusicCollectionResult"/> 回调中获取副歌片段的索引然后传值。索引序号从 0 开始。 | {"format": {"highpart": 0}} |</ph></pd>
54+
<li>sceneType：场景类型。1：直播场景，在线 K 歌房和背景音乐播放；2：直播场景，背景音乐播放；3：（默认）声动语聊场景，在线 K 歌房；4：声动语聊场景，背景音乐播放；5：VR 场景，在线 K 歌房和背景音乐播放。示例：<codeph>{"sceneType":1}</codeph>。</li>
55+
<li>highPart：副歌片段的索引，从 <xref keyref="onMusicCollectionResult"/> 回调中获取，索引从 0 开始。示例：<codeph>{"format": {"highpart": 0}}</codeph>。</li>
56+
</ul>
57+
</pd>
6258
</plentry>
6359
<plentry props="flutter">
6460
<pt>songCode</pt>
@@ -67,14 +63,12 @@
6763
<plentry props="flutter">
6864
<pt>jsonOption</pt>
6965
<pd>
70-
<note>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。</note><ph>扩展 JSON 字段，默认为 <codeph><ph keyref="NULL"/></codeph>。目前支持传入下列值：</ph><ph>| Key 值 | Value 值 | 示例 |</ph><ph>| --- | --- | --- |</ph><ph>| sceneType | 场景类型：</ph>
66+
<note>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。</note><ph>扩展 JSON 字段，默认为 null。目前支持传入下列值：</ph>
7167
<ul>
72-
<li>1：直播场景：K 歌及背景音乐播放。</li>
73-
<li>2：直播场景：背景音乐播放。</li>
74-
<li>3：（默认）语聊场景：K 歌。</li>
75-
<li>4：语聊场景：背景音乐播放。</li>
76-
<li>5：VR 场景：K 歌及背景音乐播放。</li>
77-
</ul><ph>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。 | {"sceneType":1} |</ph><ph>| highPart | 副歌片段的索引。你可以从 <xref keyref="onMusicCollectionResult"/> 回调中获取副歌片段的索引然后传值。索引序号从 0 开始。 | {"format": {"highpart": 0}} |</ph></pd>
68+
<li>sceneType：场景类型。1：直播场景，在线 K 歌房和背景音乐播放；2：直播场景，背景音乐播放；3：（默认）声动语聊场景，在线 K 歌房；4：声动语聊场景，背景音乐播放；5：VR 场景，在线 K 歌房和背景音乐播放。示例：<codeph>{"sceneType":1}</codeph>。</li>
69+
<li>highPart：副歌片段的索引，从 <xref keyref="onMusicCollectionResult"/> 回调中获取，索引从 0 开始。示例：<codeph>{"format": {"highpart": 0}}</codeph>。</li>
70+
</ul>
71+
</pd>
7872
</plentry>
7973
<plentry props="unity">
8074
<pt>songCode</pt>
@@ -83,14 +77,12 @@
8377
<plentry props="unity">
8478
<pt>jsonOption</pt>
8579
<pd>
86-
<note>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。</note><ph>扩展 JSON 字段，默认为 <codeph><ph keyref="NULL"/></codeph>。目前支持传入下列值：</ph><ph>| Key 值 | Value 值 | 示例 |</ph><ph>| --- | --- | --- |</ph><ph>| sceneType | 场景类型：</ph>
80+
<note>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。</note><ph>扩展 JSON 字段，默认为 null。目前支持传入下列值：</ph>
8781
<ul>
88-
<li>1：直播场景：K 歌及背景音乐播放。</li>
89-
<li>2：直播场景：背景音乐播放。</li>
90-
<li>3：（默认）语聊场景：K 歌。</li>
91-
<li>4：语聊场景：背景音乐播放。</li>
92-
<li>5：VR 场景：K 歌及背景音乐播放。</li>
93-
</ul><ph>声网会根据你在 <codeph>sceneType</codeph> 传入的应用场景进行收费。不同的应用场景对应不同的费率，你可以参考 [计费说明](https://doc.shengwang.cn/doc/online-ktv/android/online-ktv-sdk/overview/billing) 查看详细的计费。如果需要切换到不同场景，需要重新调用此方法并传入 <codeph>sceneType</codeph> 的值。 | {"sceneType":1} |</ph><ph>| highPart | 副歌片段的索引。你可以从 <xref keyref="onMusicCollectionResult"/> 回调中获取副歌片段的索引然后传值。索引序号从 0 开始。 | {"format": {"highpart": 0}} |</ph></pd>
82+
<li>sceneType：场景类型。1：直播场景，在线 K 歌房和背景音乐播放；2：直播场景，背景音乐播放；3：（默认）声动语聊场景，在线 K 歌房；4：声动语聊场景，背景音乐播放；5：VR 场景，在线 K 歌房和背景音乐播放。示例：<codeph>{"sceneType":1}</codeph>。</li>
83+
<li>highPart：副歌片段的索引，从 <codeph>onMusicCollectionResult</codeph> 回调中获取，索引从 0 开始。示例：<codeph>{"format": {"highpart": 0}}</codeph>。</li>
84+
</ul>
85+
</pd>
9486
</plentry>
9587
<plentry props="unity">
9688
<pt>internalSongCode</pt>

‎dita/RTC-AIDOC-FRAMEWORK/API/api_imusiccontentcenter_getmusiccollectionbymusicchartid.dita‎

Lines changed: 54 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,21 @@
5757
<plentry props="electron">
5858
<pt>jsonOption</pt>
5959
<pd>扩展 JSON 字段，默认为 null。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段：
60-
| Key 值 | Value 值 | 示例 |
61-
| --- | --- | --- |
62-
| pitchType | 是否支持打分：
6360
<ul>
64-
<li>1：支持打分的音乐资源。</li>
65-
<li>2：不支持打分的音乐资源。 | {"pitchType":1} |</li>
66-
</ul><ph>| needHighPart | 是否需要副歌片段资源：</ph>
61+
<li><codeph>pitchType</codeph>：音乐资源是否支持评分。
62+
<ul>
63+
<li><codeph>1</codeph>：可评分的音乐资源。</li>
64+
<li><codeph>2</codeph>：不可评分的音乐资源。</li>
65+
</ul>
66+
</li>
67+
</ul>
6768
<ul>
68-
<li><xref keyref="true"/>：需要副歌片段资源。</li>
69-
<li><xref keyref="false"/>：不需要副歌片段资源。 | {"needHighPart":true} |</li>
69+
<li><codeph>needHighPart</codeph>：是否需要合唱片段资源。
70+
<ul>
71+
<li><codeph>YES</codeph>：需要合唱片段资源。</li>
72+
<li><codeph>NO</codeph>：不需要合唱片段资源。</li>
73+
</ul>
74+
</li>
7075
</ul>
7176
</pd>
7277
</plentry>
@@ -85,16 +90,21 @@
8590
<plentry props="rn">
8691
<pt>jsonOption</pt>
8792
<pd>扩展 JSON 字段，默认为 null。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段：
88-
| Key 值 | Value 值 | 示例 |
89-
| --- | --- | --- |
90-
| pitchType | 是否支持打分：
9193
<ul>
92-
<li>1：支持打分的音乐资源。</li>
93-
<li>2：不支持打分的音乐资源。 | {"pitchType":1} |</li>
94-
</ul><ph>| needHighPart | 是否需要副歌片段资源：</ph>
94+
<li><codeph>pitchType</codeph>：音乐资源是否支持评分。
95+
<ul>
96+
<li><codeph>1</codeph>：可评分的音乐资源。</li>
97+
<li><codeph>2</codeph>：不可评分的音乐资源。</li>
98+
</ul>
99+
</li>
100+
</ul>
95101
<ul>
96-
<li><xref keyref="true"/>：需要副歌片段资源。</li>
97-
<li><xref keyref="false"/>：不需要副歌片段资源。 | {"needHighPart":true} |</li>
102+
<li><codeph>needHighPart</codeph>：是否需要合唱片段资源。
103+
<ul>
104+
<li><codeph>YES</codeph>：需要合唱片段资源。</li>
105+
<li><codeph>NO</codeph>：不需要合唱片段资源。</li>
106+
</ul>
107+
</li>
98108
</ul>
99109
</pd>
100110
</plentry>
@@ -112,17 +122,22 @@
112122
</plentry>
113123
<plentry props="flutter">
114124
<pt>jsonOption</pt>
115-
<pd>扩展 JSON 字段，默认为 <codeph><ph keyref="NULL"/></codeph>。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段：
116-
| Key 值 | Value 值 | 示例 |
117-
| --- | --- | --- |
118-
| pitchType | 是否支持打分：
125+
<pd>扩展 JSON 字段，默认为 null。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段：
119126
<ul>
120-
<li>1：支持打分的音乐资源。</li>
121-
<li>2：不支持打分的音乐资源。 | {"pitchType":1} |</li>
122-
</ul><ph>| needHighPart | 是否需要副歌片段资源：</ph>
127+
<li><codeph>pitchType</codeph>：音乐资源是否支持评分。
128+
<ul>
129+
<li><codeph>1</codeph>：可评分的音乐资源。</li>
130+
<li><codeph>2</codeph>：不可评分的音乐资源。</li>
131+
</ul>
132+
</li>
133+
</ul>
123134
<ul>
124-
<li><xref keyref="true"/>：需要副歌片段资源。</li>
125-
<li><xref keyref="false"/>：不需要副歌片段资源。 | {"needHighPart":true} |</li>
135+
<li><codeph>needHighPart</codeph>：是否需要合唱片段资源。
136+
<ul>
137+
<li><codeph>YES</codeph>：需要合唱片段资源。</li>
138+
<li><codeph>NO</codeph>：不需要合唱片段资源。</li>
139+
</ul>
140+
</li>
126141
</ul>
127142
</pd>
128143
</plentry>
@@ -144,17 +159,22 @@
144159
</plentry>
145160
<plentry props="unity">
146161
<pt>jsonOption</pt>
147-
<pd>扩展 JSON 字段，默认为 <codeph><ph keyref="NULL"/></codeph>。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段：
148-
| Key 值 | Value 值 | 示例 |
149-
| --- | --- | --- |
150-
| pitchType | 是否支持打分：
162+
<pd>扩展 JSON 字段，默认为 null。你可以通过该字段来筛选出你需要的音乐资源，目前支持筛选可打分的音乐资源及音乐资源的副歌片段：
151163
<ul>
152-
<li>1：支持打分的音乐资源。</li>
153-
<li>2：不支持打分的音乐资源。 | {"pitchType":1} |</li>
154-
</ul><ph>| needHighPart | 是否需要副歌片段资源：</ph>
164+
<li><codeph>pitchType</codeph>：音乐资源是否支持评分。
165+
<ul>
166+
<li><codeph>1</codeph>：可评分的音乐资源。</li>
167+
<li><codeph>2</codeph>：不可评分的音乐资源。</li>
168+
</ul>
169+
</li>
170+
</ul>
155171
<ul>
156-
<li><xref keyref="true"/>：需要副歌片段资源。</li>
157-
<li><xref keyref="false"/>：不需要副歌片段资源。 | {"needHighPart":true} |</li>
172+
<li><codeph>needHighPart</codeph>：是否需要合唱片段资源。
173+
<ul>
174+
<li><codeph>YES</codeph>：需要合唱片段资源。</li>
175+
<li><codeph>NO</codeph>：不需要合唱片段资源。</li>
176+
</ul>
177+
</li>
158178
</ul>
159179
</pd>
160180
</plentry>

0 commit comments

Comments
 (0)