场景化 API 方案的集成和实现文档

[kelzr]

上线格式检查可参考 preprod 链接：

• Android 集成：https://docs-preprod.agora.io/cn/online-ktv/ktv_integration_android?platform=Android
• Android API：https://docs-preprod.agora.io/cn/online-ktv/ktv_api_kotlin?platform=Android
• iOS 集成：https://docs-preprod.agora.io/cn/online-ktv/ktv_integration_ios?platform=iOS
• iOS API：https://docs-preprod.agora.io/cn/online-ktv/ktv_api_oc?platform=iOS

[HeatherWYL]

歌曲编号和歌词编号是通过什么获取的？用户自己随便填的么，还是要和音乐文件的名字对应之类的？建议写清楚

[HeatherWYL]

在 songCode 参数要填一次歌曲编号，然后 config 里又要填一个 songCode 参数。这两个参数有区别么？

[HeatherWYL]

建议写下加载失败可能的原因和解决方法

[HeatherWYL]

一个 KTV API 模块里，可以多次调用 playSong 播放多个歌曲么？还是不管调用多少次 playSong，只会播放最后一次调用的歌曲？
建议写清楚。

[HeatherWYL]

stop、pause、resume、seek、selectTrackMode、setKaraokeView 这几个 API 都没有传 songCode 的地方，看起来是只有成功调用 playSong 之后才能对当前的歌曲进行设置，建议加上调用时序限制。

尤其是 seek、selectTrackMode、setKaraokeView 这类功能和 play 的关系。比如我调了 play 播放音乐，再调了 pause，这个时候调用 seek，再调用 resume，会按照我在 seek 里设置的时间点去放音乐么？

[HeatherWYL]

建议这块内容以 fragment 的形式呈现，用户就不需要点击跳转去别的地方看了。
KTV 的两篇客户端实现文档是全然不同的方案，担心用户跳转去了另一篇，就不知道回到场景化 API 的快速开始了

建议将前提条件整个章节改为：
前提条件

1. 项目配置
   fragment
2. 在工程文件中引入 xxx

疑问：使用场景化 API 不需要 xcode 这些前提条件么？

[HeatherWYL]

这条 note 加在步骤 4 里是不是好些？

在这之前的描述中都没提到要使用数据流的概念，只提到了 streamId 参数，我会有点 get 不到想表达的意思，滑到步骤 4 了才知道是用 createDataStream 去创建 stream，才能有 streamid 去传入 init 方法。

[HeatherWYL]

如果你在其他模块中也使用 sendStreamMessage
这里的 sendStreamMessage 要改成 createDataStream 不？我看全文只有这一个地方提到了 sendStreamMessage，不确定是不是写错了。

[HeatherWYL]

初始化 KTV 模块调用了 5 个 API，但图片里只写了 initWithRtcEngine。是因为只有 initWithRtcEngine 属于 KTV 场景化 API 么？

sharedEngineWithAppId、sharedContentCenterWithConfig、createMusicPlayerWithDelegate、createDataStream 这四个 API 都是必须调用的么？如果是的话，还是建议时序图里加上。

[HeatherWYL]

52 和 53 是监听回调相关实现，文内没有其他地方有解释说明，建议这里加个行内注释说明下

[HeatherWYL]

这里面的四个 API 有 API 文档么？我没搜索到

[HeatherWYL]

歌曲加载失败的操作

因为当前这步骤没代码，看不出重试三次的逻辑。

[HeatherWYL]

这步骤没有监听回调的示例代码。标题是不是只需写控制歌曲播放？

[HeatherWYL]

didChangedToState

[HeatherWYL]

建议 note 这里简单写下：
通过更新媒体选项切换用户角色、是否发布麦克风流等

然后原文的两条内容放到步骤 5 的详细描述里。

• 主唱和上麦 xxx
• 普通听众 xxx

建议理由：看到时序图的这两句话，有点不知道什么意思，理解前后文才知道是建议xx角色设置是否发布麦克风流，所以建议图片里简单写设置的目的，然后步骤里详细写各角色要怎么设置。

[HeatherWYL]

合唱的时序图和步骤描述也建议同步修改

[HeatherWYL]

歌曲加载失败操作

[HeatherWYL]

K 歌用户角色

修改理由：整篇有 clientrole 和 singrole 两种用户角色，容易引起混淆。

[HeatherWYL]

info 参数是否删除？理由同主唱实现

[HeatherWYL]

歌曲加载失败操作

[HeatherWYL]

在听众需要下麦的场景中更新媒体选项

[HeatherWYL]

在听众需要上麦聊天的场景中更新媒体选项

[HeatherWYL]

连麦只能语聊，不能合唱么？

[HeatherWYL]

订阅主唱和伴唱各自的人声和音乐合流

[HeatherWYL]

可以解释下各私参的含义不？

[HeatherWYL]

AgoraRtcEngineKit 缺代码格式

[HeatherWYL]

同上

[HeatherWYL]

同上

[HeatherWYL]

伴唱 UID 可以为 0

建议和之前的角色一样加上 uid 的描述

[kelzr]

主唱实现那里可以不填伴唱 UID。这里的伴唱实现需要填伴唱 UID。

[HeatherWYL]

默认订阅主场和伴唱各自的音频合流？

[HeatherWYL]

如果听众想上麦与主唱或伴唱语聊
主唱、伴唱和其他听众

主语中有主唱的，是不是都可以加上伴唱？

疑问：听众上麦只能语聊、不能合唱么？