Agora RTC Objective-C API Reference  Refactor
IAgoraService.h
Go to the documentation of this file.
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 class ILocalDataChannel;
14 class IRemoteDataChannel;
15 struct DataChannelConfig;
16 
17 namespace rtc {
18 class IRtcConnection;
19 class IRtmpConnection;
20 class ILocalUser;
21 class IMediaDeviceManager;
22 class INGAudioDeviceManager;
23 struct TConnectionInfo;
24 struct RtcConnectionConfiguration;
25 struct RtmpConnectionConfiguration;
26 class ILocalAudioTrack;
27 class IMediaPlayerSource;
28 class IMediaStreamingSource;
29 class ICameraCapturer;
30 class IScreenCapturer;
31 class IScreenCapturer2;
32 class IAudioPcmDataSender;
33 class IAudioEncodedFrameSender;
34 class IVideoFrameSender;
35 class IVideoEncodedImageSender;
36 class IVideoSourceNode;
37 class IVideoMixerSource;
38 class IVideoFrameTransceiver;
39 class ILocalVideoTrack;
40 class IMediaNodeFactory;
41 class IRecordingDeviceSource;
42 class IRemoteAudioMixerSource;
43 class IRtmpStreamingService;
44 class IMediaPacketSender;
45 class IMediaRelayService;
46 class IAudioDeviceManager;
47 class IAudioDeviceManagerObserver;
48 
49 class IMediaExtensionObserver;
50 class IExtensionProvider;
51 class IFileUploaderService;
52 class IConfigCenter;
61 
63 };
64 
65 } // namespace rtc
66 
67 namespace rtm {
68 class IRtmService;
69 }
70 
71 namespace base {
72 class IServiceObserver;
73 
108  void* context;
112  const char* appId;
113 
117  unsigned int areaCode;
118 
122 
126  const char* license;
127 
144 
156 
163 
165  enableAudioDevice(true),
166  enableVideo(false),
167  context(NULL),
168  appId(NULL),
169  areaCode(rtc::AREA_CODE_GLOB),
171  license(NULL),
173  useStringUid(false),
174  serviceObserver(NULL),
175  useExternalEglContext(false),
176  domainLimit(false){}
177 };
287 
288  void SetAll(const AudioSessionConfiguration& change) {
290  SetFrom(&chatMode, change.chatMode);
297  SetFrom(&sampleRate, change.sampleRate);
301  }
302 
303  bool operator==(const AudioSessionConfiguration& o) const {
311  }
312  bool operator!=(const AudioSessionConfiguration& o) const { return !(*this == o); }
313 
314  private:
315  template <typename T>
316  static void SetFrom(Optional<T>* s, const Optional<T>& o) {
317  if (o) {
318  *s = o;
319  }
320  }
321 };
325 enum TMixMode {
334 };
335 
340 public:
341  virtual ~IServiceObserver() {}
342 
347  virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType) {}
352  virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char* description) {}
364  virtual void onFetchConfigResult(int code, rtc::CONFIG_FETCH_TYPE configType, const char* configContent) {}
365 };
366 
378  public:
390  virtual int initialize(const AgoraServiceConfiguration& config) = 0;
391 
395  virtual void atExit() = 0;
396 
404  virtual int release() = 0;
405 
416 
426 
436 
456  virtual int setLogFile(const char* filePath, unsigned int fileSize) = 0;
475  virtual int setLogFilter(unsigned int filters) = 0;
476 
486  const rtc::RtcConnectionConfiguration& cfg) = 0;
487 
489  const rtc::RtmpConnectionConfiguration& cfg) = 0;
490 
503 
514 
528 
543 
557  agora_refptr<rtc::IAudioPcmDataSender> audioSource, bool enableAec) = 0;
558 
572 
586  agora_refptr<rtc::IAudioEncodedFrameSender> audioSource, TMixMode mixMode) = 0;
588 
602 
614  agora_refptr<rtc::IMediaPlayerSource> audioSource) = 0;
615 
628  agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
629 
642  agora_refptr<rtc::IRecordingDeviceSource> audioSource, bool enableAec) = 0;
643 
652 
661 
674  agora_refptr<rtc::ICameraCapturer> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
675 
687  agora_refptr<rtc::IScreenCapturer> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
688 
701  const char* id = OPTIONAL_NULLPTR) = 0;
702 
715  const char* id = OPTIONAL_NULLPTR) = 0;
716 
718 
729  agora_refptr<rtc::IVideoFrameSender> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
731 
746  const rtc::SenderOptions& options,
747  const char* id = OPTIONAL_NULLPTR) = 0;
748 
749 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
750 
763 
777 #else
778 
790  agora_refptr<rtc::IScreenCapturer> screen, const char* id = OPTIONAL_NULLPTR) = 0;
791 #endif
792 
794 
805  agora_refptr<rtc::IMediaPacketSender> source, const char* id = OPTIONAL_NULLPTR) = 0;
807 
818  agora_refptr<rtc::IMediaPlayerSource> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
819 
831  agora_refptr<rtc::IMediaStreamingSource> streamingSource, const char* id = OPTIONAL_NULLPTR) = 0;
832 
833 
844  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
845 
857  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
858 
870  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
871 
880 
882 
884 
893  rtc::IAudioDeviceManagerObserver *observer) = 0;
894 
903 
912  virtual const char* getExtensionId(const char* provider_name, const char* extension_name) = 0;
913 
914 #if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
915 
922  virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0;
923 #endif
924 
937  virtual int enableExtension(
938  const char* provider_name, const char* extension_name, const char* track_id = NULL,
939  bool auto_enable_on_track = false) = 0;
951  virtual int disableExtension(
952  const char* provider_name, const char* extension_name, const char* track_id = NULL) = 0;
953 
962 
963  protected:
964  virtual ~IAgoraService() {}
965 };
966 
967 } // namespace base
968 } // namespace agora
969 
agora::base::AgoraServiceConfiguration::useExternalEglContext
bool useExternalEglContext
Definition: IAgoraService.h:155
agora::base::IAgoraService::createRtmService
virtual rtm::IRtmService * createRtmService()=0
agora::CHANNEL_PROFILE_LIVE_BROADCASTING
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:268
agora::base::IAgoraService
Definition: IAgoraService.h:377
agora::ERROR_CODE_TYPE
ERROR_CODE_TYPE
Definition: AgoraBase.h:441
agora::rtc::SenderOptions
Definition: AgoraBase.h:1205
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioEncodedFrameSender > audioSource, TMixMode mixMode)=0
agora::base::IAgoraService::createMixedVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMixedVideoTrack(agora_refptr< rtc::IVideoMixerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::AudioSessionConfiguration::outputNumberOfChannels
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:286
agora::base::AudioSessionConfiguration::ioBufferDuration
Optional< double > ioBufferDuration
Definition: IAgoraService.h:278
agora::base::AudioSessionConfiguration::allowDuckOthers
Optional< bool > allowDuckOthers
Definition: IAgoraService.h:241
agora::base::IAgoraService::createFileUploadService
virtual agora_refptr< rtc::IFileUploaderService > createFileUploadService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::base::IAgoraService::createDirectCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createDirectCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
AgoraBase.h
agora::base::IAgoraService::createTranscodedVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createTranscodedVideoTrack(agora_refptr< rtc::IVideoFrameTransceiver > transceiver, const char *id=OPTIONAL_NULLPTR)=0
agora::base::IAgoraService::createRtmpStreamingService
virtual agora_refptr< rtc::IRtmpStreamingService > createRtmpStreamingService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::base::IAgoraService::createScreenCaptureVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
agora::base::AgoraServiceConfiguration
Definition: IAgoraService.h:79
agora::base::IAgoraService::~IAgoraService
virtual ~IAgoraService()
Definition: IAgoraService.h:964
agora::base::AgoraServiceConfiguration::domainLimit
bool domainLimit
Definition: IAgoraService.h:162
agora::base::IAgoraService::initialize
virtual int initialize(const AgoraServiceConfiguration &config)=0
agora::base::MIX_DISABLED
@ MIX_DISABLED
Definition: IAgoraService.h:333
agora::base::IAgoraService::setAudioSessionConfiguration
virtual int setAudioSessionConfiguration(const AudioSessionConfiguration &config)=0
agora::rtc::CONFIG_FETCH_TYPE
CONFIG_FETCH_TYPE
Definition: AgoraBase.h:5946
agora::base::AudioSessionConfiguration::allowBluetoothA2DP
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:264
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:636
agora::base::AudioSessionConfiguration::playbackAndRecord
Optional< bool > playbackAndRecord
Definition: IAgoraService.h:196
agora::base::AudioSessionConfiguration::sampleRate
Optional< double > sampleRate
Definition: IAgoraService.h:271
agora::base::AgoraServiceConfiguration::appId
const char * appId
Definition: IAgoraService.h:112
agora::base::AgoraServiceConfiguration::channelProfile
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraService.h:121
agora::base::AudioSessionConfiguration::chatMode
Optional< bool > chatMode
Definition: IAgoraService.h:205
agora::base::IAgoraService::createAudioDeviceManagerComponent
virtual agora_refptr< rtc::IAudioDeviceManager > createAudioDeviceManagerComponent(rtc::IAudioDeviceManagerObserver *observer)=0
agora::base::IServiceObserver
Definition: IAgoraService.h:339
agora::base::IServiceObserver::onFetchConfigResult
virtual void onFetchConfigResult(int code, rtc::CONFIG_FETCH_TYPE configType, const char *configContent)
Definition: IAgoraService.h:364
agora::base::AudioSessionConfiguration::operator!=
bool operator!=(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:312
agora::rtc::AUDIO_SCENARIO_DEFAULT
@ AUDIO_SCENARIO_DEFAULT
Definition: AgoraBase.h:2454
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::rtc::RtmpConnectionConfiguration
Definition: NGIAgoraRtmpConnection.h:230
agora::base::AudioSessionConfiguration::allowBluetooth
Optional< bool > allowBluetooth
Definition: IAgoraService.h:252
createAgoraService
AGORA_API agora::base::IAgoraService *AGORA_CALL createAgoraService()
agora::base::AgoraServiceConfiguration::enableAudioProcessor
bool enableAudioProcessor
Definition: IAgoraService.h:85
agora::base::IAgoraService::getConfigCenter
virtual agora_refptr< rtc::IConfigCenter > getConfigCenter()=0
agora::base::AudioSessionConfiguration::defaultToSpeaker
Optional< bool > defaultToSpeaker
Definition: IAgoraService.h:214
agora::rtc::AudioEncoderConfiguration::AudioEncoderConfiguration
AudioEncoderConfiguration()
Definition: IAgoraService.h:62
agora
Definition: AgoraAtomicOps.h:21
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IMediaPacketSender > source)=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::createMediaStreamingVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaStreamingVideoTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::AgoraServiceConfiguration::logConfig
commons::LogConfig logConfig
Definition: IAgoraService.h:135
agora::rtc::PERMISSION_TYPE
PERMISSION_TYPE
Definition: AgoraBase.h:5603
agora::base::IAgoraService::createCustomVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IMediaPacketSender > source, const char *id=OPTIONAL_NULLPTR)=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::IAgoraService::createRtmpConnection
virtual agora_refptr< rtc::IRtmpConnection > createRtmpConnection(const rtc::RtmpConnectionConfiguration &cfg)=0
agora::base::AgoraServiceConfiguration::areaCode
unsigned int areaCode
Definition: IAgoraService.h:117
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::AgoraServiceConfiguration::serviceObserver
IServiceObserver * serviceObserver
Definition: IAgoraService.h:143
agora::base::AudioSessionConfiguration
Definition: IAgoraService.h:183
agora::CHANNEL_PROFILE_TYPE
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:256
agora::rtc::AudioEncoderConfiguration::audioProfile
AUDIO_PROFILE_TYPE audioProfile
Definition: IAgoraService.h:60
agora::base::IAgoraService::createScreenCaptureAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createScreenCaptureAudioTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
agora::base::IAgoraService::setAudioSessionPreset
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario)=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::getAudioSessionConfiguration
virtual int getAudioSessionConfiguration(AudioSessionConfiguration *config)=0
AGORA_API
#define AGORA_API
Definition: AgoraBase.h:60
agora::base::IAgoraService::createMediaPlayerVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaPlayerVideoTrack(agora_refptr< rtc::IMediaPlayerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::IAgoraService::createMediaRelayService
virtual agora_refptr< rtc::IMediaRelayService > createMediaRelayService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::base::IServiceObserver::onPermissionError
virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType)
Definition: IAgoraService.h:347
agora::base::AgoraServiceConfiguration::enableAudioDevice
bool enableAudioDevice
Definition: IAgoraService.h:96
agora::base::IAgoraService::setLogFilter
virtual int setLogFilter(unsigned int filters)=0
agora::base::IAgoraService::createMediaPlayerAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaPlayerAudioTrack(agora_refptr< rtc::IMediaPlayerSource > audioSource)=0
agora::base::AudioSessionConfiguration::inputNumberOfChannels
Optional< int > inputNumberOfChannels
Definition: IAgoraService.h:282
agora::base::IAgoraService::createCameraVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCameraVideoTrack(agora_refptr< rtc::ICameraCapturer > videoSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::IAgoraService::addExtensionObserver
virtual int addExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
agora::commons::LogConfig
Definition: IAgoraLog.h:82
IAgoraLog.h
agora::base::IAgoraService::createRecordingDeviceAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec)=0
agora::base::IAgoraService::atExit
virtual void atExit()=0
agora::rtc::AUDIO_SCENARIO_TYPE
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2449
agora::base::AgoraServiceConfiguration::license
const char * license
Definition: IAgoraService.h:126
agora::base::IAgoraService::createRtcConnection
virtual agora_refptr< rtc::IRtcConnection > createRtcConnection(const rtc::RtcConnectionConfiguration &cfg)=0
agora::base::AgoraServiceConfiguration::threadPriority
Optional< rtc::THREAD_PRIORITY_TYPE > threadPriority
Definition: IAgoraService.h:148
AgoraOptional.h
agora::base::AgoraServiceConfiguration::enableVideo
bool enableVideo
Definition: IAgoraService.h:102
agora::rtc::IAudioDeviceManagerObserver
Definition: NGIAgoraAudioDeviceManager.h:45
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource, bool enableAec)=0
agora::base::IServiceObserver::~IServiceObserver
virtual ~IServiceObserver()
Definition: IAgoraService.h:341
agora::base::AgoraServiceConfiguration::AgoraServiceConfiguration
AgoraServiceConfiguration()
Definition: IAgoraService.h:164
agora::rtc::RtcConnectionConfiguration
Definition: NGIAgoraRtcConnection.h:88
agora::base::IServiceObserver::onAudioDeviceError
virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char *description)
Definition: IAgoraService.h:352
agora::base::MIX_ENABLED
@ MIX_ENABLED
Definition: IAgoraService.h:329
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
agora::base::AgoraServiceConfiguration::useStringUid
bool useStringUid
Definition: IAgoraService.h:139
agora::rtc::AudioEncoderConfiguration
Definition: IAgoraService.h:56
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IRemoteAudioMixerSource > audioSource)=0
OPTIONAL_NULLPTR
#define OPTIONAL_NULLPTR
Definition: AgoraBase.h:79
agora::base::IAgoraService::removeExtensionObserver
virtual int removeExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
agora::base::AudioSessionConfiguration::operator==
bool operator==(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:303
agora::base::IAgoraService::createLocalMixedAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalMixedAudioTrack()=0
agora::rtc::AUDIO_PROFILE_TYPE
AUDIO_PROFILE_TYPE
Definition: AgoraBase.h:2403
agora::base::AudioSessionConfiguration::SetFrom
static void SetFrom(Optional< T > *s, const Optional< T > &o)
Definition: IAgoraService.h:316
agora::base::IAgoraService::createLocalDataChannel
virtual agora_refptr< ILocalDataChannel > createLocalDataChannel(const DataChannelConfig &config)=0
agora::base::AgoraServiceConfiguration::context
void * context
Definition: IAgoraService.h:108
agora::base::IAgoraService::setLogFile
virtual int setLogFile(const char *filePath, unsigned int fileSize)=0
agora::DataChannelConfig
Definition: NGIAgoraDataChannel.h:17
agora::base::IAgoraService::createLocalAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalAudioTrack()=0
agora::base::IAgoraService::disableExtension
virtual int disableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL)=0
agora::base::AudioSessionConfiguration::SetAll
void SetAll(const AudioSessionConfiguration &change)
Definition: IAgoraService.h:288
agora::rtc::AREA_CODE_GLOB
@ AREA_CODE_GLOB
Definition: AgoraBase.h:5139
AGORA_CALL
#define AGORA_CALL
Definition: AgoraBase.h:61
agora::base::AudioSessionConfiguration::overrideSpeaker
Optional< bool > overrideSpeaker
Definition: IAgoraService.h:223
agora::base::AgoraServiceConfiguration::audioScenario
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:131
agora::base::TMixMode
TMixMode
Definition: IAgoraService.h:325
agora::base::IAgoraService::createMediaStreamingAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaStreamingAudioTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0
agora::base::IAgoraService::createMediaNodeFactory
virtual agora_refptr< rtc::IMediaNodeFactory > createMediaNodeFactory()=0
agora::base::IAgoraService::release
virtual int release()=0
agora::base::IAgoraService::createAudioDeviceManager
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
agora::Optional< rtc::THREAD_PRIORITY_TYPE >
agora::base::AudioSessionConfiguration::allowMixWithOthers
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:232
agora::rtc::AUDIO_PROFILE_DEFAULT
@ AUDIO_PROFILE_DEFAULT
Definition: AgoraBase.h:2412