Agora Java API Reference for Android
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;
55  AUDIO_PROFILE_TYPE audioProfile;
56 
57  AudioEncoderConfiguration() : audioProfile(AUDIO_PROFILE_DEFAULT) {}
58 };
59 
60 } // namespace rtc
61 
62 namespace signaling {
63 class ISignalingEngine;
64 }
65 
66 namespace rtm {
67 class IRtmService;
68 }
69 
70 namespace base {
71 class IEngineBase;
72 class IServiceObserver;
73 
108  void* context;
112  const char* appId;
113 
117  unsigned int areaCode;
118 
121  agora::CHANNEL_PROFILE_TYPE channelProfile;
122 
126  const char* license;
127 
131  rtc::AUDIO_SCENARIO_TYPE audioScenario;
144 
156 
163 
165  enableAudioDevice(true),
166  enableVideo(false),
167  context(NULL),
168  appId(NULL),
169  areaCode(rtc::AREA_CODE_GLOB),
170  channelProfile(agora::CHANNEL_PROFILE_LIVE_BROADCASTING),
171  license(NULL),
172  audioScenario(rtc::AUDIO_SCENARIO_DEFAULT),
173  useStringUid(false),
174  serviceObserver(NULL),
175  useExternalEglContext(false),
176  domainLimit(false){}
177 };
287 
288  void SetAll(const AudioSessionConfiguration& change) {
289  SetFrom(&playbackAndRecord, change.playbackAndRecord);
290  SetFrom(&chatMode, change.chatMode);
291  SetFrom(&defaultToSpeaker, change.defaultToSpeaker);
292  SetFrom(&overrideSpeaker, change.overrideSpeaker);
293  SetFrom(&allowMixWithOthers, change.allowMixWithOthers);
294  SetFrom(&allowDuckOthers, change.allowDuckOthers);
295  SetFrom(&allowBluetooth, change.allowBluetooth);
296  SetFrom(&allowBluetoothA2DP, change.allowBluetoothA2DP);
297  SetFrom(&sampleRate, change.sampleRate);
298  SetFrom(&ioBufferDuration, change.ioBufferDuration);
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 {
329  MIX_ENABLED,
333  MIX_DISABLED,
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) {}
353 };
354 
366  public:
378  virtual int initialize(const AgoraServiceConfiguration& config) = 0;
379 
383  virtual void atExit() = 0;
384 
392  virtual int release() = 0;
393 
403  virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario) = 0;
404 
414 
424 
444  virtual int setLogFile(const char* filePath, unsigned int fileSize) = 0;
463  virtual int setLogFilter(unsigned int filters) = 0;
464 
474  const rtc::RtcConnectionConfiguration& cfg) = 0;
475 
476  virtual agora_refptr<rtc::IRtmpConnection> createRtmpConnection(
477  const rtc::RtmpConnectionConfiguration& cfg) = 0;
478 
491 
505 
520 
534  agora_refptr<rtc::IAudioPcmDataSender> audioSource, bool enableAec) = 0;
535 
551  agora_refptr<rtc::IAudioPcmDataSender> audioReverseSource, int audioSourceDelay) = 0;
552 
566 
580  agora_refptr<rtc::IAudioEncodedFrameSender> audioSource, TMixMode mixMode) = 0;
582 
596 
608  agora_refptr<rtc::IMediaPlayerSource> audioSource) = 0;
609 
622  agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
623 
636  agora_refptr<rtc::IRecordingDeviceSource> audioSource, bool enableAec) = 0;
637 
646 
655 
668  agora_refptr<rtc::ICameraCapturer> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
669 
681  agora_refptr<rtc::IScreenCapturer> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
682 
695  const char* id = OPTIONAL_NULLPTR) = 0;
696 
709  const char* id = OPTIONAL_NULLPTR) = 0;
710 
712 
723  agora_refptr<rtc::IVideoFrameSender> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
725 
740  const rtc::SenderOptions& options,
741  const char* id = OPTIONAL_NULLPTR) = 0;
742 
743 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
744 
757 
769  virtual agora_refptr<rtc::ILocalAudioTrack> createScreenCaptureAudioTrack(
771 #else
772 
784  agora_refptr<rtc::IScreenCapturer> screen, const char* id = OPTIONAL_NULLPTR) = 0;
785 #endif
786 
788 
799  agora_refptr<rtc::IMediaPacketSender> source, const char* id = OPTIONAL_NULLPTR) = 0;
801 
812  agora_refptr<rtc::IMediaPlayerSource> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
813 
825  agora_refptr<rtc::IMediaStreamingSource> streamingSource, const char* id = OPTIONAL_NULLPTR) = 0;
826 
827 
838  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
839 
851  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
852 
864  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
865 
874 
875  virtual int addExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer) = 0;
876 
877  virtual int removeExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer) = 0;
878 
887  rtc::IAudioDeviceManagerObserver *observer) = 0;
896  virtual const char* getExtensionId(const char* provider_name, const char* extension_name) = 0;
897 
898 #if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
899 
906  virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0;
907 #endif
908 
921  virtual int enableExtension(
922  const char* provider_name, const char* extension_name, const char* track_id = NULL,
923  bool auto_enable_on_track = false) = 0;
935  virtual int disableExtension(
936  const char* provider_name, const char* extension_name, const char* track_id = NULL) = 0;
937 
938  protected:
939  virtual ~IAgoraService() {}
940 };
941 
942 } // namespace base
943 } // namespace agora
944 
agora::base::AgoraServiceConfiguration::enableAudioDevice
bool enableAudioDevice
Definition: IAgoraService.h:96
agora::base::AudioSessionConfiguration::allowBluetoothA2DP
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:264
agora::base::AgoraServiceConfiguration::appId
const char * appId
Definition: IAgoraService.h:112
agora::base::AudioSessionConfiguration::chatMode
Optional< bool > chatMode
Definition: IAgoraService.h:205
agora::base::IAgoraService
Definition: IAgoraService.h:365
agora::rtc::SenderOptions
Definition: AgoraBase.h:1175
agora::base::IAgoraService::disableExtension
virtual int disableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL)=0
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::base::AudioSessionConfiguration::inputNumberOfChannels
Optional< int > inputNumberOfChannels
Definition: IAgoraService.h:282
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:79
agora::base::AgoraServiceConfiguration::enableAudioProcessor
bool enableAudioProcessor
Definition: IAgoraService.h:85
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:636
agora::base::AudioSessionConfiguration::allowMixWithOthers
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:232
agora::base::IServiceObserver
Definition: IAgoraService.h:339
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:143
agora::base::AudioSessionConfiguration::outputNumberOfChannels
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:286
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:108
agora::rtc::RtmpConnectionConfiguration
Definition: NGIAgoraRtmpConnection.h:230
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:252
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:196
agora::base::IAgoraService::setLogFile
virtual int setLogFile(const char *filePath, unsigned int fileSize)=0
agora::base::IAgoraService::release
virtual int release()=0
agora::base::AgoraServiceConfiguration::domainLimit
bool domainLimit
Definition: IAgoraService.h:162
agora::base::AgoraServiceConfiguration::enableVideo
bool enableVideo
Definition: IAgoraService.h:102
agora::base::IAgoraService::createScreenCaptureVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer > screen, const char *id=OPTIONAL_NULLPTR)=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:183
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::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:347
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::AudioSessionConfiguration::sampleRate
Optional< double > sampleRate
Definition: IAgoraService.h:271
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:148
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::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:135
agora::base::AgoraServiceConfiguration::license
const char * license
Definition: IAgoraService.h:126
agora::base::AgoraServiceConfiguration::useStringUid
bool useStringUid
Definition: IAgoraService.h:139
agora::base::AudioSessionConfiguration::ioBufferDuration
Optional< double > ioBufferDuration
Definition: IAgoraService.h:278
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:241
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:214
agora::base::AgoraServiceConfiguration::audioScenario
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:131
agora::base::AgoraServiceConfiguration::useExternalEglContext
bool useExternalEglContext
Definition: IAgoraService.h:155
agora::rtc::AudioEncoderConfiguration
Definition: IAgoraService.h:51
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=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::IServiceObserver::onAudioDeviceError
virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char *description)
Definition: IAgoraService.h:352
agora::base::AudioSessionConfiguration::overrideSpeaker
Optional< bool > overrideSpeaker
Definition: IAgoraService.h:223
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:117
agora::base::IAgoraService::createAudioDeviceManager
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
agora::Optional< rtc::THREAD_PRIORITY_TYPE >
agora::base::AgoraServiceConfiguration::channelProfile
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraService.h:121