Agora RTC Objective-C API Reference  Refactor
NGIAgoraAudioDeviceManager.h
Go to the documentation of this file.
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 namespace agora {
14 namespace media {
15 namespace base {
17 } // namespace base
18 } // namespace media
19 
20 namespace rtc {
21 
22 static const int kAdmMaxDeviceNameSize = 128;
23 static const int kAdmMaxGuidSize = 128;
24 static const int kIntervalInMillseconds = 200;
25 
26 
27 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
28 
34 struct AudioDeviceInfo {
38  char deviceName[kAdmMaxDeviceNameSize];
42  char deviceId[kAdmMaxGuidSize];
48  bool isCurrentSelected;
54  bool isPlayoutDevice;
55 
56  AudioDeviceInfo() : isCurrentSelected(false),
57  isPlayoutDevice(true) {
58  memset(deviceName, 0, sizeof(deviceName));
59  memset(deviceId, 0, sizeof(deviceId));
60  }
61 };
62 #endif // _WIN32 || (TARGET_OS_MAC && !TARGET_OS_IPHONE)
63 
78 };
79 
84 {
85 public:
87 
93  virtual void onDeviceStateChanged() = 0;
94 
105  virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState) = 0;
106 
112  virtual void onVolumeIndication(int deviceType, int volume) = 0;
113 
119  virtual void onRoutingChanged(AudioRoute route) = 0;
120 
130  virtual void onAudioDeviceVolumeChanged(int deviceType, int volume, bool muted) = 0;
131 };
132 
134  public:
141  virtual int initRecording(const char* deviceName = NULL) = 0;
142 
149  virtual int startRecording() = 0;
150 
157  virtual int stopRecording() = 0;
158 
168 
178 
185  virtual int setLoopbackDeviceParameter(const LoopbackRecordingOption &option) = 0;
186 
188 };
189 
197 public:
207 
215  virtual int setMicrophoneVolume(unsigned int volume) = 0;
223  virtual int getMicrophoneVolume(unsigned int& volume) = 0;
231  virtual int setSpeakerVolume(unsigned int volume) = 0;
239  virtual int getSpeakerVolume(unsigned int& volume) = 0;
249  virtual int setMicrophoneMute(bool mute) = 0;
257  virtual int getMicrophoneMute(bool& mute) = 0;
267  virtual int setSpeakerMute(bool mute) = 0;
275  virtual int getSpeakerMute(bool& mute) = 0;
276 
284  virtual int getPlayoutAudioParameters(AudioParameters* params) const = 0;
285 
293  virtual int getRecordAudioParameters(AudioParameters* params) const = 0;
294 
295 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
296 
311  virtual int setDefaultAudioRouting(AudioRoute route) = 0;
323  virtual int changeAudioRouting(AudioRoute route) = 0;
335  virtual int setAudioRoutingSpeakerOn(bool enable) = 0;
347  virtual int getCurrentRouting(AudioRoute& route) = 0;
348 #endif // __ANDROID__ || TARGET_OS_IPHONE
349 
350 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
351 
361  virtual int getNumberOfPlayoutDevices() = 0;
362 
373  virtual int getNumberOfRecordingDevices() = 0;
384  virtual AudioDeviceInfo getPlayoutDeviceInfo(int index) = 0;
395  virtual AudioDeviceInfo getRecordingDeviceInfo(int index) = 0;
407  virtual int setPlayoutDevice(int index) = 0;
419  virtual int setRecordingDevice(int index) = 0;
431  virtual int followSystemPlaybackDevice(bool enable) = 0;
432 
444  virtual int followSystemRecordingDevice(bool enable) = 0;
445 #endif // _WIN32 || (TARGET_OS_MAC && !TARGET_OS_IPHONE)
446 
447 #if defined(_WIN32)
448 
459  virtual int setApplicationVolume(unsigned int volume) = 0;
471  virtual int getApplicationVolume(unsigned int& volume) = 0;
485  virtual int setApplicationMuteState(bool mute) = 0;
497  virtual int getApplicationMuteState(bool& mute) = 0;
508  virtual AudioDeviceInfo getLoopbackDeviceInfo(int index) = 0;
520  virtual int setLoopbackDevice(int index) = 0;
532  virtual int followSystemLoopbackDevice(bool enable) = 0;
533 #endif // _WIN32
534 
546  virtual int registerObserver(IAudioDeviceManagerObserver* observer, void(*safeDeleter)(IAudioDeviceManagerObserver*) = NULL) = 0;
555 
556  virtual int setupAudioAttributeContext(void* audioAttr) = 0;
557 
558 protected:
560 };
561 
562 } //namespace rtc
563 } // namespace agora
agora::rtc::INGAudioDeviceManager::setSpeakerMute
virtual int setSpeakerMute(bool mute)=0
agora::media::IAudioPcmFrameSink
Definition: AgoraMediaBase.h:845
AgoraBase.h
agora::rtc::INGAudioDeviceManager::setMicrophoneVolume
virtual int setMicrophoneVolume(unsigned int volume)=0
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::IRecordingDeviceSource::setLoopbackDeviceParameter
virtual int setLoopbackDeviceParameter(const LoopbackRecordingOption &option)=0
agora::rtc::IAudioDeviceManagerObserver::~IAudioDeviceManagerObserver
virtual ~IAudioDeviceManagerObserver()
Definition: NGIAgoraAudioDeviceManager.h:86
agora::rtc::AudioParameters
Definition: AgoraMediaBase.h:159
agora::rtc::INGAudioDeviceManager::getRecordAudioParameters
virtual int getRecordAudioParameters(AudioParameters *params) const =0
agora::rtc::AudioRoute
AudioRoute
Definition: AgoraMediaBase.h:102
agora::rtc::INGAudioDeviceManager::createRecordingDeviceSource
virtual agora_refptr< IRecordingDeviceSource > createRecordingDeviceSource(char deviceId[kAdmMaxDeviceNameSize])=0
agora::rtc::INGAudioDeviceManager::~INGAudioDeviceManager
~INGAudioDeviceManager()
Definition: NGIAgoraAudioDeviceManager.h:559
agora::rtc::IAudioDeviceManagerObserver::onVolumeIndication
virtual void onVolumeIndication(int deviceType, int volume)=0
agora::media::IAudioFrameObserver
Definition: AgoraMediaBase.h:1113
agora::rtc::INGAudioDeviceManager::getMicrophoneMute
virtual int getMicrophoneMute(bool &mute)=0
agora::rtc::IRecordingDeviceSource::startRecording
virtual int startRecording()=0
agora::rtc::INGAudioDeviceManager::getPlayoutAudioParameters
virtual int getPlayoutAudioParameters(AudioParameters *params) const =0
agora::rtc::INGAudioDeviceManager::setMicrophoneMute
virtual int setMicrophoneMute(bool mute)=0
agora::rtc::INGAudioDeviceManager::getSpeakerMute
virtual int getSpeakerMute(bool &mute)=0
agora::rtc::INGAudioDeviceManager::getMicrophoneVolume
virtual int getMicrophoneVolume(unsigned int &volume)=0
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::kAdmMaxGuidSize
static const int kAdmMaxGuidSize
Definition: NGIAgoraAudioDeviceManager.h:23
agora::rtc::IAudioDeviceManagerObserver::onAudioDeviceVolumeChanged
virtual void onAudioDeviceVolumeChanged(int deviceType, int volume, bool muted)=0
agora::rtc::LoopbackRecordingOption
Definition: NGIAgoraAudioDeviceManager.h:69
agora::rtc::INGAudioDeviceManager::changeAudioRouting
virtual int changeAudioRouting(AudioRoute route)=0
agora::rtc::INGAudioDeviceManager::setSpeakerVolume
virtual int setSpeakerVolume(unsigned int volume)=0
agora::rtc::LoopbackRecordingOption::allowDeviceChange
Optional< bool > allowDeviceChange
Definition: NGIAgoraAudioDeviceManager.h:77
agora::rtc::IRecordingDeviceSource
Definition: NGIAgoraAudioDeviceManager.h:133
agora::rtc::kIntervalInMillseconds
static const int kIntervalInMillseconds
Definition: NGIAgoraAudioDeviceManager.h:24
agora::rtc::kAdmMaxDeviceNameSize
static const int kAdmMaxDeviceNameSize
Definition: NGIAgoraAudioDeviceManager.h:22
agora::rtc::IAudioDeviceManagerObserver::onAudioDeviceStateChanged
virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)=0
agora::rtc::INGAudioDeviceManager::getCurrentRouting
virtual int getCurrentRouting(AudioRoute &route)=0
agora::rtc::IRecordingDeviceSource::registerAudioFrameObserver
virtual int registerAudioFrameObserver(media::IAudioPcmFrameSink *observer)=0
agora::rtc::IAudioDeviceManagerObserver::onDeviceStateChanged
virtual void onDeviceStateChanged()=0
agora::rtc::IRecordingDeviceSource::unregisterAudioFrameObserver
virtual int unregisterAudioFrameObserver(media::IAudioPcmFrameSink *observer)=0
agora::rtc::IAudioDeviceManagerObserver::onRoutingChanged
virtual void onRoutingChanged(AudioRoute route)=0
agora::rtc::IRecordingDeviceSource::initRecording
virtual int initRecording(const char *deviceName=NULL)=0
AgoraRefPtr.h
agora::rtc::INGAudioDeviceManager
Definition: NGIAgoraAudioDeviceManager.h:196
agora::rtc::IAudioDeviceManagerObserver
Definition: NGIAgoraAudioDeviceManager.h:84
agora::rtc::INGAudioDeviceManager::setAudioRoutingSpeakerOn
virtual int setAudioRoutingSpeakerOn(bool enable)=0
agora::rtc::INGAudioDeviceManager::getSpeakerVolume
virtual int getSpeakerVolume(unsigned int &volume)=0
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::INGAudioDeviceManager::registerObserver
virtual int registerObserver(IAudioDeviceManagerObserver *observer, void(*safeDeleter)(IAudioDeviceManagerObserver *)=NULL)=0
agora::rtc::INGAudioDeviceManager::setDefaultAudioRouting
virtual int setDefaultAudioRouting(AudioRoute route)=0
agora::rtc::INGAudioDeviceManager::unregisterObserver
virtual int unregisterObserver(IAudioDeviceManagerObserver *observer)=0
agora::rtc::IRecordingDeviceSource::stopRecording
virtual int stopRecording()=0
agora::rtc::INGAudioDeviceManager::setupAudioAttributeContext
virtual int setupAudioAttributeContext(void *audioAttr)=0
agora::rtc::IRecordingDeviceSource::~IRecordingDeviceSource
virtual ~IRecordingDeviceSource()
Definition: NGIAgoraAudioDeviceManager.h:187
agora::rtc::LoopbackRecordingOption::deviceName
Optional< const char * > deviceName
Definition: NGIAgoraAudioDeviceManager.h:73
agora::Optional< const char * >