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 
14 namespace agora {
15 namespace media {
16 namespace base {
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) || (defined(__APPLE__) && 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:
72 
78  virtual void onDeviceStateChanged() = 0;
79 
90  virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState) = 0;
91 
96  virtual void onVolumeIndication(int volume) = 0;
97 
103  virtual void onRoutingChanged(AudioRoute route) = 0;
104 
114  virtual void onAudioDeviceVolumeChanged(int deviceType, int volume, bool muted) = 0;
115 };
116 
118  public:
125  virtual int initRecording(const char* deviceName = NULL) = 0;
126 
133  virtual int startRecording() = 0;
134 
141  virtual int stopRecording() = 0;
142 
152 
162 
164 };
165 
173 public:
183 
191  virtual int setMicrophoneVolume(unsigned int volume) = 0;
199  virtual int getMicrophoneVolume(unsigned int& volume) = 0;
207  virtual int setSpeakerVolume(unsigned int volume) = 0;
215  virtual int getSpeakerVolume(unsigned int& volume) = 0;
225  virtual int setMicrophoneMute(bool mute) = 0;
233  virtual int getMicrophoneMute(bool& mute) = 0;
243  virtual int setSpeakerMute(bool mute) = 0;
251  virtual int getSpeakerMute(bool& mute) = 0;
252 
260  virtual int getPlayoutAudioParameters(AudioParameters* params) const = 0;
261 
269  virtual int getRecordAudioParameters(AudioParameters* params) const = 0;
270 
271 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
272 
287  virtual int setDefaultAudioRouting(AudioRoute route) = 0;
299  virtual int changeAudioRouting(AudioRoute route) = 0;
311  virtual int getCurrentRouting(AudioRoute& route) = 0;
312 #endif // __ANDROID__ || TARGET_OS_IPHONE
313 
314 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
315 
325  virtual int getNumberOfPlayoutDevices() = 0;
326 
337  virtual int getNumberOfRecordingDevices() = 0;
348  virtual AudioDeviceInfo getPlayoutDeviceInfo(int index) = 0;
359  virtual AudioDeviceInfo getRecordingDeviceInfo(int index) = 0;
371  virtual int setPlayoutDevice(int index) = 0;
383  virtual int setRecordingDevice(int index) = 0;
384 #endif // _WIN32 || (TARGET_OS_MAC && !TARGET_OS_IPHONE)
385 
386 #if defined(_WIN32)
387 
398  virtual int setApplicationVolume(unsigned int volume) = 0;
410  virtual int getApplicationVolume(unsigned int& volume) = 0;
424  virtual int setApplicationMuteState(bool mute) = 0;
436  virtual int getApplicationMuteState(bool& mute) = 0;
437 #endif // _WIN32
438 
450  virtual int registerObserver(IAudioDeviceManagerObserver* observer, void(*safeDeleter)(IAudioDeviceManagerObserver*) = NULL) = 0;
459 
460 protected:
462 };
463 
464 } //namespace rtc
465 } // namespace agora
agora::rtc::INGAudioDeviceManager::setSpeakerMute
virtual int setSpeakerMute(bool mute)=0
AgoraBase.h
agora::rtc::INGAudioDeviceManager::setMicrophoneVolume
virtual int setMicrophoneVolume(unsigned int volume)=0
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::IAudioDeviceManagerObserver::~IAudioDeviceManagerObserver
virtual ~IAudioDeviceManagerObserver()
Definition: NGIAgoraAudioDeviceManager.h:71
agora::rtc::AudioParameters
Definition: AgoraMediaBase.h:100
agora::rtc::INGAudioDeviceManager::getRecordAudioParameters
virtual int getRecordAudioParameters(AudioParameters *params) const =0
agora::rtc::AudioRoute
AudioRoute
Definition: AgoraMediaBase.h:42
agora::rtc::INGAudioDeviceManager::createRecordingDeviceSource
virtual agora_refptr< IRecordingDeviceSource > createRecordingDeviceSource(char deviceId[kAdmMaxDeviceNameSize])=0
agora::rtc::INGAudioDeviceManager::~INGAudioDeviceManager
~INGAudioDeviceManager()
Definition: NGIAgoraAudioDeviceManager.h:461
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:24
agora::rtc::IAudioDeviceManagerObserver::onAudioDeviceVolumeChanged
virtual void onAudioDeviceVolumeChanged(int deviceType, int volume, bool muted)=0
agora::rtc::INGAudioDeviceManager::changeAudioRouting
virtual int changeAudioRouting(AudioRoute route)=0
agora::rtc::IRecordingDeviceSource::unregisterAudioFrameObserver
virtual int unregisterAudioFrameObserver(media::base::IAudioFrameObserver *observer)=0
agora::rtc::INGAudioDeviceManager::setSpeakerVolume
virtual int setSpeakerVolume(unsigned int volume)=0
agora::rtc::IRecordingDeviceSource
Definition: NGIAgoraAudioDeviceManager.h:117
agora::rtc::kIntervalInMillseconds
static const int kIntervalInMillseconds
Definition: NGIAgoraAudioDeviceManager.h:25
agora::rtc::IAudioDeviceManagerObserver::onVolumeIndication
virtual void onVolumeIndication(int volume)=0
agora::rtc::kAdmMaxDeviceNameSize
static const int kAdmMaxDeviceNameSize
Definition: NGIAgoraAudioDeviceManager.h:23
agora::rtc::IAudioDeviceManagerObserver::onAudioDeviceStateChanged
virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)=0
agora::rtc::IRecordingDeviceSource::registerAudioFrameObserver
virtual int registerAudioFrameObserver(media::base::IAudioFrameObserver *observer)=0
agora::rtc::INGAudioDeviceManager::getCurrentRouting
virtual int getCurrentRouting(AudioRoute &route)=0
agora::rtc::IAudioDeviceManagerObserver::onDeviceStateChanged
virtual void onDeviceStateChanged()=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:172
agora::rtc::IAudioDeviceManagerObserver
Definition: NGIAgoraAudioDeviceManager.h:69
agora::media::base::IAudioFrameObserver
Definition: AgoraMediaBase.h:344
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::IRecordingDeviceSource::~IRecordingDeviceSource
virtual ~IRecordingDeviceSource()
Definition: NGIAgoraAudioDeviceManager.h:163