Android端K歌房场景API

fetchMusicChartList

API含义：获取榜单列表

使用示例：

void fetchMusicChartList(@NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicChartCallback callback);

参数详情：

fetchMusicList

API含义：获取榜单歌曲列表

使用示例：

void fetchMusicList(@NonNull String chartId, int pageIndex, int pageSize, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicInfoListCallback callback);

参数详情：

fetchMusicInfo

API含义：获取歌曲信息

使用示例：

void fetchMusicInfo(@NonNull String songId, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicInfoCallback callback);

参数详情：

fetchMusicLyric

API含义：获取歌词

使用示例：

void fetchMusicLyric(@NonNull String songId, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicLyricCallback callback);

参数详情：

fetchMusicPitch

API含义：获取歌曲标准音高

使用示例：

void fetchMusicPitch(@NonNull String songId, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicPitchCallback callback);

参数详情：

searchMusic

API含义：搜索歌曲

使用示例：

void searchMusic(@NonNull String keyword, int pageIndex, int pageSize, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicInfoListCallback callback);

参数详情：

downloadMusic

API含义：下载歌曲

使用示例：

void downloadMusic(@NonNull String songId, ARTCKaraokeRoomActionCallback actionCallback);

参数详情：

addDownloadCallback

API含义：增加下载回调监听

使用示例：

void addDownloadCallback(@NonNull ARTCKaraokeRoomMusicLibraryCallback callback);

参数详情：

removeDownloadCallback

API含义：删除下载回调监听

使用示例：

void removeDownloadCallback(@NonNull ARTCKaraokeRoomMusicLibraryCallback callback);

参数详情：

fetchMusicPlayingList

API含义：获取远端播放列表（当前播放中+未播放）

使用示例：

void fetchMusicPlayingList(@NonNull ARTCKaraokeRoomMusicPlayingListServiceCallback callback);

参数详情：

checkCanAddMusic

API含义：能否点歌（权限：麦上成员可以点歌）

使用示例：

boolean checkCanAddMusic();

checkCanRemoveMusic

API含义：能否删歌（权限：房主、点歌成员可以删歌）

使用示例：

boolean checkCanRemoveMusic(@NonNull KTVPlayingMusicInfo ktvPlayingMusicInfo);

参数详情：

addMusic

API含义：点歌，歌曲下载完成后才会加入到播放列表

使用示例：

void addMusic(@NonNull KTVMusicInfo musicInfo);

参数详情：

removeMusic

API含义：删除已点歌曲

使用示例：

void removeMusic(@NonNull KTVPlayingMusicInfo ktvPlayingMusicInfo);

参数详情：

removeMusic

API含义：批量删除已点歌曲

使用示例：

void removeMusic(@NonNull List<KTVPlayingMusicInfo> ktvPlayingMusicInfoList);

参数详情：

checkCanPinMusic

API含义：能否置顶已点歌曲（权限：房主、点歌成员可以置顶）

使用示例：

boolean checkCanPinMusic(@NonNull KTVPlayingMusicInfo ktvPlayingMusicInfo);

参数详情：

pinMusic

API含义：置顶已点歌曲

使用示例：

void pinMusic(@NonNull KTVPlayingMusicInfo ktvPlayingMusicInfo);

参数详情：

getCurrentPlayingMusicInfo

API含义：获取当前播放列表中正在播放的歌曲

使用示例：

KTVPlayingMusicInfo getCurrentPlayingMusicInfo();

getLocalPlayMusicInfoList

API含义：获取本地播放列表

使用示例：

List<KTVPlayingMusicInfo> getLocalPlayMusicInfoList();

addRoomEngineCallback

API含义：增加播放引擎监听

使用示例：

void addRoomEngineCallback(@Nullable ARTCKaraokeRoomEngineCallback callback);

参数详情：

removeRoomEngineCallback

API含义：删除播放引擎监听

使用示例：

void removeRoomEngineCallback(@Nullable ARTCKaraokeRoomEngineCallback callback);

参数详情：

setSingerRole

API含义：转换演唱角色，以管理相应角色的推拉流逻辑。调用时机：开始演唱前（必须在调用playMusic()前），或者结束演唱后。

使用示例：

boolean setSingerRole(KTVSingerRole newRole);

参数详情：

loadMusic

API含义：加载音乐资源，当收到加载成功回调后即可调用playMusic()播放音乐

使用示例：

void loadMusic(@NonNull String uri);

参数详情：

loadMusic

API含义：加载音乐资源，当收到加载成功回调后即可调用playMusic()播放音乐

使用示例：

void loadMusic(@NonNull KTVMusicConfig config);

参数详情：

loadCopyrightMusic

API含义：加载版权音乐资源，当收到加载成功回调后即可调用playMusic()播放音乐

使用示例：

void loadCopyrightMusic(@NonNull String songId);

