接口說明

目錄

伴奏混音相關(guān)功能接口

接口詳情

• CreateAudioMixing：創(chuàng)建伴奏混音實例。

  int CreateAudioMixing (int id, const String &filePath)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id，用戶分配。
  filePath	const ding::rtc::String &	伴奏文件路徑。

  返回說明

  0：成功；非0：失敗。

• DestroyAudioMixing：銷毀伴奏混音實例。

  int DestroyAudioMixing (int id)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。

  返回說明

  0：成功；非0：失敗。

• StartAudioMixing：開始伴奏混音。

  int StartAudioMixing (int id, RtcEngineAudioMixingConfig &config)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。
  config	RtcEngineAudioMixingConfig &	伴奏文件配置，參考RtcEngineAudioMixingConfig。

  返回說明

  0：成功；非0：失敗。

  重要

  可通過OnAudioMixingStateChanged監(jiān)聽播放狀態(tài)。

• StopAudioMixing：停止伴奏混音。

  int StopAudioMixing (int id)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。

  返回說明

  0：成功；非0：失敗。

• PauseAudioMixing：暫停伴奏混音。

  int PauseAudioMixing (int id)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。

  返回說明

  0：成功；非0：失敗。

• ResumeAudioMixing：暫停后恢復(fù)伴奏混音。

  int ResumeAudioMixing (int id)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。

  返回說明

  0：成功；非0：失敗。

• GetAudioMixingDuration：獲取伴奏時長。

  long GetAudioMixingDuration (int id)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。

  返回說明

  伴奏時長，單位ms。返回值為-1時，說明獲取時長失敗。

• GetAudioMixingCurrentPosition：獲取當(dāng)前伴奏播放時長。

  long GetAudioMixingCurrentPosition (int id)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。

  返回說明

  當(dāng)前伴奏播放時長，單位ms。返回值為-1時，說明獲取時長失敗。

• SetAudioMixingPosition：設(shè)置伴奏播放位置。

  int SetAudioMixingPosition (int id, long position)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。
  position	long	設(shè)置伴奏播放位置，單位ms。

  返回說明

  0：成功；非0：失敗。

• SetAudioMixingVolume：設(shè)置伴奏音量。

  int SetAudioMixingVolume (int id, int volume)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。
  volume	int	伴奏音量，取值[0,100]。

  返回說明

  0：成功；非0：失敗。

• GetAudioMixingVolume：獲取伴奏音量。

  int GetAudioMixingVolume (int id)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。

  返回說明

  伴奏音量，<0代表獲取失敗。

• SetAudioMixingPublishVolume：設(shè)置伴奏推流音量。

  int SetAudioMixingPublishVolume (int id, int volume)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。
  volume	int	伴奏推流音量，取值[0,100]。

  返回說明

  0：成功；非0：失敗。

• GetAudioMixingPublishVolume：獲取伴奏推流音量。

  int GetAudioMixingPublishVolume (int id)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。

  返回說明

  伴奏推流音量，<0代表獲取失敗。

• SetAudioMixingPlayoutVolume：設(shè)置伴奏播放音量。

  int SetAudioMixingPlayoutVolume (int id, int volume)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。
  volume	int	伴奏播放音量，取值[0,100]。

  返回說明

  0：成功；非0：失敗。

• GetAudioMixingPlayoutVolume：獲取伴奏播放音量。

  int GetAudioMixingPlayoutVolume (int id)=0

  參數(shù)	類型	描述
  id	int	伴奏文件id。

  返回說明

  伴奏播放音量，<0代表獲取失敗。