産品百科 ｜ RTC Android SDK 播放音效檔案的接口方法

阿裡雲 RTC SDK 為您提供伴奏檔案和音效檔案的相關接口方法，您可以通過本文了解其具體的實作方法。

伴奏檔案

伴奏檔案的接口方法如下所示。

• 調用 startAudioAccompany 開始混音伴奏。

//接口方法
public abstract int startAudioAccompany(String fileName, boolean onlyLocalPlay, boolean replaceMic, int loopCycles) ;
//示例方法
int ret =  mAliRtcEngine.startAudioAccompany(audioFileName, localPlay, replaceMic, loopCycles);      

參數	類型	描述
fileName	String	伴奏檔案路徑
onlyLocalPlay	boolean	是否隻本地播放，true：隻本地播放；false：本地播放和推流
replaceMic		是否替換麥克風采集，true：替換麥克風采集，隻有伴奏聲；false：與麥克風共存
loopCycles	int	循環次數

• 調用 pauseAudioAccompany 暫停伴奏，調用成功傳回 0，失敗傳回錯誤碼。

  說明 您需要在 startAudioAccompany 接口之後調用。

//接口方法
public abstract int pauseAudioAccompany() ;
//示例方法mAliRtcEngine.pauseAudioAccompany();      

• 調用 resumeAudioAccompany 恢複伴奏播放，調用成功傳回 0，失敗傳回錯誤碼。

  說明 您可以與 pauseAudioAccompany 接口搭配使用。

//接口方法
public abstract int resumeAudioAccompany() ;
//示例方法mAliRtcEngine.resumeAudioAccompany();      

• 調用 stopAudioAccompany 停止伴奏播放，調用成功傳回 0，失敗傳回錯誤碼。

  說明 調用該接口後會立刻停止伴奏播放，您可以與 startAudioAccompany 接口搭配使用。

//接口方法
public abstract int stopAudioAccompany() ;
//示例方法
mAliRtcEngine.stopAudioAccompany();      

• 您可以通過以下接口方法設定音量。

/**
     * 設定混音音量，需要在調用startAudioAccompany後才能生效
     * @param volume 混音音量，取值：0~100
     * @return 調用成功傳回0，失敗傳回錯誤碼
     */
    public abstract int setAudioAccompanyVolume( int volume) ;
    /**
     * 設定混音之後推流出去的音量，需要在調用startAudioAccompany後才能生效
     * @param volume 混音音量，取值：0~100
     * @return 調用成功傳回0，失敗傳回錯誤碼
     */
    public abstract int setAudioAccompanyPublishVolume(int volume) ;
    /**
     * 擷取推流出去的混音音量
     * @return 調用成功傳回0，失敗傳回錯誤碼
     */
    public abstract int getAudioAccompanyPublishVolume() ;
    /**
     * 設定混音之後本地播放的音量，需要在調用startAudioAccompany後才能生效
     * @param volume 混音音量，取值：0~100
     * @return 調用成功傳回0，失敗傳回錯誤碼
     */
    public abstract int setAudioAccompanyPlayoutVolume(int volume) ;
    /**
     * 擷取混音本地播放的音量
     * @return 調用成功傳回0，失敗傳回錯誤碼
     */
    public abstract int getAudioAccompanyPlayoutVolume() ;      

音效檔案

音效檔案的接口方法如下所示。

• 調用 preloadAudioEffect 預加載音效檔案，調用成功傳回 0，失敗傳回錯誤碼。

  說明 您設定的音效檔案 ID 會進行後續操作。

//接口方法
public abstract int preloadAudioEffect(int soundId, String filePath) ;
//示例方法
mAliRtcEngine.preloadAudioEffect(1, filePath);      

filePath		伴奏檔案路徑（建議不包含中文）
soundId		指定的檔案 ID，個數無限制

• 調用 unloadAudioEffect 根據預加載的音效檔案 ID 删除預加載音效，調用成功傳回 0，失敗傳回錯誤碼。

//代碼方法
public abstract int unloadAudioEffect(int soundId) ;
//示例方法
mAliRtcEngine.unloadAudioEffect(soundId);      

• 調用 playAudioEffect 開始播放音效，調用成功傳回 0，失敗傳回錯誤碼。

  說明 成功調用後立即播放音效，您需要在 preloadAudioEffectWithSoundId 接口之後調用。

//接口方法
public abstract int playAudioEffect(int soundId, String filePath, int cycles, boolean publish);
//示例方法
mAliRtcEngine.playAudioEffect(soundId, filePath, cycles, isPublish);      

		預加載時指定的檔案 ID
		音效檔案路徑（建議不包含中文）
cycles
publish		是否推流，false：不推流并且僅本地播放；true：本地播放和推流

• 調用 pauseAudioEffect 暫停音效，調用成功傳回 0，失敗傳回錯誤碼。

//代碼方法
public abstract int pauseAudioEffect(int soundId) ;
//示例方法
mAliRtcEngine.pauseAudioEffect(soundId);      

• 調用 resumeAudioEffect 恢複音效，調用成功傳回 0，失敗傳回錯誤碼。

  說明 您可以與 pauseAudioEffect 接口搭配使用。

//接口方法
public abstract int resumeAudioEffect(int soundId) ;
//示例方法
mAliRtcEngine.resumeAudioEffect(soundId);      

• 調用 stopAudioEffect 停止音效，調用成功傳回 0，失敗傳回錯誤碼。

  說明 成功調用之後會立刻停止音效播放，您可以與 playAudioEffect 接口搭配使用。

//接口方法
public abstract int stopAudioEffect(int soundId) ;
//示例方法
mAliRtcEngine.stopAudioEffect(soundId);      

• 您可以通過以下接口方法設定音效音量。

/**
     * 設定音效音量
     * @param soundId 音效檔案ID
     * @param volume 混音音量，取值：0~100
     * @return 調用成功傳回0，失敗傳回錯誤碼
     */
    public abstract int setAudioEffectPublishVolume(int soundId, int volume) ;
    /**
     * 擷取推流音效音量
     * @param soundId 音效檔案ID
     * @return 調用成功傳回0~100音量，失敗傳回錯誤碼
     */
    public abstract int getAudioEffectPublishVolume(int soundId) ;
    /**
     * 設定音效本地播放音量
     * @param soundId 音效檔案ID
     * @param volume 混音音量，取值：0~100
     * @return 調用成功傳回0，失敗傳回錯誤碼
     */
    public abstract int setAudioEffectPlayoutVolume(int soundId, int volume) ;
    /**
     * 擷取音效本地播放音量
     * @param soundId 音效檔案ID
     * @return 調用成功傳回0~100音量，失敗傳回錯誤碼
     */
    public abstract int getAudioEffectPlayoutVolume(int soundId) ;      

「視訊雲技術」你最值得關注的音視訊技術公衆号，每周推送來自阿裡雲一線的實踐技術文章，在這裡與音視訊領域一流工程師交流切磋。