Agora C++ API Reference for All Platforms
|
Inherits agora::RefCountInterface.
Public Member Functions | |
virtual agora_refptr< IRecordingDeviceSource > | createRecordingDeviceSource (char deviceId[kAdmMaxDeviceNameSize])=0 |
virtual int | setMicrophoneVolume (unsigned int volume)=0 |
virtual int | getMicrophoneVolume (unsigned int &volume)=0 |
virtual int | setSpeakerVolume (unsigned int volume)=0 |
virtual int | getSpeakerVolume (unsigned int &volume)=0 |
virtual int | setMicrophoneMute (bool mute)=0 |
virtual int | getMicrophoneMute (bool &mute)=0 |
virtual int | setSpeakerMute (bool mute)=0 |
virtual int | getSpeakerMute (bool &mute)=0 |
virtual int | getPlayoutAudioParameters (AudioParameters *params) const =0 |
virtual int | getRecordAudioParameters (AudioParameters *params) const =0 |
virtual int | setDefaultAudioRouting (AudioRoute route)=0 |
virtual int | changeAudioRouting (AudioRoute route)=0 |
virtual int | getCurrentRouting (AudioRoute &route)=0 |
virtual int | getNumberOfPlayoutDevices ()=0 |
virtual int | getNumberOfRecordingDevices ()=0 |
virtual AudioDeviceInfo | getPlayoutDeviceInfo (int index)=0 |
virtual AudioDeviceInfo | getRecordingDeviceInfo (int index)=0 |
virtual int | setPlayoutDevice (int index)=0 |
virtual int | setRecordingDevice (int index)=0 |
virtual int | followSystemPlaybackDevice (bool enable)=0 |
virtual int | followSystemRecordingDevice (bool enable)=0 |
virtual int | setApplicationVolume (unsigned int volume)=0 |
virtual int | getApplicationVolume (unsigned int &volume)=0 |
virtual int | setApplicationMuteState (bool mute)=0 |
virtual int | getApplicationMuteState (bool &mute)=0 |
virtual AudioDeviceInfo | getLoopbackDeviceInfo (int index)=0 |
virtual int | setLoopbackDevice (int index)=0 |
virtual int | followSystemLoopbackDevice (bool enable)=0 |
virtual int | registerObserver (IAudioDeviceManagerObserver *observer, void(*safeDeleter)(IAudioDeviceManagerObserver *)=NULL)=0 |
virtual int | unregisterObserver (IAudioDeviceManagerObserver *observer)=0 |
![]() | |
virtual void | AddRef () const =0 |
virtual RefCountReleaseStatus | Release () const =0 |
virtual bool | HasOneRef () const =0 |
Protected Member Functions | |
~INGAudioDeviceManager () | |
![]() | |
virtual | ~RefCountInterface () |
The INGAudioDeciceManager class.
This class provides access to audio volume and audio route control, as well as device enumeration and selection on the PC.
|
inlineprotected |
|
pure virtual |
Creates a audio device source object and returns the pointer.
|
pure virtual |
Sets the volume of the microphone.
volume | The volume of the microphone. The value range is [0, 255]. |
|
pure virtual |
Gets the volume of the microphone.
volume | The volume of the microphone. |
|
pure virtual |
Sets the volume of the speaker.
volume | The volume of the speaker. The value range is [2, 255]. |
|
pure virtual |
Gets the volume of the speaker.
volume | The volume of the speaker. |
|
pure virtual |
Captures or stops capturing the local audio with the microphone.
mute | Determines whether to capture or stop capturing the local audio with the microphone.
|
|
pure virtual |
Gets the mute state of the microphone.
mute | The mute state of the microphone. |
|
pure virtual |
Plays or stops playing the remote audio with the speaker.
mute | Determines whether to play or stop playing the remote audio.
|
|
pure virtual |
Gets the mute state of the speaker.
mute | A reference to the mute state of the speaker. |
|
pure virtual |
Get the playout parameters of audio device.
params | A point to the struct AudioParameters. |
|
pure virtual |
Get the record parameters of audio device.
params | A point to the struct AudioParameters. |
|
pure virtual |
Sets the default audio routing.
This method allows apps to change the current audio route for the received audio. Noted: In Low Level API, we don't support default audio routing, i.e., setDefaultAudioRouteToSpeakerphone. This can be done in RTC engine.
route | The default audio route. See AudioRoute. |
|
pure virtual |
Changes the current audio routing.
route | The audio route that you want to change to. See AudioRoute. |
|
pure virtual |
Gets the current audio routing.
route | A reference to the audio route: AudioRoute. |
|
pure virtual |
Gets the index numbers of all audio playout devices.
|
pure virtual |
Gets the index numbers of all audio recording devices.
|
pure virtual |
Gets the information of the current audio playout device.
index | The index number of the current audio playout device. |
|
pure virtual |
Gets the information of the current recording device.
index | The index number of the current recording device. |
|
pure virtual |
Sets the audio playback device.
index | The index number of the audio playout device. |
|
pure virtual |
Sets the recording device.
index | The index number of the recording device. |
|
pure virtual |
The status of following system default playback device.
enable | Variable to whether the current device follow system default playback device or not.
|
|
pure virtual |
The status of following system default recording device.
enable | Variable to whether the current device follow system default recording device or not.
|
|
pure virtual |
Sets the volume of the app.
volume | The volume of the app. The value range is [0, 255]. |
|
pure virtual |
Gets the volume of the app.
volume | The volume of the app. The value range is [0, 255]. |
|
pure virtual |
Sets the mute state of the app.
mute | Determines whether to set the app to the mute state.
|
|
pure virtual |
Gets the mute state of the app.
mute | A reference to the mute state of the app. |
|
pure virtual |
Gets the information of the current audio loopback device.
index | The index number of the current audio playout device. |
|
pure virtual |
Sets the audio loopback device.
index | The index number of the audio playout device. |
|
pure virtual |
The status of following system default loopback device.
enable | Variable to whether the current device follow system default loopback device or not.
|
|
pure virtual |
Registers an IAudioDeviceManagerObserver object.
You need to implement the IAudioDeviceManageObserver class in this method, and register callbacks according to your scenario.
observer | A pointer to the IAudioDeviceManagerObserver class. |
|
pure virtual |
Releases the IAudioDeviceManagerObserver object.
observer | The pointer to the IAudioDeviceManagerObserver class registered using registerObserver. |