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 #include <api/cpp/aosl_ares_class.h>
12 
13 namespace agora {
14 class ILocalDataChannel;
15 class IRemoteDataChannel;
16 struct DataChannelConfig;
17 
18 namespace rtc {
19 class IRtcConnection;
20 class IRtmpConnection;
21 class ILocalUser;
22 class IMediaDeviceManager;
23 class INGAudioDeviceManager;
24 struct TConnectionInfo;
25 struct RtcConnectionConfiguration;
26 struct RtmpConnectionConfiguration;
27 class ILocalAudioTrack;
28 class IMediaPlayerSource;
29 class IMediaStreamingSource;
30 class ICameraCapturer;
31 class IScreenCapturer;
32 class IScreenCapturer2;
33 class IAudioPcmDataSender;
34 class IAudioEncodedFrameSender;
35 class IVideoFrameSender;
36 class IVideoEncodedImageSender;
37 class IVideoSourceNode;
38 class IVideoMixerSource;
39 class IVideoFrameTransceiver;
40 class ILocalVideoTrack;
41 class IMediaNodeFactory;
42 class IRecordingDeviceSource;
43 class IRemoteAudioMixerSource;
44 class IRtmpStreamingService;
45 class IMediaPacketSender;
46 class IMediaRelayService;
47 class IAudioDeviceManager;
48 class IAudioDeviceManagerObserver;
49 
50 class IMediaExtensionObserver;
51 class IExtensionProvider;
52 class IFileUploaderService;
53 class IConfigCenter;
61  AUDIO_PROFILE_TYPE audioProfile;
62 
63  AudioEncoderConfiguration() : audioProfile(AUDIO_PROFILE_DEFAULT) {}
64 };
65 
66 } // namespace rtc
67 
68 namespace rtm {
69 class IRtmService;
70 }
71 
72 namespace base {
73 class IServiceObserver;
74 
109  void* context;
113  const char* appId;
114 
118  unsigned int areaCode;
119 
122  agora::CHANNEL_PROFILE_TYPE channelProfile;
123 
127  const char* license;
128 
132  rtc::AUDIO_SCENARIO_TYPE audioScenario;
145 
157 
164 
166  enableAudioDevice(true),
167  enableVideo(false),
168  context(NULL),
169  appId(NULL),
170  areaCode(rtc::AREA_CODE_GLOB),
171  channelProfile(agora::CHANNEL_PROFILE_LIVE_BROADCASTING),
172  license(NULL),
173  audioScenario(rtc::AUDIO_SCENARIO_DEFAULT),
174  useStringUid(false),
175  serviceObserver(NULL),
176  useExternalEglContext(false),
177  domainLimit(false){}
178 };
288 
289 #if defined(WEBRTC_IOS)
290 
293  Optional<int> category;
294 #endif
295 
296  void SetAll(const AudioSessionConfiguration& change) {
297  SetFrom(&playbackAndRecord, change.playbackAndRecord);
298  SetFrom(&chatMode, change.chatMode);
299  SetFrom(&defaultToSpeaker, change.defaultToSpeaker);
300  SetFrom(&overrideSpeaker, change.overrideSpeaker);
301  SetFrom(&allowMixWithOthers, change.allowMixWithOthers);
302  SetFrom(&allowDuckOthers, change.allowDuckOthers);
303  SetFrom(&allowBluetooth, change.allowBluetooth);
304  SetFrom(&allowBluetoothA2DP, change.allowBluetoothA2DP);
305  SetFrom(&sampleRate, change.sampleRate);
306  SetFrom(&ioBufferDuration, change.ioBufferDuration);
309 #if defined(WEBRTC_IOS)
310  SetFrom(&category, change.category);
311 #endif
312  }
313 
314  bool operator==(const AudioSessionConfiguration& o) const {
321 #if defined(WEBRTC_IOS)
323  category == o.category;
324 #else
326 #endif
327  }
328  bool operator!=(const AudioSessionConfiguration& o) const { return !(*this == o); }
329 
330  private:
331  template <typename T>
332  static void SetFrom(Optional<T>* s, const Optional<T>& o) {
333  if (o) {
334  *s = o;
335  }
336  }
337 };
341 enum TMixMode {
345  MIX_ENABLED,
349  MIX_DISABLED,
350 };
351 
356 public:
357  virtual ~IServiceObserver() {}
358 
363  virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType) {}
368  virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char* description) {}
380  virtual void onFetchConfigResult(int code, rtc::CONFIG_FETCH_TYPE configType, const char* configContent) {}
381 };
382 
394  public:
406  virtual int initialize(const AgoraServiceConfiguration& config) = 0;
407 
411  virtual int atExit(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
412 
420  virtual int release() = 0;
421 
431  virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
432 
441  virtual int setAudioSessionConfiguration(const AudioSessionConfiguration& config, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
442 
452 
472  virtual int setLogFile(const char* filePath, unsigned int fileSize, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
491  virtual int setLogFilter(unsigned int filters, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
492 
502  const rtc::RtcConnectionConfiguration& cfg) = 0;
503 
504  virtual agora_refptr<rtc::IRtmpConnection> createRtmpConnection(
505  const rtc::RtmpConnectionConfiguration& cfg) = 0;
506 
519 
530 
544 
559 
573  agora_refptr<rtc::IAudioPcmDataSender> audioSource, bool enableAec) = 0;
574 
588 
602  agora_refptr<rtc::IAudioEncodedFrameSender> audioSource, TMixMode mixMode) = 0;
604 
618 
630  agora_refptr<rtc::IMediaPlayerSource> audioSource) = 0;
631 
644  agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
645 
659  agora_refptr<rtc::IRecordingDeviceSource> audioSource, bool enableAec, bool overlap) = 0;
660 
669 
678 
691  agora_refptr<rtc::ICameraCapturer> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
692 
705  const char* id = OPTIONAL_NULLPTR) = 0;
706 
719  const char* id = OPTIONAL_NULLPTR) = 0;
720 
722 
733  agora_refptr<rtc::IVideoFrameSender> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
735 
750  const rtc::SenderOptions& options,
751  const char* id = OPTIONAL_NULLPTR) = 0;
752 
753 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
754 
767 
779  virtual agora_refptr<rtc::ILocalAudioTrack> createScreenCaptureAudioTrack(
781 #else
782 
794  agora_refptr<rtc::IScreenCapturer> screen, const char* id = OPTIONAL_NULLPTR) = 0;
795 #endif
796 
798 
809  agora_refptr<rtc::IMediaPacketSender> source, const char* id = OPTIONAL_NULLPTR) = 0;
811 
822  agora_refptr<rtc::IMediaPlayerSource> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
823 
835  agora_refptr<rtc::IMediaStreamingSource> streamingSource, const char* id = OPTIONAL_NULLPTR) = 0;
836 
837 
848  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
849 
861  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
862 
874  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
875 
884 
885  virtual int addExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
886 
887  virtual int removeExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
888 
897  rtc::IAudioDeviceManagerObserver *observer) = 0;
898 
907 
916  virtual const char* getExtensionId(const char* provider_name, const char* extension_name) = 0;
917 
918 #if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
919 
926  virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0;
927 #endif
928 
941  virtual int enableExtension(
942  const char* provider_name, const char* extension_name, const char* track_id = NULL,
943  bool auto_enable_on_track = false, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
955  virtual int disableExtension(
956  const char* provider_name, const char* extension_name, const char* track_id = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
957 
966 
975 
976  protected:
977  virtual ~IAgoraService() {}
978 };
979 
980 } // namespace base
981 } // namespace agora
982 
agora::base::AgoraServiceConfiguration::enableAudioDevice
bool enableAudioDevice
Definition: IAgoraService.h:97
agora::base::AudioSessionConfiguration::allowBluetoothA2DP
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:265
agora::base::AgoraServiceConfiguration::appId
const char * appId
Definition: IAgoraService.h:113
agora::base::AudioSessionConfiguration::chatMode
Optional< bool > chatMode
Definition: IAgoraService.h:206
agora::base::IAgoraService
Definition: IAgoraService.h:393
agora::rtc::SenderOptions
Definition: AgoraBase.h:1228
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::base::AudioSessionConfiguration::inputNumberOfChannels
Optional< int > inputNumberOfChannels
Definition: IAgoraService.h:283
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:80
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, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::base::AgoraServiceConfiguration::enableAudioProcessor
bool enableAudioProcessor
Definition: IAgoraService.h:86
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:637
agora::base::AudioSessionConfiguration::allowMixWithOthers
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:233
agora::base::IServiceObserver
Definition: IAgoraService.h:355
agora::base::IAgoraService::createMediaPlayerVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaPlayerVideoTrack(agora_refptr< rtc::IMediaPlayerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
agora::base::AgoraServiceConfiguration::serviceObserver
IServiceObserver * serviceObserver
Definition: IAgoraService.h:144
agora::base::IAgoraService::createLocalDataChannel
virtual agora_refptr< ILocalDataChannel > createLocalDataChannel(const DataChannelConfig &config)=0
agora::base::AudioSessionConfiguration::outputNumberOfChannels
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:287
agora::base::IAgoraService::createRtmpStreamingService
virtual agora_refptr< rtc::IRtmpStreamingService > createRtmpStreamingService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::base::IAgoraService::disableExtension
virtual int disableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::base::IAgoraService::createLocalMixedAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalMixedAudioTrack()=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:109
agora::rtc::RtmpConnectionConfiguration
Definition: NGIAgoraRtmpConnection.h:231
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:253
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:197
agora::base::IAgoraService::release
virtual int release()=0
agora::base::AgoraServiceConfiguration::domainLimit
bool domainLimit
Definition: IAgoraService.h:163
agora::base::AgoraServiceConfiguration::enableVideo
bool enableVideo
Definition: IAgoraService.h:103
agora::base::AgoraServiceConfiguration::__deprecated
Optional< rtc::THREAD_PRIORITY_TYPE > threadPriority __deprecated
Definition: IAgoraService.h:149
agora::base::IAgoraService::createScreenCaptureVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer > screen, const char *id=OPTIONAL_NULLPTR)=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:184
agora::base::IAgoraService::initialize
virtual int initialize(const AgoraServiceConfiguration &config)=0
agora::base::IAgoraService::setAudioSessionConfiguration
virtual int setAudioSessionConfiguration(const AudioSessionConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::base::IAgoraService::getConfigCenter
virtual agora_refptr< rtc::IConfigCenter > getConfigCenter()=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::getAudioSessionConfiguration
virtual int getAudioSessionConfiguration(AudioSessionConfiguration *config)=0
agora::base::IAgoraService::setAudioSessionPreset
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario, aosl_ref_t ares=AOSL_REF_INVALID)=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:363
agora::commons::LogConfig
Definition: IAgoraLog.h:82
agora::rtc::AudioEncoderConfiguration::audioProfile
AUDIO_PROFILE_TYPE audioProfile
Definition: IAgoraService.h:61
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IMediaPacketSender > source)=0
agora::base::IAgoraService::getAgoraParameter
virtual agora_refptr< base::IAgoraParameter > getAgoraParameter()=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:272
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::rtc::IAudioDeviceManagerObserver
Definition: NGIAgoraAudioDeviceManager.h:91
agora::rtc::RtcConnectionConfiguration
Definition: NGIAgoraRtcConnection.h:89
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::createRecordingDeviceAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec, bool overlap)=0
agora::base::AgoraServiceConfiguration::logConfig
commons::LogConfig logConfig
Definition: IAgoraService.h:136
agora::base::AgoraServiceConfiguration::license
const char * license
Definition: IAgoraService.h:127
agora::base::AgoraServiceConfiguration::useStringUid
bool useStringUid
Definition: IAgoraService.h:140
agora::base::AudioSessionConfiguration::ioBufferDuration
Optional< double > ioBufferDuration
Definition: IAgoraService.h:279
agora::base::IAgoraService::createMediaRelayService
virtual agora_refptr< rtc::IMediaRelayService > createMediaRelayService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::base::AudioSessionConfiguration::allowDuckOthers
Optional< bool > allowDuckOthers
Definition: IAgoraService.h:242
agora::base::IAgoraService::setLogFile
virtual int setLogFile(const char *filePath, unsigned int fileSize, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::base::IAgoraService::setLogFilter
virtual int setLogFilter(unsigned int filters, aosl_ref_t ares=AOSL_REF_INVALID)=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:215
agora::base::AgoraServiceConfiguration::audioScenario
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:132
agora::base::AgoraServiceConfiguration::useExternalEglContext
bool useExternalEglContext
Definition: IAgoraService.h:156
agora::rtc::AudioEncoderConfiguration
Definition: IAgoraService.h:57
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=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:368
agora::DataChannelConfig
Definition: NGIAgoraDataChannel.h:18
agora::base::AudioSessionConfiguration::overrideSpeaker
Optional< bool > overrideSpeaker
Definition: IAgoraService.h:224
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:118
agora::base::IServiceObserver::onFetchConfigResult
virtual void onFetchConfigResult(int code, rtc::CONFIG_FETCH_TYPE configType, const char *configContent)
Definition: IAgoraService.h:380
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:122
agora::base::IAgoraService::atExit
virtual int atExit(aosl_ref_t ares=AOSL_REF_INVALID)=0