参数详情：

playMusic

API含义：播放音乐。需要先调用loadMusic()并收到加载成功回调，才能调用此方法开始播放。如果设置了KTVMusicConfig#autoPlay为 true 则可以不调用此方法；合唱者也可以不调用此方法，内部会自动同步主唱者播放状态。

使用示例：

void playMusic();

stopMusic

API含义：停止播放音乐

使用示例：

void stopMusic();

resumeMusic

API含义：继续播放音乐

使用示例：

void resumeMusic();

pauseMusic

API含义：暂停播放音乐

使用示例：

void pauseMusic();

seekMusicTo

API含义：跳到某个位置继续播放

使用示例：

void seekMusicTo(long millisecond);

参数详情：

getMusicTotalDuration

API含义：获取音乐总时长，必须在加载音乐资源成功后调用才有效，否则返回 0

使用示例：

long getMusicTotalDuration();

getMusicCurrentProgress

API含义：获取当前播放进度，必须在加载音乐资源成功后调用才有效，否则返回 0

使用示例：

long getMusicCurrentProgress();

setMusicAccompanimentMode

API含义：切换伴奏/原唱模式

使用示例：

void setMusicAccompanimentMode(boolean original);

参数详情：

setMusicVolume

API含义：设置伴奏（音乐播放）音量

使用示例：

void setMusicVolume(int volume);

参数详情：

canChangeMusicAccompanimentMode

API含义：能否切换播放模式（权限：主唱+伴唱）

使用示例：

boolean canChangeMusicAccompanimentMode();

canJoinSinging

API含义：能否加入合唱（权限：麦上且不是主唱）

使用示例：

boolean canJoinSinging();

isLeadSinger

API含义：自己是否主唱人

使用示例：

boolean isLeadSinger();

isJoinSinger

API含义：自己是否是合唱者

使用示例：

boolean isJoinSinger();

joinSinging

API含义：加入合唱

使用示例：

void joinSinging(ARTCKaraokeRoomActionCallback callback);

参数详情：

leaveSinging

API含义：退出合唱

使用示例：

void leaveSinging(ARTCKaraokeRoomActionCallback callback);

参数详情：

skipMusic

API含义：切歌

使用示例：

void skipMusic();

checkCanSkipMusic

API含义：能否删歌（权限：房主、点歌成员）

使用示例：

boolean checkCanSkipMusic(KTVPlayingMusicInfo ktvPlayingMusicInfo);

参数详情：

updateScore

API含义：同步演唱分数

使用示例：

void updateScore(int score);

参数详情：

requestRemoteKtvState

API含义：新用户进入房间可以要求同步当前的房间状态

使用示例：

void requestRemoteKtvState();

onMusicDownloadCompleted

API含义：歌曲下载完成

使用示例：

void onMusicDownloadCompleted(KTVMusicInfo ktvMusicInfo);

参数详情：

onMusicPlayingUpdated

API含义：已点歌曲列表更新

使用示例：

    /**
     * 已点歌曲列表更新
     * @param reason 歌单更新的原因 {@link KTVMusicPlayListUpdateReason}
     * @param operateUserInfo 触发动作的用户，如切歌的用户
     * @param kTVPlayingMusicInfoListUpdated 触发歌单更新相关的歌曲列表，如添加的歌曲
     * @param ktvPlayingMusicInfoList 完整歌单
     */
void onMusicPlayingUpdated(
    KTVMusicPlayListUpdateReason reason,
    UserInfo operateUserInfo,
    List<KTVPlayingMusicInfo> kTVPlayingMusicInfoListUpdated, 
    List<KTVPlayingMusicInfo> ktvPlayingMusicInfoList);

参数详情：

onMusicWillPlayNext

API含义：准备播放下一首歌曲

使用示例：

void onMusicWillPlayNext(KTVPlayingMusicInfo ktvPlayingMusicInfo, long notifyMilliseconds);

参数详情：

onRoomStateChanged

API含义：房间状态更新

使用示例：

void onRoomStateChanged(KTVRoomState oldState, KTVRoomState newState, String songId);

参数详情：

onSingingPlayStateChanged

API含义：演唱状态更新

使用示例：

void onSingingPlayStateChanged(KTVMusicPlayState oldState, KTVMusicPlayState newState, int score);

参数详情：

onKTVStateSyncRequest

API含义：新用户请求发送房间当前状态

使用示例：

void onKTVStateSyncRequest(String userId);

参数详情：

fetchMusicChartList

API含义：获取榜单列表

使用示例：

void fetchMusicChartList(@NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicChartCallback callback);

参数详情：

fetchMusicList

API含义：获取榜单歌曲列表

使用示例：

void fetchMusicList(@NonNull String chartId, int pageIndex, int pageSize, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicInfoListCallback callback);

参数详情：

