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 #include "IAgoraLog.h"
8 #include "AgoraBase.h"
9 #include "AgoraOptional.h"
10 
11 namespace agora {
12 namespace rtc {
13 class IRtcConnection;
14 class IRtmpConnection;
15 class ILocalUser;
16 class IMediaDeviceManager;
17 class INGAudioDeviceManager;
18 struct TConnectionInfo;
19 struct RtcConnectionConfiguration;
20 struct RtmpConnectionConfiguration;
21 class ILocalAudioTrack;
22 class IMediaPlayerSource;
23 class IMediaStreamingSource;
24 class ICameraCapturer;
25 class IScreenCapturer;
26 class IAudioPcmDataSender;
27 class IAudioEncodedFrameSender;
28 class IVideoFrameSender;
29 class IVideoEncodedImageSender;
30 class IVideoSourceNode;
31 class IVideoMixerSource;
32 class IVideoFrameTransceiver;
33 class ILocalVideoTrack;
34 class IMediaNodeFactory;
35 class IRecordingDeviceSource;
36 class IRemoteAudioMixerSource;
37 class IRtmpStreamingService;
38 class IMediaPacketSender;
39 class IMediaRelayService;
40 class IAudioDeviceManager;
41 class IAudioDeviceManagerObserver;
42 
43 class IRtcEngine;
44 class IMediaExtensionObserver;
45 class IExtensionProvider;
46 class IFileUploaderService;
54  AUDIO_PROFILE_TYPE audioProfile;
55  // absl::optional<DtxStatus> dtx;
56  // double bitrate_priority = 1.0;
57  // absl::optional<int> ptime;
58  // FEC parameters
59  // Rtx parameters
60 
61  AudioEncoderConfiguration() : audioProfile(AUDIO_PROFILE_DEFAULT) {}
62 };
63 
64 } // namespace rtc
65 
66 namespace signaling {
67 class ISignalingEngine;
68 }
69 
70 namespace rtm {
71 class IRtmService;
72 }
73 
74 namespace base {
75 class IEngineBase;
76 class IServiceObserver;
77 
112  void* context;
116  const char* appId;
117 
121  unsigned int areaCode;
122 
125  agora::CHANNEL_PROFILE_TYPE channelProfile;
129  rtc::AUDIO_SCENARIO_TYPE audioScenario;
142 
144  enableAudioDevice(true),
145  enableVideo(false),
146  context(NULL),
147  appId(NULL),
148  areaCode(rtc::AREA_CODE_GLOB),
149  channelProfile(agora::CHANNEL_PROFILE_LIVE_BROADCASTING),
150  audioScenario(rtc::AUDIO_SCENARIO_DEFAULT),
151  useStringUid(false),
152  serviceObserver(NULL) {}
153 };
254 
255  void SetAll(AudioSessionConfiguration& change) {
256  SetFrom(&playbackAndRecord, change.playbackAndRecord);
257  SetFrom(&chatMode, change.chatMode);
258  SetFrom(&defaultToSpeaker, change.defaultToSpeaker);
259  SetFrom(&overrideSpeaker, change.overrideSpeaker);
260  SetFrom(&allowMixWithOthers, change.allowMixWithOthers);
261  SetFrom(&allowBluetooth, change.allowBluetooth);
262  SetFrom(&allowBluetoothA2DP, change.allowBluetoothA2DP);
263  SetFrom(&sampleRate, change.sampleRate);
264  SetFrom(&ioBufferDuration, change.ioBufferDuration);
267  }
268 
269  bool operator==(const AudioSessionConfiguration& o) const {
277  }
278  bool operator!=(const AudioSessionConfiguration& o) const { return !(*this == o); }
279 
280  private:
281  template <typename T>
282  static void SetFrom(Optional<T>* s, const Optional<T>& o) {
283  if (o) {
284  *s = o;
285  }
286  }
287 };
291 enum TMixMode {
295  MIX_ENABLED,
299  MIX_DISABLED,
300 };
304 enum TCcMode {
308  CC_ENABLED,
312  CC_DISABLED,
313 };
314 
322  TCcMode ccMode;
326  rtc::VIDEO_CODEC_TYPE codecType;
327 
385 
386  SenderOptions()
387  : ccMode(CC_ENABLED),
388  codecType(rtc::VIDEO_CODEC_H264),
389  targetBitrate(6500) {}
390 };
391 
396 public:
397  virtual ~IServiceObserver() {}
398 
403  virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType) {}
408  virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char* description) {}
409 };
410 
422  public:
434  virtual int initialize(const AgoraServiceConfiguration& config) = 0;
435 
439  virtual void atExit() = 0;
440 
448  virtual int release() = 0;
449 
459  virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario) = 0;
460 
470 
480 
500  virtual int setLogFile(const char* filePath, unsigned int fileSize) = 0;
519  virtual int setLogFilter(unsigned int filters) = 0;
520 
530  const rtc::RtcConnectionConfiguration& cfg) = 0;
531 
532  virtual agora_refptr<rtc::IRtmpConnection> createRtmpConnection(
533  const rtc::RtmpConnectionConfiguration& cfg) = 0;
534 
547 
561 
575  agora_refptr<rtc::IAudioPcmDataSender> audioSource, bool enableAec) = 0;
576 
590 
604  agora_refptr<rtc::IAudioEncodedFrameSender> audioSource, TMixMode mixMode) = 0;
606 
620 
632  agora_refptr<rtc::IMediaPlayerSource> audioSource) = 0;
633 
646  agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
647 
660  agora_refptr<rtc::IRecordingDeviceSource> audioSource, bool enableAec) = 0;
661 
670 
679 
692  agora_refptr<rtc::ICameraCapturer> videoSource) = 0;
693 
705  agora_refptr<rtc::IScreenCapturer> videoSource) = 0;
706 
719 
732 
734 
745  agora_refptr<rtc::IVideoFrameSender> videoSource) = 0;
747 
762  SenderOptions& options) = 0;
763 
765 
778 
789  agora_refptr<rtc::IMediaPlayerSource> videoSource) = 0;
790 
802  agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
803 
804 
815  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
816 
828  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
829 
841  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
842 
851 
852  virtual int addExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer) = 0;
853 
854  virtual int removeExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer) = 0;
855 
864  rtc::IAudioDeviceManagerObserver *observer) = 0;
873  virtual const char* getExtensionId(const char* provider_name, const char* extension_name) = 0;
874 
875 #if defined (_WIN32) || (defined(__linux__) && !defined(__ANDROID__))
876 
882  virtual int loadExtensionProvider(const char* extension_lib_path) = 0;
883 #endif
884 
897  virtual int enableExtension(
898  const char* provider_name, const char* extension_name, const char* track_id = NULL,
899  bool auto_enable_on_track = false) = 0;
911  virtual int disableExtension(
912  const char* provider_name, const char* extension_name, const char* track_id = NULL) = 0;
913 
926  virtual int setExtensionProviderProperty(const char* provider_name,
927  const char* key,
928  const char* json_value) = 0;
929  protected:
930  virtual ~IAgoraService() {}
931 };
932 
933 } // namespace base
934 } // namespace agora
935 
agora::base::AgoraServiceConfiguration::enableAudioDevice
bool enableAudioDevice
Definition: IAgoraService.h:100
agora::base::AudioSessionConfiguration::allowBluetoothA2DP
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:231
agora::base::IAgoraService::createCustomVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoFrameSender > videoSource)=0
agora::base::AgoraServiceConfiguration::appId
const char * appId
Definition: IAgoraService.h:116
agora::base::AudioSessionConfiguration::chatMode
Optional< bool > chatMode
Definition: IAgoraService.h:181
agora::base::IAgoraService
Definition: IAgoraService.h:421
agora::base::IAgoraService::disableExtension
virtual int disableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL)=0
agora::base::IAgoraService::createTranscodedVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createTranscodedVideoTrack(agora_refptr< rtc::IVideoFrameTransceiver > transceiver)=0
agora::base::IAgoraService::createCustomVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IMediaPacketSender > source)=0
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::base::AudioSessionConfiguration::inputNumberOfChannels
Optional< int > inputNumberOfChannels
Definition: IAgoraService.h:249
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::IAgoraService::createMixedVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMixedVideoTrack(agora_refptr< rtc::IVideoMixerSource > videoSource)=0
agora::base::AgoraServiceConfiguration
Definition: IAgoraService.h:83
agora::base::IAgoraService::createMediaStreamingVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaStreamingVideoTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0
agora::base::AgoraServiceConfiguration::enableAudioProcessor
bool enableAudioProcessor
Definition: IAgoraService.h:89
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:638
agora::base::AudioSessionConfiguration::allowMixWithOthers
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:208
agora::base::IServiceObserver
Definition: IAgoraService.h:395
agora::base::IAgoraService::createCameraVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCameraVideoTrack(agora_refptr< rtc::ICameraCapturer > videoSource)=0
agora::base::IAgoraService::setAudioSessionConfiguration
virtual int setAudioSessionConfiguration(const AudioSessionConfiguration &config)=0
agora::base::AgoraServiceConfiguration::serviceObserver
IServiceObserver * serviceObserver
Definition: IAgoraService.h:141
agora::base::AudioSessionConfiguration::outputNumberOfChannels
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:253
agora::base::IAgoraService::createRtmpStreamingService
virtual agora_refptr< rtc::IRtmpStreamingService > createRtmpStreamingService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::base::AgoraServiceConfiguration::context
void * context
Definition: IAgoraService.h:112
agora::rtc::RtmpConnectionConfiguration
Definition: NGIAgoraRtmpConnection.h:192
agora::base::IAgoraService::createLocalAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalAudioTrack()=0
createAgoraService
AGORA_API agora::base::IAgoraService *AGORA_CALL createAgoraService()
agora::base::SenderOptions::codecType
rtc::VIDEO_CODEC_TYPE codecType
Definition: IAgoraService.h:326
agora::base::AudioSessionConfiguration::allowBluetooth
Optional< bool > allowBluetooth
Definition: IAgoraService.h:219
agora::base::IAgoraService::createMediaPlayerVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaPlayerVideoTrack(agora_refptr< rtc::IMediaPlayerSource > videoSource)=0
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:172
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::enableVideo
bool enableVideo
Definition: IAgoraService.h:106
agora::base::IAgoraService::createRecordingDeviceAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec)=0
agora::base::IAgoraService::setExtensionProviderProperty
virtual int setExtensionProviderProperty(const char *provider_name, const char *key, const char *json_value)=0
agora::base::AudioSessionConfiguration
Definition: IAgoraService.h:159
agora::base::IAgoraService::initialize
virtual int initialize(const AgoraServiceConfiguration &config)=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::createCustomVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoEncodedImageSender > videoSource, SenderOptions &options)=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:403
agora::commons::LogConfig
Definition: IAgoraLog.h:84
agora::rtc::AudioEncoderConfiguration::audioProfile
AUDIO_PROFILE_TYPE audioProfile
Definition: IAgoraService.h:54
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:238
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource, bool enableAec)=0
agora::rtc::IAudioDeviceManagerObserver
Definition: NGIAgoraAudioDeviceManager.h:69
agora::rtc::RtcConnectionConfiguration
Definition: NGIAgoraRtcConnection.h:106
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:133
agora::base::AgoraServiceConfiguration::useStringUid
bool useStringUid
Definition: IAgoraService.h:137
agora::base::AudioSessionConfiguration::ioBufferDuration
Optional< double > ioBufferDuration
Definition: IAgoraService.h:245
agora::base::IAgoraService::createMediaRelayService
virtual agora_refptr< rtc::IMediaRelayService > createMediaRelayService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
agora::base::SenderOptions::targetBitrate
int targetBitrate
Definition: IAgoraService.h:384
agora::base::IAgoraService::setAudioSessionPreset
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario)=0
agora::base::AudioSessionConfiguration::defaultToSpeaker
Optional< bool > defaultToSpeaker
Definition: IAgoraService.h:190
agora::base::AgoraServiceConfiguration::audioScenario
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:129
agora::base::SenderOptions
Definition: IAgoraService.h:318
agora::rtc::AudioEncoderConfiguration
Definition: IAgoraService.h:50
agora::base::IAgoraService::createCustomAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
agora::base::IAgoraService::atExit
virtual void atExit()=0
agora::base::IServiceObserver::onAudioDeviceError
virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char *description)
Definition: IAgoraService.h:408
agora::base::IAgoraService::createScreenVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenVideoTrack(agora_refptr< rtc::IScreenCapturer > videoSource)=0
agora::base::AudioSessionConfiguration::overrideSpeaker
Optional< bool > overrideSpeaker
Definition: IAgoraService.h:199
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:121
agora::base::IAgoraService::createAudioDeviceManager
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
agora::base::SenderOptions::ccMode
TCcMode ccMode
Definition: IAgoraService.h:322
agora::Optional< bool >
agora::base::AgoraServiceConfiguration::channelProfile
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraService.h:125