全民K歌IOT开放平台
  1. KtvSDK3.0接入说明
全民K歌IOT开放平台
  • 厂商合作流程
  • 快速接入K歌开放平台流程
  • SDK bug提单规范
  • 如何在线调试接口
  • 常见问题FAQ
  • 开放平台API错误码说明
  • 开放平台接入指南
    • 登录鉴权方式介绍V2(推荐)
    • 如何申请接入
    • CDK权限申请流程
    • 暗账号绑定明账号对接文档
    • 全民K歌暗账号登录方案
    • 获取应用级token
    • 获取登录二维码
    • 查询二维码的状态
    • 获取用户级token
    • 刷新用户级token
    • 暗账号解绑K歌uid
    • 获取暗账号绑定信息
  • KtvSDK3.0接入说明
    • KtvSDK-接入指南
    • KtvSDK-打分
    • KtvSDK-登录
    • KtvSDK-歌词
    • KtvSDK-播放
    • KtvSDK-作品录音、合成与播放2.0版
    • KtvSDK-播放页实现示例
    • KtvSDK-常见问题FAQ
    • KtvSDK-低性能设备处理
    • KtvSDK-反馈
    • KtvSDK-缓存管理
    • KtvSDK-切换音频视频清晰度
    • KtvSDK-跳过前奏
    • Ktv支付-米大师支付
    • KtvSDK-播放失败错误码说明
    • KtvSDK-3.0版本新功能
    • KtvSDK-2.0升级到3.0版本迁移指南
    • KtvSDK-多屏渲染
    • KtvSDK-多屏一起唱---歌词与打分适配
    • KtvSDK-Android4.4设备G2证书兼容处理
    • KtvSDK-APP上报
    • KtvSdk-离线缓存与离线播放
    • KtvSDK-3.0升级到4.0版本迁移指南
  • 基础类
    • tagId对照表
    • 歌曲详情
    • 查询mv的播放地址
    • 搜索
    • 搜索联想
    • 查询歌手歌曲
    • 获取歌曲歌词文件
    • Q音歌曲mid映射K歌
    • 短剧播放链接
    • 查询应用限免配置
    • 转换Q音或酷狗歌曲ID
    • 搜索(海外)
    • 查询歌手类型列表(海外)
    • 查询歌手列表(海外)
    • 查询热门歌手列表(海外)
  • 运营类
    • 排行榜id说明
    • 获取城市id列表
    • 获取专题分类列表
    • 获取云端配置
    • 热门ugc
    • 热搜词
    • 排行榜
    • 获取专题下歌曲信息
    • 获取车联渠道映射
    • 热门推荐
    • (新)排行榜
    • 综合歌单列表查询
    • 设置缓存设备
    • TV版分类歌单列表
    • 获取用户协议
    • 综合歌单列表查询(海外)
    • 榜单列表查询(海外)
    • 自建歌单列表查询(海外)
    • 获取广告配置
    • 拉取短剧合集的列表
    • 获取渠道运营位配置
    • 查询合唱榜单
    • 上报合唱榜单
    • OTA升级版本检查
  • 用户类
    • 用户信息查询
    • 删除用户UGC作品
    • 获取推荐/翻唱作品
    • 获取同城作品
    • 用户作品列表
    • 获取好友作品
    • UGC作品详情
    • 更改作品访问权限
    • 用户个推歌单
  • 支付类
    • 支付接入流程
    • 订单发货使用简述
    • 开通设备会员限免简述
    • 订单发货中通用sign计算规则
    • 通用返回结构
    • 【CDK】CDK兑换
    • 【CDK】生成CDK
    • 【CDK】CDK召回
    • 【CDK】CDK状态查询
    • 【三方支付】订单发货
    • 【三方支付】手机号发货
    • 【三方支付】订单状态查询
    • 【米大师支付】获取会员商品列表
    • 【米大师支付】未登录-查询会员商品列表
    • 【米大师支付】支付下单
    • 【米大师支付】支付成功通知
    • 【米大师支付】查询用户支付成功订单记录
    • 查询设备以及用户是否有赠送资格
    • 查询设备限免剩余时长
    • 设备会员迁移
    • 查询会员赠送时长
    • 同步支付订单接口
    • 【三方支付】存量会员迁移领取查询
    • 【三方支付】存量会员迁移接口
    • 授权设备体验会员
    • 查询用户会员信息
    • 【三方支付】超会发货
    • 取消授权设备体验会员
  • 用户作品-文件类
    • callback_url说明
    • 上传音频源文件
    • (服务端)上传音频作品的链接
  • 通用类
    • 【厂商定制】匹配搜索
    • 获取kg的短链接
    • 三方厂商通用上报
  • KtvSdk4.0接入说明
    • KtvSdk4.0接入文档
    • PK与合唱接入
    • 动效歌词接入文档
    • 手麦接入文档
    • 支持调整录制时长限制
  • 数据模型
    • Schemas
      • protocal.DelUserWorkReq
      • protocal.BarDisplay
      • protocal.GetLyricUrlReq
      • protocal.ConfigItem
      • multipart.FileHeader
      • protocal.ExchangeCdkeyReq
      • protocal.GetLyricUrlRsp
      • protocal.DelUserWorkRsp
      • protocal.GetVipProductRsp
      • protocal.GetChannelReq
      • protocal.ExchangeCdkeyRsp
      • protocal.GetMvUrlReq
      • protocal.GetHitedSongListReq
      • protocal.GoodsInfo
      • protocal.GetChannelRsp
      • protocal.ClientUgcUploadRsp
      • protocal.GetLimitFreeRestTimeReq
      • protocal.GetMvUrlRsp
      • protocal.GetHitedSongListRsp
      • protocal.VipAdItem
      • protocal.GetClassReq
      • protocal.DeleteFileReq
      • protocal.GetLimitFreeRestTimeRsp
      • protocal.GetSongInfoByQmIDReq
      • protocal.GetRecommWorkReq
      • protocal.WebOrderNotifyReq
      • protocal.GetClassRsp
      • protocal.DeleteFileRsp
      • protocal.GetPresentVipConfReq
      • protocal.GetSongInfoByQmIDRsp
      • protocal.GetRecommWorkRsp
      • protocal.WebOrderNotifyRsp
      • protocal.GetConfigReq
      • protocal.UgcUploadReq
      • protocal.GetPresentVipConfRsp
      • protocal.GetSongInfoReq
      • protocal.GetUserInfoReq
      • protocal.GetConfigRsp
      • protocal.UgcUploadRsp
      • protocal.OpenDeviceLimitReq
      • protocal.WebOrderStatusReq
      • protocal.GetSongInfoRsp
      • protocal.GetUserInfoRsp
      • protocal.GetHomePageReq
      • textproto.MIMEHeader
      • protocal.PresentNormalVipReq
      • protocal.WebOrderStatusRsp
      • protocal.GetSongUrlReq
      • protocal.GetUserWorkReq
      • protocal.GetHomePageRsp
      • protocal.PresentNormalVipRsp
      • protocal.GetSongUrlRsp
      • protocal.GetUserWorkRsp
      • protocal.GetHotRecomUgcReq
      • protocal.MvInfo
      • protocal.GetVipInfoRsp
      • protocal.GetHotRecomUgcRsp
      • protocal.SearchReqV2
      • protocal.GetWorkInfoReq
      • protocal.GetHotWordsReq
      • protocal.SearchRsp
      • protocal.GetWorkInfoRsp
      • protocal.GetHotWordsRsp
      • protocal.SingerInfo
      • protocal.SetUgcAccessRightReq
      • protocal.HomePageItem
      • protocal.SingerSongsFilterReq
      • protocal.SetUgcAccessRightRsp
      • protocal.PlayList
      • protocal.SingerSongsFilterRsp
      • protocal.RankSongReq
      • protocal.SingerSongsReq
      • protocal.UgcItem
      • protocal.RankSongRsp
      • protocal.SingerSongsRsp
      • protocal.UserFeatureSongReq
      • protocal.RecommendReq
      • protocal.SongContentStr
      • protocal.UserFeatureSongRsp
      • protocal.RecommendRsp
      • protocal.SongInfo
      • protocal.SongInfoPlus
      • protocal.Theme
      • protocal.TCLGetOpenIdReq
      • protocal.ThemeClass
      • protocal.TCLGetOpenIdRsp
      • protocal.ThemeSongsByIdReq
      • protocal.ThemeSongsByIdRsp
      • protocal.UgcItemInfo
      • protocal.Word
      • protocol.PresentNormalVipReq
      • protocol.UgcUploadRsp
      • protocol.SingerSongsRsp
      • protocol.TCLGetOpenIdRsp
      • protocol.RecommendRsp
      • protocol.Word
      • protocol.UserFeatureSongRsp
      • protocol.CheckDeviceEligibleReq
      • protocol.GetCollectListReq
      • protocol.AddCollectListReq
      • protocol.SongInfo
      • protocol.DelCollectListReq
      • protocol.VipAdItem
      • protocol.WebOrderStatusRsp
      • protocol.ClientUgcUploadReq
      • protocol.GetTopListRsp
      • protocol.OpenDeviceVipRsp
      • protocol.RefundDeviceVipReq
      • protocol.GetLyricUrlRsp
      • protocol.GetSongInfoByQmIDReq
      • protocol.GetSongInfoRsp
      • protocol.GetSongUrlRsp
      • protocol.SearchRsp
      • protocol.SingerSongsFilterReq
      • protocol.SongInfoPlus
      • protocol.GetLyricUrlReq
      • protocol.GetMvUrlReq
      • protocol.GetMvUrlRsp
      • protocol.GetSongInfoByQmIDRsp
      • protocol.GetSongInfoReq
      • protocol.GetSongUrlReq
      • protocol.MvInfo
      • protocol.SearchReqV2
      • protocol.SingerInfo
      • protocol.SingerSongsFilterRsp
      • protocol.SingerSongsReq
      • protocol.SongContentStr
      • protocol.DelCollectListRsp
      • protocol.GetHitedSongListRsp
      • protocol.GetUserWorkReq
      • protocol.GetUserWorkRsp
      • protocol.GetWorkInfoRsp
      • protocol.SetUgcAccessRightRsp
      • protocol.DelUserWorkReq
      • protocol.AddCollectListRsp
      • protocol.DelUserWorkRsp
      • protocol.GetHitedSongListReq
      • protocol.GetCollectListRsp
      • protocol.GetRecommWorkReq
      • protocol.GetUserInfoReq
      • protocol.GetUserInfoRsp
      • protocol.GetRecommWorkRsp
      • protocol.GetVipInfoRsp
      • protocol.GetWorkInfoReq
      • protocol.SetUgcAccessRightReq
      • protocol.UgcItem
      • protocol.UserFeatureSongReq
      • protocol.GoodsInfo
      • protocol.WebOrderNotifyRsp
      • protocol.GetVipProductRsp
      • protocol.BarDisplay
      • protocol.OpenDeviceVipReq
      • protocol.RefundDeviceVipRsp
      • protocol.WebOrderNotifyReq
      • protocol.WebOrderStatusReq
      • protocol.ExchangeCdkeyRsp
      • protocol.GetPresentVipConfRsp
      • protocol.PresentNormalVipRsp
      • protocol.GetLimitFreeRestTimeReq
      • protocol.GetLimitFreeRestTimeRsp
      • protocol.ExchangeCdkeyReq
      • protocol.GetPresentVipConfReq
      • protocol.OpenDeviceLimitReq
      • protocol.GetClassRsp
      • protocol.GetHomePageReq
      • protocol.GetHotRecomUgcReq
      • protocol.GetHotRecomUgcRsp
      • protocol.GetTopListReq
      • protocol.RankSongRsp
      • protocol.RecommendReq
      • protocol.ThemeClass
      • protocol.ThemeSongsByIdRsp
      • protocol.ConfigItem
      • protocol.GetChannelReq
      • protocol.GetChannelRsp
      • protocol.GetClassReq
      • protocol.GetConfigReq
      • protocol.GetConfigRsp
      • protocol.GetHomePageRsp
      • protocol.GetHotWordsReq
      • protocol.GetHotWordsRsp
      • protocol.HomePageItem
      • protocol.PlayList
      • protocol.RankSongReq
      • protocol.Theme
      • protocol.ThemeSongsByIdReq
      • protocol.UgcItemInfo
      • protocol.GetShortUrlReq
      • protocol.GetShortUrlRsp
      • protocol.SearchHintRsp
      • protocol.SearchHintReq
      • protocol.MultiPlaylistRsp
      • protocol.PlaylistInfo
      • protocol.MultiPlaylistReq
      • protocol.GetPayOrderListReq
      • protocol.GetPayOrderListRs p
      • protocol.GetUserVipInfoReq
      • protocol.GetUserVipInfoRsp
      • protocal.GetTvPlaylistSetReq
      • protocol.Playlist
      • protocol.GetTvPlaylistSetRsp
      • protocol.TvChorusUser
      • protocol.ClientUgcUploadRsp
      • protocol.Episode
      • protocol.UgcUploadReq
      • protocol.GenerateNewOrderCdkReq
      • protocol.GetMiniShowUrlReq
      • protocol.GenerateNewOrderCdkRsp
      • protocol.DeleteFileReq
      • protocol.GetVipProductReq
      • protocol.GetMiniShowUrlRsp
      • protocol.DeleteFileRsp
      • protocol.MergerQrCode
      • protocol.GetSdkTokenReq
      • protocol.GetSdkTokenRsp
      • protocol.PlacePayOrderReq
      • protocol.PlacePayOrderRsp
      • protocol.QueryReceiveTransferVipReq
      • protocol.QueryReceiveTransferVipRsp
      • protocol.ReceiveTransferVipReq
      • protocol.ReceiveTransferVipRsp
      • protocol.RecallNewCDKReq
      • protocol.QueryNewCDKReq
      • protocol.QueryNewCDKRsp
      • protocol.OpenDeviceLimitRsp
      • protocol.RecallNewCDKRsp
      • protocol.WebThirdpartyOrderReq
      • protocol.GetMiniShowCollectionReq
      • protocol.WebThirdpartyOrderRsp
      • protocol.GetMiniShowCollectionRsp
      • protocol.MiniShowItem
      • protocol.TCLGetOpenIdReq
  1. KtvSDK3.0接入说明

