Inherits agora_gaming_rtc.IAudioRecordingDeviceManager.

Public Member Functions

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)
 

Detailed Description

The definition of AudioRecordingDeviceManager.

Member Function Documentation

◆ CreateAAudioRecordingDeviceManager()

override bool agora_gaming_rtc.AudioRecordingDeviceManager.CreateAAudioRecordingDeviceManager ( )

Create an AudioRecordingDeviceManager instance.

Note
Ensure that you call ReleaseAAudioRecordingDeviceManager to release this instance after calling this method.
Returns
  • true: Success.
  • false: Failure.

◆ ReleaseAAudioRecordingDeviceManager()

override int agora_gaming_rtc.AudioRecordingDeviceManager.ReleaseAAudioRecordingDeviceManager ( )

Release an AudioRecordingDeviceManager instance.

Returns
  • 0: Success.
  • < 0: Failure.

◆ GetAudioRecordingDeviceCount()

override int agora_gaming_rtc.AudioRecordingDeviceManager.GetAudioRecordingDeviceCount ( )

Retrieves the total number of the indexed audio recording devices in the system.

Returns
Total number of the indexed audio recording devices.

◆ GetAudioRecordingDevice()

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

Retrieves the audio recording device associated with the index.

After calling this method, the SDK retrieves the device name and device ID according to the index.

Note
Call GetAudioRecordingDeviceCount before this method.
Parameters
indexThe index of the recording device in the system. The value of index is associated with the number of the recording device which is retrieved from GetAudioRecordingDeviceCount. For example, when the number of recording devices is 3, the value range of index is [0,2].
audioRecordingDeviceNameThe name of the recording device for the corresponding index.
audioRecordingDeviceIdThe ID of the recording device for the corresponding index.
Returns
  • 0: Success.
  • < 0: Failure.

◆ GetCurrentRecordingDevice()

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

Retrieves the device ID of the current audio recording device.

Parameters
deviceIdThe device ID of the current audio recording device.
Returns
  • 0: Success.
  • < 0: Failure.

◆ SetAudioRecordingDeviceVolume()

override int agora_gaming_rtc.AudioRecordingDeviceManager.SetAudioRecordingDeviceVolume ( int  volume)

Sets the volume of the current audio recording device.

Parameters
volumeThe volume of the current audio recording device. The value ranges between 0 (lowest volume) and 255 (highest volume).
Returns
  • 0: Success.
  • < 0: Failure.

◆ GetAudioRecordingDeviceVolume()

override int agora_gaming_rtc.AudioRecordingDeviceManager.GetAudioRecordingDeviceVolume ( )

Retrieves the volume of the current audio recording device.

Returns
  • ≥ 0: The volume of the current audio recording device, if this method call succeeds.
  • < 0: Failure.

◆ SetAudioRecordingDeviceMute()

override int agora_gaming_rtc.AudioRecordingDeviceManager.SetAudioRecordingDeviceMute ( bool  mute)

Sets whether to stop audio recording.

Parameters
muteSets whether to stop audio recording.
  • true: Stops.
  • false: Doesn't stop.
Returns
  • 0: Success.
  • < 0: Failure.

◆ IsAudioRecordingDeviceMute()

override bool agora_gaming_rtc.AudioRecordingDeviceManager.IsAudioRecordingDeviceMute ( )

Gets the status of the current audio recording device.

Returns
Whether the current audio recording device stops audio recording.
  • true: Stops.
  • false: Doesn't stop.

◆ SetAudioRecordingDevice()

override int agora_gaming_rtc.AudioRecordingDeviceManager.SetAudioRecordingDevice ( string  deviceId)

Sets the audio recording device using the device ID.

Note
  • Call GetAudioRecordingDevice before this method.
  • Plugging or unplugging the audio device does not change the device ID.
Parameters
deviceIdDevice ID of the audio recording device, retrieved by calling GetAudioRecordingDevice.
Returns
  • 0: Success.
  • < 0: Failure.

◆ StartAudioRecordingDeviceTest()

override int agora_gaming_rtc.AudioRecordingDeviceManager.StartAudioRecordingDeviceTest ( int  indicationInterval)

Starts the test of the current audio recording device.

This method tests whether the local audio devices are working properly. After calling this method, the microphone captures the local audio and plays it through the speaker. The OnVolumeIndicationHandler callback returns the local audio volume information at the set interval.

Note
  • Ensure that you call StopAudioRecordingDeviceTest after calling this method.
  • This method tests the local audio devices and does not report the network conditions.
Parameters
indicationIntervalThe time interval (ms) at which the OnVolumeIndicationHandler callback returns.
Returns
  • 0: Success.
  • < 0: Failure.

◆ StopAudioRecordingDeviceTest()

override int agora_gaming_rtc.AudioRecordingDeviceManager.StopAudioRecordingDeviceTest ( )

Stops the test of the current audio recording device.

Note
Ensure that you call this method to stop the test after calling StartAudioRecordingDeviceTest.
Returns
  • 0: Success.
  • < 0: Failure.

◆ GetCurrentRecordingDeviceInfo()

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

Retrieves the device information of the current audio recording device.

Parameters
deviceNameThe device name of the current audio recording device.
deviceIdThe device ID of the current audio recording device.
Returns
  • 0: Success.
  • < 0: Failure.