SDK集成

为了保证最佳体验效果，本场景需要集成火山引擎的 RTC SDK 以及 HIFIVE 音乐开放平台的SDK，您需要在 RTC、HIFIVE的控制台开通服务，相应开通指南如下：

1. RTC SDK总体接入流程，详细步骤请参看 RTC服务开通指南。

2. HIFIVE 音乐开放平台 SDK 接入流程，详细步骤请参看 HIFIVE 集成文档。

整体实现流程

整体业务流程图

核心功能实现

当前仅提供了你已通过其他渠道获取音乐文件时，实现 KTV 场景的参考实现。RTC 也提供从曲库接入到 KTV 场景的完整能力，如果希望获取参考文档，请咨询技术支持。

创建/加入房间

时序图

示例代码

/**
 * 加入RTC房间并初始化参数 
 * @param token 加入 RTC 房间的 token
 * @param roomId 加入 RTC 房间的 id
 * @param userId 加入 RTC 房间的 用户id
 * @param isHost true 是业务上主播角色；false 是业务上观众角色
 */
public void joinRTCRoom(String token, String roomId, String userId, boolean isHost) {
    // 初始化 RTCVideo 对象
    mRTCVideo = RTCVideo.createRTCVideo(applicationContext, appId, mIRTCVideoEventHandler, null, null);

    // 初始化 RTCRoom 对象
    mRTCRoom = mRTCVideo.createRTCRoom(roomId);
    mRTCRoom.setRTCRoomEventHandler(mIRTCRoomEventHandler);

    // 设置音频场景类型 Music
    mRTCVideo.setAudioScenario(AudioScenarioType.AUDIO_SCENARIO_MUSIC);
    
    // 设置音频双声道音乐音质
    mRTCVideo.setAudioProfile(AudioProfileType.AUDIO_PROFILE_HD);
        
    // 设置主播为可见，观众为隐身
    mRTCRoom.setUserVisibility(isHost);

    // 加入房间时主播需要开启麦克风，观众需要关闭麦克风
    if (isHost) {
        mRTCVideo.startAudioCapture();
    } else {
        mRTCVideo.stopAudioCapture();
    }

    // 设置音频路由模式
    mRTCVideo.setDefaultAudioRoute(AudioRoute.AUDIO_ROUTE_SPEAKERPHONE);

    // 开启发言者音量监听
    AudioPropertiesConfig audioPropertiesConfig = new AudioPropertiesConfig(300);
    mRTCVideo.enableAudioPropertiesReport(audioPropertiesConfig);

    // 加入房间，开始连麦，需要申请AppId和Token
    UserInfo userInfo = new UserInfo(userId, null);
    RTCRoomConfig roomConfig = new RTCRoomConfig(ChannelProfile.CHANNEL_PROFILE_KTV,
            true, true, true);
    mRTCRoom.joinRoom(token, userInfo, roomConfig);
}

private final IRTCVideoEventHandler mIRTCVideoEventHandler = new IRTCVideoEventHandler() {
    /**
     * 本地用户音量回调
     */
    @Override
    public void onLocalAudioPropertiesReport(LocalAudioPropertiesInfo[] audioPropertiesInfos) {
        super.onLocalAudioPropertiesReport(audioPropertiesInfos);
    }
    /**
     * 远端用户音量回调
     */
    @Override
    public void onRemoteAudioPropertiesReport(RemoteAudioPropertiesInfo[] audioPropertiesInfos, int totalRemoteVolume) {
        super.onRemoteAudioPropertiesReport(audioPropertiesInfos, totalRemoteVolume);
    }
};
private final IRTCRoomEventHandler mIRTCRoomEventHandler = new IRTCRoomEventHandler() {
    /**
     * 收到 RTC 加入房间结果
     */
    @Override
    public void onRoomStateChanged(String roomId, String uid, int state, String extraInfo) {
    }
}

歌词同步

时序图

示例代码

/**
 * 开始演唱。在歌词/歌曲下载完成，收到开始演唱广播后执行。
 * @param filePath 歌曲的文件路径
 */
public void startStartSing(String filePath) {
    // 设置歌曲本地播放和推送到远端
    IMediaPlayer mediaPlayer = mRTCVideo.getMediaPlayer(0);
    MediaPlayerConfig playerConfig = new MediaPlayerConfig(AUDIO_MIXING_TYPE_PLAYOUT_AND_PUBLISH, 1);
    // 开始播放歌曲
    mediaPlayer.open(filePath, playerConfig);
    //播放进度回调周期
    mediaPlayer.setProgressInterval(500);
}


/**
 * 收到本地歌曲播放进度回调
 * @param playerId 播放器ID
 * @param progress 歌曲播放进度,单位为毫秒
 */