KtvSDK-切换音频视频清晰度

支持在播放过程中实时切换音频、视频的清晰度。
限制:播放中实时切换清晰度后,已录制的人声信息会被破坏,会影响作品合成功能。

音视频清晰度的值#

    int AUDIO_QUALITY_NORMAL = 1; //标准音质,默认
    int AUDIO_QUALITY_HQ = 3;   //HQ音质,需要是会员

    int MV_480P = 480;    //480P视频
    int MV_720P = 720;    //720P视频,默认
    int MV_1080P = 1080;   //1080P视频,需要是会员

播放前切换清晰度#

ksong.support.player.KtvPlayerConfig#setAudioQuality(SongInfoModel.AUDIO_QUALITY_HQ)
ksong.support.player.KtvPlayerConfig#setVideoQuality(SongInfoModel.MV_720P)

实时切换视频清晰度(sdk3.4版本)#

播放时直接调用此方法切换到指定的视频清晰度。会比历史方法更块。
player.switchVideoQuality(SongInfoModel.MV_720P)

实时切换视频清晰度流程(sdk3.0版本)#

总体流程:记录当前播放位置,设置清晰度,重新preload和播放,然后seek到指定位置。
//切换清晰度前记录播放位置,**PlayConsole类的功能需自行实现,不要直接用PlayConsole**。
PlayConsole.get().changeQualityPlayPosition.postValue(position)

