Agora Java API Reference for Android
NGIAgoraAudioDeviceManager.h
1 //
2 // Agora SDK
3 //
4 // Copyright (c) 2018 Agora.io. All rights reserved.
5 //
6 
7 #pragma once // NOLINT(build/header_guard)
8 
9 #include <cstring>
10 
11 #include "AgoraBase.h"
12 #include "AgoraRefPtr.h"
13 
14 namespace agora {
15 namespace media {
16 namespace base {
17 class IAudioFrameObserver;
18 } // namespace base
19 } // namespace media
20 
21 namespace rtc {
22 
23 static const int kAdmMaxDeviceNameSize = 128;
24 static const int kAdmMaxGuidSize = 128;
25 static const int kIntervalInMillseconds = 200;
26 
27 
28 #if defined(_WIN32) || (TARGET_OS_MAC && !TARGET_OS_IPHONE)
29 
35 struct AudioDeviceInfo {
39  char deviceName[kAdmMaxDeviceNameSize];
43  char deviceId[kAdmMaxGuidSize];
49  bool isCurrentSelected;
55  bool isPlayoutDevice;
56 
57  AudioDeviceInfo() : isCurrentSelected(false),
58  isPlayoutDevice(true) {
59  memset(deviceName, 0, sizeof(deviceName));
60  memset(deviceId, 0, sizeof(deviceId));
61  }
62 };
63 #endif // _WIN32 || (TARGET_OS_MAC && !TARGET_OS_IPHONE)
64 
69 {
70 public:
71  virtual ~IAudioDeviceManagerObserver() {}
72 
78  virtual void onDeviceStateChanged() = 0;
84  virtual void onRoutingChanged(AudioRoute route) = 0;
85 };
86 
88  public:
95  virtual int initRecording() = 0;
96 
103  virtual int startRecording() = 0;
104 
111  virtual int stopRecording() = 0;
112 
122 
132 
133  virtual ~IRecordingDeviceSource() {}
134 };
135 
143 public:
152  virtual agora_refptr<IRecordingDeviceSource> createRecordingDeviceSource(char deviceId[kAdmMaxDeviceNameSize]) = 0;
153 
161  virtual int setMicrophoneVolume(unsigned int volume) = 0;
169  virtual int getMicrophoneVolume(unsigned int& volume) = 0;
177  virtual int setSpeakerVolume(unsigned int volume) = 0;
185  virtual int getSpeakerVolume(unsigned int& volume) = 0;
195  virtual int setMicrophoneMute(bool mute) = 0;
203  virtual int getMicrophoneMute(bool& mute) = 0;
213  virtual int setSpeakerMute(bool mute) = 0;
221  virtual int getSpeakerMute(bool& mute) = 0;
222 
230  virtual int getPlayoutAudioParameters(AudioParameters* params) const = 0;
231 
239  virtual int getRecordAudioParameters(AudioParameters* params) const = 0;
240 
241 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
242 
257  virtual int setDefaultAudioRouting(AudioRoute route) = 0;
269  virtual int changeAudioRouting(AudioRoute route) = 0;
281  virtual int getCurrentRouting(AudioRoute& route) = 0;
282 #endif // __ANDROID__ || TARGET_OS_IPHONE
283 
284 #if defined(_WIN32) || (TARGET_OS_MAC && !TARGET_OS_IPHONE)
285 
295  virtual int getNumberOfPlayoutDevices() = 0;
296 
307  virtual int getNumberOfRecordingDevices() = 0;
318  virtual AudioDeviceInfo getPlayoutDeviceInfo(int index) = 0;
329  virtual AudioDeviceInfo getRecordingDeviceInfo(int index) = 0;
341  virtual int setPlayoutDevice(int index) = 0;
353  virtual int setRecordingDevice(int index) = 0;
354 #endif // _WIN32 || (TARGET_OS_MAC && !TARGET_OS_IPHONE)
355 
356 #if defined(_WIN32)
357 
368  virtual int setApplicationVolume(unsigned int volume) = 0;
380  virtual int getApplicationVolume(unsigned int& volume) = 0;
394  virtual int setApplicationMuteState(bool mute) = 0;
406  virtual int getApplicationMuteState(bool& mute) = 0;
407 #endif // _WIN32
408 
420  virtual int registerObserver(IAudioDeviceManagerObserver* observer, void(*safeDeleter)(IAudioDeviceManagerObserver*) = NULL) = 0;
429 
430 protected:
432 };
433 
434 } //namespace rtc
435 } // namespace agora
agora::rtc::INGAudioDeviceManager::setMicrophoneVolume
virtual int setMicrophoneVolume(unsigned int volume)=0
agora::rtc::INGAudioDeviceManager::setSpeakerMute
virtual int setSpeakerMute(bool mute)=0
agora::agora_refptr
Definition: AgoraRefPtr.h:34
agora::rtc::AudioParameters
Definition: AgoraMediaBase.h:69
agora::rtc::IAudioDeviceManagerObserver::onDeviceStateChanged
virtual void onDeviceStateChanged()=0
agora::rtc::INGAudioDeviceManager::getRecordAudioParameters
virtual int getRecordAudioParameters(AudioParameters *params) const =0
agora::rtc::IRecordingDeviceSource::startRecording
virtual int startRecording()=0
agora::rtc::INGAudioDeviceManager::getMicrophoneMute
virtual int getMicrophoneMute(bool &mute)=0
agora::rtc::IRecordingDeviceSource::registerAudioFrameObserver
virtual int registerAudioFrameObserver(media::base::IAudioFrameObserver *observer)=0
agora::rtc::INGAudioDeviceManager::getSpeakerVolume
virtual int getSpeakerVolume(unsigned int &volume)=0
agora::rtc::IRecordingDeviceSource
Definition: NGIAgoraAudioDeviceManager.h:87
agora::rtc::IRecordingDeviceSource::initRecording
virtual int initRecording()=0
agora::rtc::IRecordingDeviceSource::unregisterAudioFrameObserver
virtual int unregisterAudioFrameObserver(media::base::IAudioFrameObserver *observer)=0
agora::rtc::INGAudioDeviceManager::unregisterObserver
virtual int unregisterObserver(IAudioDeviceManagerObserver *observer)=0
agora::rtc::INGAudioDeviceManager::setMicrophoneMute
virtual int setMicrophoneMute(bool mute)=0
agora::rtc::INGAudioDeviceManager::getPlayoutAudioParameters
virtual int getPlayoutAudioParameters(AudioParameters *params) const =0
agora::rtc::INGAudioDeviceManager::setSpeakerVolume
virtual int setSpeakerVolume(unsigned int volume)=0
agora::rtc::INGAudioDeviceManager::getSpeakerMute
virtual int getSpeakerMute(bool &mute)=0
agora::rtc::INGAudioDeviceManager::registerObserver
virtual int registerObserver(IAudioDeviceManagerObserver *observer, void(*safeDeleter)(IAudioDeviceManagerObserver *)=NULL)=0
agora::rtc::INGAudioDeviceManager
Definition: NGIAgoraAudioDeviceManager.h:142
agora::rtc::IAudioDeviceManagerObserver
Definition: NGIAgoraAudioDeviceManager.h:69
agora::media::base::IAudioFrameObserver
Definition: AgoraMediaBase.h:166
agora::RefCountInterface
Definition: AgoraRefPtr.h:21
agora::rtc::INGAudioDeviceManager::getMicrophoneVolume
virtual int getMicrophoneVolume(unsigned int &volume)=0
agora::rtc::INGAudioDeviceManager::createRecordingDeviceSource
virtual agora_refptr< IRecordingDeviceSource > createRecordingDeviceSource(char deviceId[kAdmMaxDeviceNameSize])=0
agora::rtc::IAudioDeviceManagerObserver::onRoutingChanged
virtual void onRoutingChanged(AudioRoute route)=0
agora::rtc::IRecordingDeviceSource::stopRecording
virtual int stopRecording()=0