Agora Java API Reference for Android
Public Member Functions | List of all members
agora::streaming::IAudioDeviceManager Class Referenceabstract

#include <IAgoraStreamingKit.h>

Public Member Functions

virtual IAudioDeviceCollectionenumerateRecordingDevices ()=0
 
virtual int setRecordingDevice (const char deviceId[MAX_DEVICE_ID_LENGTH])=0
 
virtual int getRecordingDeviceInUse (char deviceId[MAX_DEVICE_ID_LENGTH], char deviceName[MAX_DEVICE_ID_LENGTH])=0
 
virtual int setRecordingDeviceVolume (unsigned int volume)=0
 
virtual int getRecordingDeviceVolume (unsigned int *volume)=0
 
virtual void release ()=0
 

Detailed Description

The IAudioDeviceManager class.

Member Function Documentation

◆ enumerateRecordingDevices()

virtual IAudioDeviceCollection* agora::streaming::IAudioDeviceManager::enumerateRecordingDevices ( )
pure virtual

Enumerates the audio recording devices.

This method returns an IAudioDeviceCollection object that includes all the audio recording devices in the system. With the IAudioDeviceCollection object, the application can enumerate the audio recording devices. The application needs to call the IAudioDeviceCollection::release() method to release the eturned object after using it.

Returns
  • Returns an IAudioDeviceCollection object that includes all the audio recording devices in the system when the call succeeds.
  • Returns NULL when the call fails.

◆ setRecordingDevice()

virtual int agora::streaming::IAudioDeviceManager::setRecordingDevice ( const char  deviceId[MAX_DEVICE_ID_LENGTH])
pure virtual

Specifies an audio recording device with the device ID.

Parameters
deviceIdID of the audio recording device. It can be retrieved by the enumerateRecordingDevices() method. Plugging or unplugging the audio device does not change the device ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getRecordingDeviceInUse()

virtual int agora::streaming::IAudioDeviceManager::getRecordingDeviceInUse ( char  deviceId[MAX_DEVICE_ID_LENGTH],
char  deviceName[MAX_DEVICE_ID_LENGTH] 
)
pure virtual

Gets the audio recording device by the device ID and device name.

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

◆ setRecordingDeviceVolume()

virtual int agora::streaming::IAudioDeviceManager::setRecordingDeviceVolume ( unsigned int  volume)
pure virtual

Sets the volume of the microphone.

Parameters
volumeThe volume of the microphone, ranging from 0 to 255.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getRecordingDeviceVolume()

virtual int agora::streaming::IAudioDeviceManager::getRecordingDeviceVolume ( unsigned int *  volume)
pure virtual

Gets the volume of the microphone.

Parameters
volumeThe volume of the microphone, ranging from 0 to 255.
Returns
  • 0: Success.
  • < 0: Failure.

◆ release()

virtual void agora::streaming::IAudioDeviceManager::release ( )
pure virtual

Releases all IAudioDeviceManager resources.