//调用播放
playSong(playPosition)

//播放开始后,根据之前记录的播放位置,调用当前播放器的seek.
currPlayer()?.seek(PlayConsole.get().changeQualityPlayPosition.value)

//通知界面清晰度已变化
PlayConsole.get().changeQualityPlayPosition.postValue(0)
示例代码如下:
//监听视频清晰度变化
PlayConsole.get().mv720Info.observe(viewLifecycleOwner) {
            if (it?.isSelected == true && KtvPlayerConfig.getInstance().videoQuality != SongInfoModel.MV_720P) {
                KtvPlayerConfig.getInstance().videoQuality = SongInfoModel.MV_720P
                log("mv720Info changed, replay 720")
                PlayConsole.get().changeQualityPlayPosition.postValue(
                    ChangeQualityInfo(
                        playInfoVM.currPlayer()?.timeLineTime ?: 0, 1
                    )
                )
                loadSong()
                KGToast.show(getString(R.string.ktv_control_720P))
            }
        }
//...
    /**
     * 调用{@link KaraokePlayer#play} 方法后回调
     */
    override fun onPrePlay(request: KaraokePlayRequest) {
        playInfoVM.currSongInfo().value = request.songInfoObject
        playInfoVM.getShouldShowPicUrl().value = ""
    }

    override fun onPlayPrepare(request: KaraokePlayRequest) {
        super.onPlayPrepare(request)
        Logger.d(TAG, "onPlayPrepare $request")

        //将音视频资源情况记录下来,PlayConsole不是sdk的API,其中类的功能需自行实现,不要直接用PlayConsole
        if (!request.songInfoObject.oriUrl.isNullOrBlank()) {
            PlayConsole.get().setAudioCount(MediaMetaInfo.AUDIO_ALL)    //有原唱、伴奏
        } else {
            PlayConsole.get().setAudioCount(MediaMetaInfo.AUDIO_ONLY_ACC)   //无原唱,仅有伴奏
        }

        //有无对应分辨率的视频资源
        PlayConsole.get().setShow480P(request.songInfoObject.mv480Size > 0)
        PlayConsole.get().setShow720P(request.songInfoObject.mv720Size > 0)
        PlayConsole.get().setShow1080P(request.songInfoObject.mv1080Size > 0)

        //音频有无HQ资源
        PlayConsole.get().setIsShowHqAudio(request.songInfoObject.hasHq())
    }

    override fun onPlayStart(request: KaraokePlayRequest) {
        Logger.d(TAG, "onPlayStart currentMid ${request.mid}")
        //同步暂停状态
        PlayConsole.get().pause.postValue(Pause(isPause = false, isFromPlayer = true))
        updateQualityPlayPosition()
    }

    ////播放开始后,根据记录的播放位置,调用播放器的seek.
    private fun updateQualityPlayPosition() {
        PlayConsole.get().changeQualityPlayPosition.value?.let {
            Logger.d(TAG, "changeQualityPlayPosition $it")
            if (it <= 0) {
                return
            }
            playInfoVM.currPlayer()?.seek(it)
            mHandler.postDelayed({
                Logger.d(TAG, "changeQualityPlayPosition set it 0")
                PlayConsole.get().changeQualityPlayPosition.postValue(0)
                var content = ""
                if (KtvPlayerConfig.getInstance().videoQuality == SongInfoModel.MV_1080P) {
                    content = "已切换为1080P"
                }
                if (KtvPlayerConfig.getInstance().videoQuality == SongInfoModel.MV_720P) {
                    content = "已切换为720P"
                }
                if (KtvPlayerConfig.getInstance().videoQuality == SongInfoModel.MV_480P) {
                    content = "已切换为480P"
                }
                KGToast.show(content)
            }, 300)
        }
    }

