DingRtcEngineAudioDeviceManager

接口说明

目录

音频设备相关接口

接口详情

• GetRecordingDeviceList：获取系统中的录音设备列表。

  RtcEngineDeviceInfoList * GetRecordingDeviceList ()=0

  返回说明

  系统中的录音设备列表。

  重要

  返回值需要判断是否为空。如果不为空，用完后调用Release()释放。

• GetCurrentRecordingDeviceId：获取使用的录音设备id。

  String GetCurrentRecordingDeviceId ()=0

  返回说明

  当前音频采集设备id。

• SetCurrentRecordingDeviceId：选择录音设备id。

  int SetCurrentRecordingDeviceId (const char *deviceId)=0

  参数	类型	描述

  参数	类型	描述
  deviceId	const char *	音频采集设备id。

  返回说明

  0：成功；非0：失败。

• GetPlayoutDeviceList：获取系统中的扬声器列表。

  RtcEngineDeviceInfoList * GetPlayoutDeviceList ()=0

  返回说明

  音频播放设备列表。

  重要

  返回值需要判断是否为空。如果不为空，用完后调用Release()释放。

• GetCurrentPlayoutDeviceId：获取当前使用的扬声器id。

  String GetCurrentPlayoutDeviceId ()=0

  返回说明

  当前音频播放设备id。

• SetCurrentPlayoutDeviceId：选择扬声器id。

  int SetCurrentPlayoutDeviceId (const char *deviceId)=0

  参数	类型	描述

  参数	类型	描述
  deviceId	const char *	音频播放设备id。

  返回说明

  0：成功；非0：失败。

• GetRecordingDeviceVolume：获取音频采集设备音量。

  int GetRecordingDeviceVolume ()=0

  返回说明

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

• SetPlayoutDeviceVolume：设置音频播放设备音量，音量范围[0,100]。

  int SetPlayoutDeviceVolume (int volume)=0

  参数	类型	描述

  参数	类型	描述
  volume	int	音量值。

  返回说明

  0：成功；非0：失败。

• SetRecordingDeviceMute：静音音频采集设备。

  int SetRecordingDeviceMute (bool mute)=0

  参数	类型	描述

  参数	类型	描述
  mute	bool	是否静音。 true：设备设置为静音。 false：设备设置为不静音。

  返回说明

  0：成功；非0：失败。

• SetRecordingDataMute：使用静音帧替换采集到的数据。

  int SetRecordingDataMute (bool mute)=0

  参数	类型	描述

  参数	类型	描述
  mute	bool	是否用静音帧代替采集到的音频数据。 true：使用静音帧。 false：不使用静音帧。

  返回说明

  0：成功；非0：失败。

• GetRecordingDeviceMute：获取音频采集设备静音状态。

  bool GetRecordingDeviceMute ()=0

  返回说明

  true：已静音状态；false：非静音状态。

• SetPlayoutDeviceMute：静音音频播放设备。

  int SetPlayoutDeviceMute (bool mute)=0

  参数	类型	描述

  参数	类型	描述
  mute	bool	是否静音。 true：设备设置为静音。 false：设备设置为不静音。

  返回说明

  0：成功；非0：失败。

• GetPlayoutDeviceMute：获取音频播放设备静音状态。

  bool GetPlayoutDeviceMute ()=0

  返回说明

  true：已静音状态；false：非静音状态。

• StartRecordingDeviceTest：开启音频采集设备测试。

  int StartRecordingDeviceTest ()=0

  返回说明

  0：成功；非0：失败。

  重要

  开始测试后音量信息通过OnRecordingDeviceAudioLevel回调返回。

• StopRecordingDeviceTest：停止音频采集设备测试。

  int StopRecordingDeviceTest ()=0

  返回说明

  0：成功；非0：失败。

• StartPlayoutDeviceTest：开启音频播放设备测试。

  int StartPlayoutDeviceTest (const char *waveFilePath)=0

  参数	类型	描述

  参数	类型	描述
  waveFilePath	const char *	wave文件路径。

  返回说明

  0：成功；非0：失败。

  重要

  开始测试后音量信息通过OnPlayoutDeviceAudioLevel回调返回。

• StopPlayoutDeviceTest：停止测试音频播放设备。

  int StopPlayoutDeviceTest ()=0

  返回说明

  0：成功；非0：失败。

• StartAudioCapture：开启音频采集。

  int StartAudioCapture ()=0

  返回说明

  0：成功；非0：失败。

  重要

  此接口可以控制提前打开音频采集，如果不设置，则SDK推流时会自动打开音频采集设备。停止推流后，采集设备会被自动关闭。

• StopAudioCapture：关闭音频采集。

  int StopAudioCapture ()=0

  返回说明

  0：成功；非0：失败。

  重要

  此接口可以提前关闭音频采集，如果不设置，则SDK停止推流时会自动关闭音频采集设备。

• StartAudioPlayer：开启音频播放。

  int StartAudioPlayer ()=0

  返回说明

  0：成功；非0：失败。

  重要

  此接口可以控制提前打开音频播放，如果不设置，则SDK订阅到音频流后自动打开音频播放设备。停止订阅后，播放设备会被自动关闭。

• StopAudioPlayer：关闭音频播放。

  int StopAudioPlayer ()=0

  返回说明

  0：成功；非0：失败。

  重要

  此接口可以提前关闭音频播放，如果不设置，则SDK停止订阅时会自动关闭音频播放设备。

• EnableAudioLevelObserver：开启/关闭音频设备音量观测。

  int EnableAudioLevelObserver (RtcEngineDeviceType deviceType, bool enable)=0

  参数	类型	描述

  参数	类型	描述
  deviceType	RtcEngineDeviceType	音频设备类型。
  enable	bool	true表示开启音量观测。 false表示关闭音量观测。

  返回说明

  0：成功；非0：失败。

  重要

  开启音量观测，会分别通过OnRecordingDeviceAudioLevel和OnPlayoutDeviceAudioLevel回调采集和播放设备音量值。

• EnableSystemAudio：是否开启系统音频采集

  int EnableSystemAudio (bool enabled)=0

  参数	类型	描述

  参数	类型	描述
  enabled	bool	是否开启

  返回说明

  0：成功；非0：失败；

• IsSystemAudioEnabled：系统音频采集是否处于开启状态

  bool IsSystemAudioEnabled ()=0

  返回说明

  true:开启false:关闭