Agora C++ API Reference for All Platforms
IAgoraService.h
1 // Agora SDK
2 //
3 // Copyright (c) 2018 Agora.io. All rights reserved.
4 //
5 
6 #pragma once // NOLINT(build/header_guard)
7 
8 #include "IAgoraLog.h"
9 #include "AgoraBase.h"
10 #include "AgoraOptional.h"
11 
12 namespace agora {
13 namespace rtc {
14 class IRtcConnection;
15 class IRtmpConnection;
16 class ILocalUser;
17 class IMediaDeviceManager;
18 class INGAudioDeviceManager;
19 struct TConnectionInfo;
20 struct RtcConnectionConfiguration;
21 struct RtmpConnectionConfiguration;
22 class ILocalAudioTrack;
23 class IMediaPlayerSource;
24 class IMediaStreamingSource;
25 class ICameraCapturer;
26 class IScreenCapturer;
27 class IScreenCapturer2;
28 class IAudioPcmDataSender;
29 class IAudioEncodedFrameSender;
30 class IVideoFrameSender;
31 class IVideoEncodedImageSender;
32 class IVideoSourceNode;
33 class IVideoMixerSource;
34 class IVideoFrameTransceiver;
35 class ILocalVideoTrack;
36 class IMediaNodeFactory;
37 class IRecordingDeviceSource;
38 class IRemoteAudioMixerSource;
39 class IRtmpStreamingService;
40 class IMediaPacketSender;
41 class IMediaRelayService;
42 class IAudioDeviceManager;
43 class IAudioDeviceManagerObserver;
44 
45 class IMediaExtensionObserver;
46 class IExtensionProvider;
47 class IFileUploaderService;
56 
58 };
59 
60 } // namespace rtc
61 
62 namespace rtm {
63 class IRtmService;
64 }
65 
66 namespace base {
67 class IServiceObserver;
68 
103  void* context;
107  const char* appId;
108 
112  unsigned int areaCode;
113 
117 
121  const char* license;
122 
139 
151 
158 
160  enableAudioDevice(true),
161  enableVideo(false),
162  context(NULL),
163  appId(NULL),
164  areaCode(rtc::AREA_CODE_GLOB),
166  license(NULL),
167  audioScenario(rtc::AUDIO_SCENARIO_DEFAULT),
168  useStringUid(false),
169  serviceObserver(NULL),
170  useExternalEglContext(false),
171  domainLimit(false){}
172 };
282 
283  void SetAll(const AudioSessionConfiguration& change) {
284  SetFrom(&playbackAndRecord, change.playbackAndRecord);
285  SetFrom(&chatMode, change.chatMode);
286  SetFrom(&defaultToSpeaker, change.defaultToSpeaker);
287  SetFrom(&overrideSpeaker, change.overrideSpeaker);
288  SetFrom(&allowMixWithOthers, change.allowMixWithOthers);
289  SetFrom(&allowDuckOthers, change.allowDuckOthers);
290  SetFrom(&allowBluetooth, change.allowBluetooth);
291  SetFrom(&allowBluetoothA2DP, change.allowBluetoothA2DP);
292  SetFrom(&sampleRate, change.sampleRate);
293  SetFrom(&ioBufferDuration, change.ioBufferDuration);
296  }
297 
298  bool operator==(const AudioSessionConfiguration& o) const {
306  }
307  bool operator!=(const AudioSessionConfiguration& o) const { return !(*this == o); }
308 
309  private:
310  template <typename T>
311  static void SetFrom(Optional<T>* s, const Optional<T>& o) {
312  if (o) {
313  *s = o;
314  }
315  }
316 };
320 enum TMixMode {
329 };
330 
335 public:
336  virtual ~IServiceObserver() {}
337 
342  virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType) {}
347  virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char* description) {}
348 };
349 
361  public:
373  virtual int initialize(const AgoraServiceConfiguration& config) = 0;
374 
378  virtual void atExit() = 0;
379 
387  virtual int release() = 0;
388 
399 
409 
419 
439  virtual int setLogFile(const char* filePath, unsigned int fileSize) = 0;
458  virtual int setLogFilter(unsigned int filters) = 0;
459 
469  const rtc::RtcConnectionConfiguration& cfg) = 0;
470 
472  const rtc::RtmpConnectionConfiguration& cfg) = 0;
473 
486 
500 
515 
529  agora_refptr<rtc::IAudioPcmDataSender> audioSource, bool enableAec) = 0;
530 
546  agora_refptr<rtc::IAudioPcmDataSender> audioReverseSource, int audioSourceDelay) = 0;
547 
561 
575  agora_refptr<rtc::IAudioEncodedFrameSender> audioSource, TMixMode mixMode) = 0;
577 
591 
603  agora_refptr<rtc::IMediaPlayerSource> audioSource) = 0;
604 
617  agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
618 
631  agora_refptr<rtc::IRecordingDeviceSource> audioSource, bool enableAec) = 0;
632 
641 
650 
663  agora_refptr<rtc::ICameraCapturer> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
664 
676  agora_refptr<rtc::IScreenCapturer> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
677 
690  const char* id = OPTIONAL_NULLPTR) = 0;
691 
704  const char* id = OPTIONAL_NULLPTR) = 0;
705 
707 
718  agora_refptr<rtc::IVideoFrameSender> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
720 
735  const rtc::SenderOptions& options,
736  const char* id = OPTIONAL_NULLPTR) = 0;
737 
738 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
739 
752 
766 #else
767 
779  agora_refptr<rtc::IScreenCapturer> screen, const char* id = OPTIONAL_NULLPTR) = 0;
780 #endif
781 
783 
794  agora_refptr<rtc::IMediaPacketSender> source, const char* id = OPTIONAL_NULLPTR) = 0;
796 
807  agora_refptr<rtc::IMediaPlayerSource> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
808 
820  agora_refptr<rtc::IMediaStreamingSource> streamingSource, const char* id = OPTIONAL_NULLPTR) = 0;
821 
822 
833  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
834 
846  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
847 
859  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
860 
869 
871 
873 
882  rtc::IAudioDeviceManagerObserver *observer) = 0;
891  virtual const char* getExtensionId(const char* provider_name, const char* extension_name) = 0;
892 
893 #if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
894 
901  virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0;
902 #endif
903 
916  virtual int enableExtension(
917  const char* provider_name, const char* extension_name, const char* track_id = NULL,
918  bool auto_enable_on_track = false) = 0;
930  virtual int disableExtension(
931  const char* provider_name, const char* extension_name, const char* track_id = NULL) = 0;
932 
933  protected:
934  virtual ~IAgoraService() {}
935 };
936 
937 } // namespace base
938 } // namespace agora
939 
agora::base::AgoraServiceConfiguration::enableAudioDevice
bool enableAudioDevice
Definition: IAgoraService.h:91
agora::base::AudioSessionConfiguration::allowBluetoothA2DP
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:259
agora::base::AgoraServiceConfiguration::appId
const char * appId
Definition: IAgoraService.h:107
agora::base::AudioSessionConfiguration::chatMode
Optional< bool > chatMode
Definition: IAgoraService.h:200
agora::base::IAgoraService
Definition: IAgoraService.h:360
agora::rtc::SenderOptions
Definition: AgoraBase.h:1178
agora::base::IAgoraService::disableExtension
virtual int disableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL)=0
agora::base::IAgoraService::~IAgoraService
virtual ~IAgoraService()
Definition: IAgoraService.h:934
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::base::AudioSessionConfiguration::inputNumberOfChannels
Optional< int > inputNumberOfChannels
Definition: IAgoraService.h:277
agora::base::IAgoraService::createRtmService
virtual rtm::IRtmService * createRtmService()=0
agora::base::IAgoraService::createFileUploadService
virtual agora_refptr< rtc::IFileUploaderService > createFileUploadService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::base::AgoraServiceConfiguration
Definition: IAgoraService.h:74
agora::rtc::AUDIO_PROFILE_TYPE
AUDIO_PROFILE_TYPE
Definition: AgoraBase.h:2486
agora::base::IAgoraService::createScreenCaptureVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
agora::base::AgoraServiceConfiguration::enableAudioProcessor
bool enableAudioProcessor
Definition: IAgoraService.h:80
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:636
agora::ERROR_CODE_TYPE
ERROR_CODE_TYPE
Definition: AgoraBase.h:449
agora::rtc::AUDIO_SCENARIO_TYPE
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2532
agora::base::IServiceObserver::~IServiceObserver
virtual ~IServiceObserver()
Definition: IAgoraService.h:336
agora::base::AudioSessionConfiguration::allowMixWithOthers
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:227
agora::base::IServiceObserver
Definition: IAgoraService.h:334
agora::base::IAgoraService::createMediaPlayerVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaPlayerVideoTrack(agora_refptr< rtc::IMediaPlayerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::IAgoraService::setAudioSessionConfiguration
virtual int setAudioSessionConfiguration(const AudioSessionConfiguration &config)=0
agora::base::AgoraServiceConfiguration::serviceObserver
IServiceObserver * serviceObserver
Definition: IAgoraService.h:138
agora::base::AudioSessionConfiguration::outputNumberOfChannels
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:281
agora::base::IAgoraService::createRtmpStreamingService
virtual agora_refptr< rtc::IRtmpStreamingService > createRtmpStreamingService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::base::IAgoraService::createCustomVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IMediaPacketSender > source, const char *id=OPTIONAL_NULLPTR)=0
agora::base::AgoraServiceConfiguration::context
void * context
Definition: IAgoraService.h:103
agora::rtc::AudioEncoderConfiguration::AudioEncoderConfiguration
AudioEncoderConfiguration()
Definition: IAgoraService.h:57
agora::rtc::RtmpConnectionConfiguration
Definition: NGIAgoraRtmpConnection.h:222
agora::base::IAgoraService::createLocalAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalAudioTrack()=0
createAgoraService
AGORA_API agora::base::IAgoraService *AGORA_CALL createAgoraService()
agora::base::IAgoraService::createMixedVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMixedVideoTrack(agora_refptr< rtc::IVideoMixerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::AudioSessionConfiguration::allowBluetooth
Optional< bool > allowBluetooth
Definition: IAgoraService.h:247
agora
Definition: AgoraAtomicOps.h:21
agora::base::IAgoraService::createMediaPlayerAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaPlayerAudioTrack(agora_refptr< rtc::IMediaPlayerSource > audioSource)=0
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioEncodedFrameSender > audioSource, TMixMode mixMode)=0
agora::base::AudioSessionConfiguration::playbackAndRecord
Optional< bool > playbackAndRecord
Definition: IAgoraService.h:191
agora::base::TMixMode
TMixMode
Definition: IAgoraService.h:320
agora::base::AudioSessionConfiguration::operator!=
bool operator!=(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:307
agora::base::IAgoraService::setLogFile
virtual int setLogFile(const char *filePath, unsigned int fileSize)=0
agora::base::MIX_ENABLED
@ MIX_ENABLED
Definition: IAgoraService.h:324
agora::base::IAgoraService::release
virtual int release()=0
agora::base::AgoraServiceConfiguration::domainLimit
bool domainLimit
Definition: IAgoraService.h:157
agora::base::AgoraServiceConfiguration::enableVideo
bool enableVideo
Definition: IAgoraService.h:97
agora::CHANNEL_PROFILE_TYPE
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:264
agora::base::IAgoraService::createScreenCaptureVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer > screen, const char *id=OPTIONAL_NULLPTR)=0
agora::base::IAgoraService::createScreenCaptureAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createScreenCaptureAudioTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
agora::base::IAgoraService::createRecordingDeviceAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec)=0
agora::base::IAgoraService::createCustomVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoEncodedImageSender > videoSource, const rtc::SenderOptions &options, const char *id=OPTIONAL_NULLPTR)=0
agora::base::AudioSessionConfiguration
Definition: IAgoraService.h:178
agora::base::IAgoraService::initialize
virtual int initialize(const AgoraServiceConfiguration &config)=0
agora::base::IAgoraService::createCameraVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCameraVideoTrack(agora_refptr< rtc::ICameraCapturer > videoSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::IAgoraService::setLogFilter
virtual int setLogFilter(unsigned int filters)=0
agora::base::IAgoraService::getAudioSessionConfiguration
virtual int getAudioSessionConfiguration(AudioSessionConfiguration *config)=0
agora::base::AudioSessionConfiguration::operator==
bool operator==(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:298
agora::base::AgoraServiceConfiguration::AgoraServiceConfiguration
AgoraServiceConfiguration()
Definition: IAgoraService.h:159
agora::base::IAgoraService::createRtmpConnection
virtual agora_refptr< rtc::IRtmpConnection > createRtmpConnection(const rtc::RtmpConnectionConfiguration &cfg)=0
agora::base::IAgoraService::removeExtensionObserver
virtual int removeExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
agora::base::IAgoraService::createMediaNodeFactory
virtual agora_refptr< rtc::IMediaNodeFactory > createMediaNodeFactory()=0
agora::base::IAgoraService::createAudioDeviceManagerComponent
virtual agora_refptr< rtc::IAudioDeviceManager > createAudioDeviceManagerComponent(rtc::IAudioDeviceManagerObserver *observer)=0
agora::base::IServiceObserver::onPermissionError
virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType)
Definition: IAgoraService.h:342
agora::rtc::AUDIO_PROFILE_DEFAULT
@ AUDIO_PROFILE_DEFAULT
Definition: AgoraBase.h:2495
agora::commons::LogConfig
Definition: IAgoraLog.h:82
agora::rtc::AudioEncoderConfiguration::audioProfile
AUDIO_PROFILE_TYPE audioProfile
Definition: IAgoraService.h:55
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IMediaPacketSender > source)=0
agora::base::IAgoraService::createMediaStreamingAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaStreamingAudioTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0
agora::base::MIX_DISABLED
@ MIX_DISABLED
Definition: IAgoraService.h:328
agora::base::AudioSessionConfiguration::sampleRate
Optional< double > sampleRate
Definition: IAgoraService.h:266
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource, bool enableAec)=0
agora::base::IAgoraService::createCustomVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoFrameSender > videoSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::IAgoraService::createDirectCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createDirectCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
agora::base::AgoraServiceConfiguration::threadPriority
Optional< rtc::THREAD_PRIORITY_TYPE > threadPriority
Definition: IAgoraService.h:143
agora::rtc::IAudioDeviceManagerObserver
Definition: NGIAgoraAudioDeviceManager.h:85
agora::rtc::RtcConnectionConfiguration
Definition: NGIAgoraRtcConnection.h:88
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IRemoteAudioMixerSource > audioSource)=0
agora::rtc::PERMISSION_TYPE
PERMISSION_TYPE
Definition: AgoraBase.h:5467
agora::base::IAgoraService::createRtcConnection
virtual agora_refptr< rtc::IRtcConnection > createRtcConnection(const rtc::RtcConnectionConfiguration &cfg)=0
agora::base::IAgoraService::enableExtension
virtual int enableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL, bool auto_enable_on_track=false)=0
agora::base::AgoraServiceConfiguration::logConfig
commons::LogConfig logConfig
Definition: IAgoraService.h:130
agora::base::AgoraServiceConfiguration::license
const char * license
Definition: IAgoraService.h:121
agora::base::AgoraServiceConfiguration::useStringUid
bool useStringUid
Definition: IAgoraService.h:134
agora::base::AudioSessionConfiguration::ioBufferDuration
Optional< double > ioBufferDuration
Definition: IAgoraService.h:273
agora::base::IAgoraService::createMediaRelayService
virtual agora_refptr< rtc::IMediaRelayService > createMediaRelayService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::base::IAgoraService::setAudioSessionPreset
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario)=0
agora::base::AudioSessionConfiguration::allowDuckOthers
Optional< bool > allowDuckOthers
Definition: IAgoraService.h:236
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource, agora_refptr< rtc::IAudioPcmDataSender > audioReverseSource, int audioSourceDelay)=0
agora::base::IAgoraService::createMediaStreamingVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaStreamingVideoTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::AudioSessionConfiguration::defaultToSpeaker
Optional< bool > defaultToSpeaker
Definition: IAgoraService.h:209
agora::base::AgoraServiceConfiguration::audioScenario
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:126
agora::base::AgoraServiceConfiguration::useExternalEglContext
bool useExternalEglContext
Definition: IAgoraService.h:150
agora::rtc::AudioEncoderConfiguration
Definition: IAgoraService.h:51
agora::base::AudioSessionConfiguration::SetAll
void SetAll(const AudioSessionConfiguration &change)
Definition: IAgoraService.h:283
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
agora::base::IAgoraService::addExtensionObserver
virtual int addExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
agora::base::IAgoraService::createScreenVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenVideoTrack(agora_refptr< rtc::IScreenCapturer > videoSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::IAgoraService::atExit
virtual void atExit()=0
agora::base::IAgoraService::createTranscodedVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createTranscodedVideoTrack(agora_refptr< rtc::IVideoFrameTransceiver > transceiver, const char *id=OPTIONAL_NULLPTR)=0
agora::base::IAgoraService::loadExtensionProvider
virtual int loadExtensionProvider(const char *path, bool unload_after_use=false)=0
load the dynamic library of the extension
agora::base::IServiceObserver::onAudioDeviceError
virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char *description)
Definition: IAgoraService.h:347
agora::base::AudioSessionConfiguration::overrideSpeaker
Optional< bool > overrideSpeaker
Definition: IAgoraService.h:218
agora::base::IAgoraService::getExtensionId
virtual const char * getExtensionId(const char *provider_name, const char *extension_name)=0
Get the ID of the registered extension.
agora::base::AgoraServiceConfiguration::areaCode
unsigned int areaCode
Definition: IAgoraService.h:112
agora::base::IAgoraService::createAudioDeviceManager
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
rtc
Definition: video_node_i.h:25
agora::Optional< rtc::THREAD_PRIORITY_TYPE >
agora::base::AgoraServiceConfiguration::channelProfile
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraService.h:116
agora::CHANNEL_PROFILE_LIVE_BROADCASTING
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:276