实时切换音质#

        //判断音频有无HQ资源
        PlayConsole.get().setIsShowHqAudio(request.songInfoObject.hasHq())

        //触发HQ切换
        hqAudioButton.setOnClickListener {
            PlayConsole.switchHqAudio()
        }

        //监听音质切换
        PlayConsole.get().hqAudio.observe(viewLifecycleOwner) {
            if (it.isSelected && KtvPlayerConfig.getInstance().audioQuality != SongInfoModel.AUDIO_QUALITY_HQ) {
                KtvPlayerConfig.getInstance().audioQuality = SongInfoModel.AUDIO_QUALITY_HQ
                playSong(playInfoVM.currPlayer()?.timeLineTime ?: 0)
                KGToast.show(getString(R.string.ktv_control_hq_open))
            } else if (!it.isSelected && KtvPlayerConfig.getInstance().audioQuality != SongInfoModel.AUDIO_QUALITY_NORMAL) {
                KtvPlayerConfig.getInstance().audioQuality = SongInfoModel.AUDIO_QUALITY_NORMAL
                playSong(playInfoVM.currPlayer()?.timeLineTime ?: 0)
                KGToast.show(getString(R.string.ktv_control_hq_close))
            }
        }

播放代码示例:playSong#

播放详见"KtvSDK-接入指南"的3.4节。
    private fun playSong(position: Long = 0) {
        val builder = SongInfoObject.Builder()
        builder.setMid(currentMid)
        //设置歌曲类型,从SongType类取值
        builder.setSongType(songType)
        val songInfoObject = builder.build()
        PlayConsole.get().changeQualityPlayPosition.postValue(position)
        Logger.d(TAG, "set changeQualityPlayPosition position $position")

        playInfoVM.waitQuerySongInfo().value = songInfoObject
        PlayerManager.createPreLoader(playType)
            .preload(songInfoObject) { event: PlayPreLoaderEvent ->
                if (!isAdded) {
                    Logger.d(TAG, "playFragment invisible, not play")
                    return@preload
                }
                when (event) {
                    //预加载完成
                    is PlayPreLoaderEvent.Success -> {
                            //进行播放
                            playSong(it)
                            playInfoVM.preloadProgress().value = 100
                        }
                    }

                    is PlayPreLoaderEvent.Trace -> {
                        Logger.i(TAG, event.tracePrint())
                    }

                    is PlayPreLoaderEvent.Progress -> {
                        Logger.i(TAG, "preload $event")
                        playInfoVM.preloadProgress().value = event.progress
                    }

                    is PlayPreLoaderEvent.Failed -> {
                        Logger.i(TAG, "preload $event")
                        showErrorDialog(event.exception)
                    }

                    else -> {}
                }
            }

    }
修改于 2025-10-24 02:29:25
上一页
KtvSDK-缓存管理
下一页
KtvSDK-跳过前奏
Built with