@Override
public void onMediaPlayerPlayingProgress(int playerId, long progress) {
    // 如果是演唱者
    if (isSinger) {
        // 刷新本地歌词进度
        syncLocalLyricsProgress(progress);

        // 发送音频流同步信息
        String progressStr = String.valueOf(progress);

        StreamSycnInfoConfig streamSycnInfoConfig = new StreamSycnInfoConfig(
                StreamIndex.STREAM_INDEX_MAIN,
                3,
                StreamSycnInfoConfig.SyncInfoStreamType.SYNC_INFO_STREAM_TYPE_AUDIO
        );
        mRTCVideo.sendStreamSyncInfo(progressStr.getBytes(StandardCharsets.UTF_8), streamSycnInfoConfig);
    }
}

/**
 * 收到音频同步信息
 * @param streamKey 远端流信息
 * @param streamType 媒体流类型
 * @param data 消息内容
 */
@Override
public void onStreamSyncInfoReceived(RemoteStreamKey streamKey, StreamSycnInfoConfig.SyncInfoStreamType streamType, ByteBuffer data) {
    Charset charset = StandardCharsets.UTF_8;
    CharsetDecoder decoder = charset.newDecoder();
    CharBuffer charBuffer = null;
    try {
        charBuffer = decoder.decode(data);
    } catch (CharacterCodingException e) {

    }
    String progressStr = charBuffer != null ? charBuffer.toString() : null;
    long progress = Long.parseLong(progressStr);

    // 观众刷新歌词进度
    syncLocalLyricsProgress(progress);
}

歌曲控制台

示例代码

/**
 * 原唱/伴奏切换，需要音乐素材支持右声道伴奏，左声道原唱
 * @param isAccompaniment 是否为伴奏，YES 为伴奏，NO 为原唱
 */
public void switchAccompaniment(boolean isAccompaniment) {
    //根据播放器ID获取前面创建的播放器
    IMediaPlayer mediaPlayer = mRTCVideo.getMediaPlayer(0);
    AudioMixingDualMonoMode audioMixingDualMonoMode = isAccompaniment ? AUDIO_MIXING_DUAL_MONO_MODE_R : AUDIO_MIXING_DUAL_MONO_MODE_L;
    //通过声道选择进行原唱伴奏切换
    mediaPlayer.setAudioDualMonoMode(audioMixingDualMonoMode);
}

/**
 * 原唱/伴奏切换，需要音乐素材支持。通过切换音轨来实现切换原唱/伴奏
 * @param audioTrackIndex 指定的播放音轨。
 */
public void setIsAccompaniment(int audioTrackIndex) {
     //根据播放器ID获取前面创建的播放器
    IMediaPlayer mediaPlayer = mRTCVideo.getMediaPlayer(0);
    //通过音轨选择进行原唱伴奏切换
    mediaPlayer.selectAudioTrack(audioTrackIndex);
}

/**
 * 暂停混音播放
 */
public void pauseSinging() {
     //根据播放器ID获取前面创建的播放器
    IMediaPlayer mediaPlayer = mRTCVideo.getMediaPlayer(0);
    //暂停播放
    mediaPlayer.pause();
}

/**
 * 恢复混音播放
 */
public void resumeSinging() {
    //根据播放器ID获取前面创建的播放器
    IMediaPlayer mediaPlayer = mRTCVideo.getMediaPlayer(0);
    //暂停播放
    mediaPlayer.resume();
}

/**
 * 开启/关闭耳返
 * @param isEnable YES 为开启耳返，NO 为关闭耳返
 */
public void enableEarMonitor(boolean isEnable) {
    mRTCVideo.setEarMonitorMode(isEnable ? EarMonitorMode.EAR_MONITOR_MODE_ON : EarMonitorMode.EAR_MONITOR_MODE_OFF);
}

/**
 * 设置耳返的音量
 * @param volume 耳返音量
 */
public void setEarMonitorVolume(int volume) {
    mRTCVideo.setEarMonitorVolume(volume);
}

/**
 * 调节本地播放和远端混音的音量大小
 * @param volume 混音音量
 */
public void setMusicVolume(int volume) {
    //根据播放器ID获取前面创建的播放器
    IMediaPlayer mediaPlayer = mRTCVideo.getMediaPlayer(0);
    mediaPlayer.setVolume(volume, AudioMixingType.AUDIO_MIXING_TYPE_PLAYOUT_AND_PUBLISH);
}

/**
 * 调节麦克风采集音量
 * @param volume 麦克风采集音量
 */
public void setRecordingVolume(int volume) {
    mRTCVideo.setCaptureVolume(StreamIndex.STREAM_INDEX_MAIN, volume);
}
    
/**
 * 设置混响特效类型
 * @param reverbType 特效类型
 */
public void setVoiceReverbType(VoiceReverbType reverbType) {
    mRTCVideo.setVoiceReverbType(reverbType);
}

核心功能 API 与回调参考

API

回调