setEffectPitch abstract method

设置指定音效文件的音调。

通过此接口可以实现当本地人声和播放的音乐文件混音时，仅调节音乐文件的音调

使用前提

请先调用 playEffect 接口播放音效文件。

调用时机

请在引擎初始化之后调用此接口，且该方法仅可在加入房间后调用。

业务场景

适用于 K 歌中为了匹配人声，调节背景音乐音高的场景。

说明

当前音效任务结束后，此接口的设置会恢复至默认。

参数说明

effectId 指定音效的 ID。每个音效均有唯一的 ID

pitch 指定音效文件的音调。默认值为 0，即不调整音调，取值范围为 -12 ~ 12，按半音音阶调整。每相邻两个值的音高距离相差半音；取值的绝对值越大，音调升高或降低得越多。

相关接口

可以调用 getEffectPitch 方法获取指定音效文件的音调。

返回值

• 0（OK）：方法调用成功。
• 其他：方法调用失败。
  • 30003（invalidParam）：参数错误，比如 pitch 超出范围。
  • 30005（invalidState)：当前状态不支持的操作，比如找不到对应的音效任务或引擎尚未初始化。