接口說明

目錄

音頻設備相關接口

接口詳情

• GetRecordingDeviceList：獲取系統(tǒng)中的錄音設備列表。

  RtcEngineDeviceInfoList * GetRecordingDeviceList ()=0

  返回說明

  系統(tǒng)中的錄音設備列表。

  重要

  返回值需要判斷是否為空。如果不為空，用完后調用Release()釋放。

• GetCurrentRecordingDeviceId：獲取使用的錄音設備id。

  String GetCurrentRecordingDeviceId ()=0

  返回說明

  當前音頻采集設備id。

• SetCurrentRecordingDeviceId：選擇錄音設備id。

  int SetCurrentRecordingDeviceId (const char *deviceId)=0

  參數(shù)	類型	描述
  deviceId	const char *	音頻采集設備id。

  返回說明

  0：成功；非0：失敗。

• GetPlayoutDeviceList：獲取系統(tǒng)中的揚聲器列表。

  RtcEngineDeviceInfoList * GetPlayoutDeviceList ()=0

  返回說明

  音頻播放設備列表。

  重要

  返回值需要判斷是否為空。如果不為空，用完后調用Release()釋放。

• GetCurrentPlayoutDeviceId：獲取當前使用的揚聲器id。

  String GetCurrentPlayoutDeviceId ()=0

  返回說明

  當前音頻播放設備id。

• SetCurrentPlayoutDeviceId：選擇揚聲器id。

  int SetCurrentPlayoutDeviceId (const char *deviceId)=0

  參數(shù)	類型	描述
  deviceId	const char *	音頻播放設備id。

  返回說明

  0：成功；非0：失敗。

• GetRecordingDeviceVolume：獲取音頻采集設備音量。

  int GetRecordingDeviceVolume ()=0

  返回說明

  >=0：音量；<0：失敗。

• SetPlayoutDeviceVolume：設置音頻播放設備音量，音量范圍[0,100]。

  int SetPlayoutDeviceVolume (int volume)=0

  參數(shù)	類型	描述
  volume	int	音量值。

  返回說明

  0：成功；非0：失敗。

• SetRecordingDeviceMute：靜音音頻采集設備。

  int SetRecordingDeviceMute (bool mute)=0

  參數(shù)	類型	描述
  mute	bool	是否靜音。 true：設備設置為靜音。 false：設備設置為不靜音。

  返回說明

  0：成功；非0：失敗。

• SetRecordingDataMute：使用靜音幀替換采集到的數(shù)據(jù)。

  int SetRecordingDataMute (bool mute)=0

  參數(shù)	類型	描述
  mute	bool	是否用靜音幀代替采集到的音頻數(shù)據(jù)。 true：使用靜音幀。 false：不使用靜音幀。

  返回說明

  0：成功；非0：失敗。

• GetRecordingDeviceMute：獲取音頻采集設備靜音狀態(tài)。

  bool GetRecordingDeviceMute ()=0

  返回說明

  true：已靜音狀態(tài)；false：非靜音狀態(tài)。

• SetPlayoutDeviceMute：靜音音頻播放設備。

  int SetPlayoutDeviceMute (bool mute)=0

  參數(shù)	類型	描述
  mute	bool	是否靜音。 true：設備設置為靜音。 false：設備設置為不靜音。

  返回說明

  0：成功；非0：失敗。

• GetPlayoutDeviceMute：獲取音頻播放設備靜音狀態(tài)。

  bool GetPlayoutDeviceMute ()=0

  返回說明

  true：已靜音狀態(tài)；false：非靜音狀態(tài)。

• StartRecordingDeviceTest：開啟音頻采集設備測試。

  int StartRecordingDeviceTest ()=0

  返回說明

  0：成功；非0：失敗。

  重要

  開始測試后音量信息通過OnRecordingDeviceAudioLevel回調返回。

• StopRecordingDeviceTest：停止音頻采集設備測試。

  int StopRecordingDeviceTest ()=0

  返回說明

  0：成功；非0：失敗。

• StartPlayoutDeviceTest：開啟音頻播放設備測試。

  int StartPlayoutDeviceTest (const char *waveFilePath)=0

  參數(shù)	類型	描述
  waveFilePath	const char *	wave文件路徑。

  返回說明

  0：成功；非0：失敗。

  重要

  開始測試后音量信息通過OnPlayoutDeviceAudioLevel回調返回。

• StopPlayoutDeviceTest：停止測試音頻播放設備。

  int StopPlayoutDeviceTest ()=0

  返回說明

  0：成功；非0：失敗。

• EnableAudioLevelObserver：開啟/關閉音頻設備音量觀測。

  int EnableAudioLevelObserver (RtcEngineDeviceType deviceType, bool enable)=0

  參數(shù)	類型	描述
  deviceType	RtcEngineDeviceType	音頻設備類型。
  enable	bool	true表示開啟音量觀測。 false表示關閉音量觀測。

  返回說明

  0：成功；非0：失敗。

  重要

  開啟音量觀測，會分別通過OnRecordingDeviceAudioLevel和OnPlayoutDeviceAudioLevel回調采集和播放設備音量值。