fetchMusicInfo

API含义：获取歌曲信息

使用示例：

void fetchMusicInfo(@NonNull String songId, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicInfoCallback callback);

参数详情：

fetchMusicLyric

API含义：获取歌词

使用示例：

void fetchMusicLyric(@NonNull String songId, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicLyricCallback callback);

参数详情：

fetchMusicPitch

API含义：获取歌曲标准音高

使用示例：

void fetchMusicPitch(@NonNull String songId, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicPitchCallback callback);

参数详情：

searchMusic

API含义：搜索歌曲

使用示例：

void searchMusic(@NonNull String keyword, int pageIndex, int pageSize, @NonNull ARTCKaraokeRoomMusicLibraryCallback.ARTCKaraokeRoomMusicInfoListCallback callback);

参数详情：

downloadMusic

API含义：下载歌曲

使用示例：

void downloadMusic(@NonNull String songId, ARTCKaraokeRoomActionCallback actionCallback);

参数详情：

isMusicDownloaded

API含义：歌曲是否已经下载完成

使用示例：

boolean isMusicDownloaded(String songId);

参数详情：

setDownloadCallback

API含义：设置下载回调监听

使用示例：

    /**
     * 设置下载回调监听
     * @param callback {@link ARTCKaraokeRoomMusicLibraryCallback}
     */
void setDownloadCallback(ARTCKaraokeRoomMusicLibraryCallback callback);

参数详情：

destroy

API含义：销毁曲库实例

使用示例：

void destroy();

onMusicDownloadCompleted

API含义：歌曲下载成功

使用示例：

void onMusicDownloadCompleted(KTVMusicInfo musicInfo);

参数详情：

setCallback

API含义：设置演唱监听接口

使用示例：

void setCallback(@Nullable ARTCKaraokeRoomEngineCallback callback);

参数详情：

setSingerRole

API含义：转换演唱角色，以管理相应角色的推拉流逻辑。调用时机：开始演唱前（必须在调用playMusic()前），或者结束演唱后。

使用示例：

boolean setSingerRole(KTVSingerRole newRole);

参数详情：

loadMusic

API含义：加载音乐资源，当收到加载成功回调后即可调用playMusic()播放音乐

使用示例：

void loadMusic(@NonNull String uri);

参数详情：

loadMusic

API含义：加载音乐资源，当收到加载成功回调后即可调用playMusic()播放音乐

使用示例：

void loadMusic(@NonNull KTVMusicConfig config);

参数详情：

loadCopyrightMusic

API含义：加载版权音乐资源，当收到加载成功回调后即可调用playMusic()播放音乐

使用示例：

void loadCopyrightMusic(@NonNull String songId);

参数详情：

playMusic

API含义：播放音乐。需要先调用loadMusic()并收到加载成功回调，才能调用此方法开始播放。如果设置了KTVMusicConfig#autoPlay为 true 则可以不调用此方法；合唱者也可以不调用此方法，内部会自动同步主唱者播放状态。

使用示例：

void playMusic();

stopMusic

API含义：停止播放音乐

使用示例：

void stopMusic();

resumeMusic

API含义：继续播放音乐

使用示例：

void resumeMusic();

pauseMusic

API含义：暂停播放音乐

使用示例：

void pauseMusic();

seekMusicTo

API含义：跳到某个位置继续播放

使用示例：

void seekMusicTo(long millisecond);

参数详情：

getMusicTotalDuration

API含义：获取音乐总时长，必须在加载音乐资源成功后调用才有效，否则返回 0

使用示例：

long getMusicTotalDuration();

getMusicCurrentProgress

API含义：获取当前播放进度，必须在加载音乐资源成功后调用才有效，否则返回 0

使用示例：

long getMusicCurrentProgress();

setMusicAccompanimentMode

API含义：切换伴奏/原唱模式

使用示例：

void setMusicAccompanimentMode(boolean original);

参数详情：

setMusicVolume

API含义：设置伴奏（音乐播放）音量

使用示例：

void setMusicVolume(int volume);

参数详情：

onMusicPrepareStateUpdate

API含义：音乐资源准备状态回调，听众角色不会收到这个回调。

使用示例：

void onMusicPrepareStateUpdate(KTVMusicPrepareState state);

参数详情：

onMusicPlayStateUpdate

API含义：音乐播放状态回调，听众角色不会收到这个回调。

使用示例：

void onMusicPlayStateUpdate(KTVMusicPlayState state);

参数详情：

onMusicPlayProgressUpdate

API含义：音乐播放进度回调

使用示例：

void onMusicPlayProgressUpdate(long millisecond);

参数详情：

onSingerRoleUpdate

API含义：演唱角色变化回调

使用示例：

void init(Context context, ClientMode mode, String appId, UserInfo userInfo, IMNewToken token, ActionCallback callback);

参数详情：