小米耳返功能SDK适配说明-APP开发

1、耳返功能sdk简介

小米手机目前高通平台机型上提供K歌低延时耳返功能，用户可以在小米手机上体验震撼的K歌效果，诚邀应用开发者适配，感谢支持！

支持耳返功能的设备

itgsa接口	小米12S, 小米12S Pro，小米12S Ultra和其他出厂系统为Android 13版本的高通平台机型
小米接口	其他高通平台机型

2、sdk接入方法

2.1 权限说明

需要应用权限配置：

android.permission.MODIFY_AUDIO_SETTINGS

android.permission.RECORD_AUDIO

2.2 API使用说明

1）小米12S, 小米12S Pro，小米12S Ultra和其他出厂系统为Android 13版本的高通平台机型获取MediaClient单例，其他高通平台机型获取KaraokeMediaHelper单例

2）isSupported判断应用是否支持KTV功能使用，小米平台通过应用白名单控制是否支持app使用KTV功能。若app申请支持KTV功能，请联系我们（gengping@xiaomi.com）

3）演唱开始，先打开KTV系统，openKTVDevice

4）设置相关配置：

setMixerSoundType 混响音效类型

setEqualizerType EQ音效类型

setPlayFeedbackParam 耳返开关

setMicVolParam 耳返音量大小

5）再开启播放，最后开启录音【小米仅支持deep buffer播放方式的KTV效果】

6）演唱结束，先关闭播放、录音

7）再closeKTVDevice 关闭KTV系统

2.3 接口函数列表

itgsa结构机型

小米12S、小米12S Pro、小米12S Ultra和其他出厂系统为Android 13版本的高通平台机型

详情请参考 DEMO

接入实例参考 com.example.mediademo

函数名称	功能简介
initialize	初始化并获取KTV MediaClient单例。
getVersion	获取KTV SDK库版本号。
isDeviceSupportKaraoke	判断当前机器设备能否支持KTV。
isAppSupportKaraoke	应用是否支持KTV。【oppo、vivo返回默认值true，小米手机检测】补充说明：小米平台通过应用白名单控制是否支持app使用KTV功能。若app申请支持KTV功能，请联系我们（gengping@xiaomi.com），邮件说明应用包名和应用功能简介。
isSupported	应用是否支持KTV功能使用，注意此为前三个接口组合判断结果，通常来说三方只使用该接口判断是否支持。
getKaraokeSupportParameters	应用获取当前机器支持KTV的JSON参数信息，比如应用设置何种参数（AudioTrack的采样率、flag等，AudioRecord的source等），判断是否可以正常使用KTV功能。
openKTVDevice	打开KTV设备，此动作必须是刚发生在播放伴奏前。
closeKTVDevice	关闭KTV设备。
setPlayFeedbackParam	控制耳返开启/关闭接口，系统默认打开，建议无论怎么app调用都打开调用一次，排除其他app不正确调用的干扰。
getPlayFeedbackParam	获取当前耳返开关状态。
setMicVolParam	设置人声音量大小。
getMicVolParam	获取当前人声音量值。
setMixerSoundType	设置混响效果。（ 0:无、1:KTV、2:剧场、3:音乐厅、4:录音棚）
setEqualizerType	设置EQ均衡器音效。（0:无、1:标准、2:浑厚、3:清脆、4:明亮）
getExtMixerSoundType	扩展混响音效。
getExtEqualizerType	扩展EQ均衡器音效。

小米结构机型

详情请参考：KaraokeMediaHelper

接入实例参考 com.miui.media.KaraokeMediaHelper

函数名称	功能简介
KaraokeMediaHelper	初始化KTV工具类
isDeviceSupportKaraoke	判断当前机器设备能否支持KTV。
getKaraokeSupportParameters	应用获取当前机器支持KTV的JSON参数信息，比如应用设置何种参数（AudioTrack的采样率、flag等，AudioRecord的source等），判断是否可以正常使用KTV功能
isDeviceSupportMixerSound	判断当前机器设备能否支持KTV。
openKTVDevice	打开KTV设备，此动作必须是刚发生在播放伴奏前。
closeKTVDevice	关闭KTV设备。
isAppSupportKaraoke	应用是否支持KTV。【小米手机检测】补充说明：小米平台通过应用白名单控制是否支持app使用KTV功能。若app申请支持KTV功能，请联系我们（gengping@xiaomi.com），邮件说明应用包名和 0:无、1:KTV、2:剧场应用功能简介。
setMixerSoundType	设置混响效果。（ 0:无、1:KTV、2:剧场、3:音乐厅）
setPlayFeedbackParam	控制耳返开启/关闭接口，系统默认打开，建议无论怎么app调用都打开调用一次，排除其他app不正确调用的干扰。
setMicVolParam	设置人声音量大小。
getPlayFeedbackParam	获取当前耳返开关状态。
getMicVolParam	获取当前人声音量值。
setEqualizerType	设置EQ均衡器音效。（0:无、1:标准、2:浑厚）
getExtMixerSoundType	扩展混响音效。
getExtEqualizerType	扩展EQ均衡器音效。