继承自 agora_gaming_rtc.IAudioRecordingDeviceManager .

Public 成员函数

override bool CreateAAudioRecordingDeviceManager ()
 
override int ReleaseAAudioRecordingDeviceManager ()
 
override int GetAudioRecordingDeviceCount ()
 
override int GetAudioRecordingDevice (int index, ref string audioRecordingDeviceName, ref string audioRecordingDeviceId)
 
override int GetCurrentRecordingDevice (ref string deviceId)
 
override int SetAudioRecordingDeviceVolume (int volume)
 
override int GetAudioRecordingDeviceVolume ()
 
override int SetAudioRecordingDeviceMute (bool mute)
 
override bool IsAudioRecordingDeviceMute ()
 
override int SetAudioRecordingDevice (string deviceId)
 
override int StartAudioRecordingDeviceTest (int indicationInterval)
 
override int StopAudioRecordingDeviceTest ()
 
override int GetCurrentRecordingDeviceInfo (ref string deviceName, ref string deviceId)
 

详细描述

成员函数说明

◆ CreateAAudioRecordingDeviceManager()

override bool agora_gaming_rtc.AudioRecordingDeviceManager.CreateAAudioRecordingDeviceManager ( )

创建 AudioRecordingDeviceManager 实例。

注解
调用此方法后,请确保调用 ReleaseAAudioRecordingDeviceManager 方法释放此实例。
返回
  • true: 方法调用成功;
  • false: 方法调用失败。

◆ ReleaseAAudioRecordingDeviceManager()

override int agora_gaming_rtc.AudioRecordingDeviceManager.ReleaseAAudioRecordingDeviceManager ( )

释放 AudioRecordingDeviceManager 实例。

返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ GetAudioRecordingDeviceCount()

override int agora_gaming_rtc.AudioRecordingDeviceManager.GetAudioRecordingDeviceCount ( )

获取系统中被索引的音频录音设备的总数。

返回
被索引的音频录音设备的总数。

◆ GetAudioRecordingDevice()

override int agora_gaming_rtc.AudioRecordingDeviceManager.GetAudioRecordingDevice ( int  index,
ref string  audioRecordingDeviceName,
ref string  audioRecordingDeviceId 
)

获取某个被索引的音频录音设备的指定信息。

调用该方法后,SDK 会根据索引获取音频录音设备的设备名称和设备 ID。

注解
GetAudioRecordingDeviceCount 方法后调用该方法。
参数
index指定的索引值,必须小于 GetAudioRecordingDeviceCount 的返回值。
audioRecordingDeviceName设备名称。
audioRecordingDeviceId设备 ID。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ GetCurrentRecordingDevice()

override int agora_gaming_rtc.AudioRecordingDeviceManager.GetCurrentRecordingDevice ( ref string  deviceId)

获取当前音频录音设备的 ID。

参数
deviceId当前音频录音设备的 ID。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ SetAudioRecordingDeviceVolume()

override int agora_gaming_rtc.AudioRecordingDeviceManager.SetAudioRecordingDeviceVolume ( int  volume)

设置音频录音设备音量。

参数
volume音频录音设备音量。取值可在 [0,255]。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ GetAudioRecordingDeviceVolume()

override int agora_gaming_rtc.AudioRecordingDeviceManager.GetAudioRecordingDeviceVolume ( )

获取当前音频录音设备的音量。

返回
  • ≥ 0: 方法调用成功则返回当前音频录音设备的音量。
  • < 0: 方法调用失败。

◆ SetAudioRecordingDeviceMute()

override int agora_gaming_rtc.AudioRecordingDeviceManager.SetAudioRecordingDeviceMute ( bool  mute)

静音录音设备。

参数
mute
  • true: 设备设为静音;
  • false: 设备设为不静音。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ IsAudioRecordingDeviceMute()

override bool agora_gaming_rtc.AudioRecordingDeviceManager.IsAudioRecordingDeviceMute ( )

获取当前音频录音设备的静音状态。

返回
当前音频录音设备的静音状态。
  • true: 为静音状态;
  • false: 为非静音状态。

◆ SetAudioRecordingDevice()

override int agora_gaming_rtc.AudioRecordingDeviceManager.SetAudioRecordingDevice ( string  deviceId)

通过设备 ID 设置指定的音频录音设备。

注解
参数
deviceId设备 ID,可通过 GetAudioRecordingDevice 获取。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ StartAudioRecordingDeviceTest()

override int agora_gaming_rtc.AudioRecordingDeviceManager.StartAudioRecordingDeviceTest ( int  indicationInterval)

启动音频录音设备测试。

该方法测试音频录音设备是否能正常工作。启动测试后,SDK 通过 OnVolumeIndicationHandler 回调方法向 app 上报音量信息。

注解
  • 调用该方法后,请确保调用 StopAudioRecordingDeviceTest 停止测试。
  • 该方法仅测试本地录音设备,不报告网络状态。
参数
indicationIntervalOnVolumeIndicationHandler 回调的周期(毫秒)。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ StopAudioRecordingDeviceTest()

override int agora_gaming_rtc.AudioRecordingDeviceManager.StopAudioRecordingDeviceTest ( )

停止音频录音设备测试。

注解
请确保调用 StartAudioRecordingDeviceTest 后调用该方法停止测试。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。

◆ GetCurrentRecordingDeviceInfo()

override int agora_gaming_rtc.AudioRecordingDeviceManager.GetCurrentRecordingDeviceInfo ( ref string  deviceName,
ref string  deviceId 
)

获取当前音频录音设备的信息。

参数
deviceName当前录音设备的设备名称。
deviceId当前录音设备的设备 ID。
返回
  • 0: 方法调用成功;
  • < 0: 方法调用失败。