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;
53  AUDIO_PROFILE_TYPE audioProfile;
54  // absl::optional<DtxStatus> dtx;
55  // double bitrate_priority = 1.0;
56  // absl::optional<int> ptime;
57  // FEC parameters
58  // Rtx parameters
59 
60  AudioEncoderConfiguration() : audioProfile(AUDIO_PROFILE_DEFAULT) {}
61 };
62 
63 } // namespace rtc
64 
65 namespace signaling {
66 class ISignalingEngine;
67 }
68 
69 namespace rtm {
70 class IRtmService;
71 }
72 
73 namespace base {
74 class IEngineBase;
75 class IServiceObserver;
76 
111  void* context;
115  const char* appId;
116 
120  unsigned int areaCode;
121 
124  agora::CHANNEL_PROFILE_TYPE channelProfile;
128  rtc::AUDIO_SCENARIO_TYPE audioScenario;
141 
143  enableAudioDevice(true),
144  enableVideo(false),
145  context(NULL),
146  appId(NULL),
147  areaCode(rtc::AREA_CODE_GLOB),
148  channelProfile(agora::CHANNEL_PROFILE_LIVE_BROADCASTING),
149  audioScenario(rtc::AUDIO_SCENARIO_DEFAULT),
150  useStringUid(false),
151  serviceObserver(NULL) {}
152 };
253 
254  void SetAll(AudioSessionConfiguration& change) {
255  SetFrom(&playbackAndRecord, change.playbackAndRecord);
256  SetFrom(&chatMode, change.chatMode);
257  SetFrom(&defaultToSpeaker, change.defaultToSpeaker);
258  SetFrom(&overrideSpeaker, change.overrideSpeaker);
259  SetFrom(&allowMixWithOthers, change.allowMixWithOthers);
260  SetFrom(&allowBluetooth, change.allowBluetooth);
261  SetFrom(&allowBluetoothA2DP, change.allowBluetoothA2DP);
262  SetFrom(&sampleRate, change.sampleRate);
263  SetFrom(&ioBufferDuration, change.ioBufferDuration);
266  }
267 
268  bool operator==(const AudioSessionConfiguration& o) const {
276  }
277  bool operator!=(const AudioSessionConfiguration& o) const { return !(*this == o); }
278 
279  private:
280  template <typename T>
281  static void SetFrom(Optional<T>* s, const Optional<T>& o) {
282  if (o) {
283  *s = o;
284  }
285  }
286 };
290 enum TMixMode {
294  MIX_ENABLED,
298  MIX_DISABLED,
299 };
303 enum TCcMode {
307  CC_ENABLED,
311  CC_DISABLED,
312 };
313 
321  TCcMode ccMode;
325  rtc::VIDEO_CODEC_TYPE codecType;
326 
384 
385  SenderOptions()
386  : ccMode(CC_ENABLED),
387  codecType(rtc::VIDEO_CODEC_H264),
388  targetBitrate(6500) {}
389 };
390 
395 public:
396  virtual ~IServiceObserver() {}
397 
402  virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType) {}
407  virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char* description) {}
408 };
409 
421  public:
433  virtual int initialize(const AgoraServiceConfiguration& config) = 0;
434 
438  virtual void atExit() = 0;
439 
447  virtual int release() = 0;
448 
458  virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario) = 0;
459 
469 
479 
499  virtual int setLogFile(const char* filePath, unsigned int fileSize) = 0;
518  virtual int setLogFilter(unsigned int filters) = 0;
519 
529  const rtc::RtcConnectionConfiguration& cfg) = 0;
530 
531  virtual agora_refptr<rtc::IRtmpConnection> createRtmpConnection(
532  const rtc::RtmpConnectionConfiguration& cfg) = 0;
533 
546 
560 
574  agora_refptr<rtc::IAudioPcmDataSender> audioSource, bool enableAec) = 0;
575 
589 
603  agora_refptr<rtc::IAudioEncodedFrameSender> audioSource, TMixMode mixMode) = 0;
605 
619 
631  agora_refptr<rtc::IMediaPlayerSource> audioSource) = 0;
632 
645  agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
646 
659  agora_refptr<rtc::IRecordingDeviceSource> audioSource, bool enableAec) = 0;
660 
669 
678 
691  agora_refptr<rtc::ICameraCapturer> videoSource) = 0;
692 
704  agora_refptr<rtc::IScreenCapturer> videoSource) = 0;
705 
718 
731 
733 
744  agora_refptr<rtc::IVideoFrameSender> videoSource) = 0;
746 
761  SenderOptions& options) = 0;
762 
764 
777 
788  agora_refptr<rtc::IMediaPlayerSource> videoSource) = 0;
789 
801  agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
802 
803 
814  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
815 
827  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
828 
837 
838  virtual int addExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer) = 0;
839 
840  virtual int removeExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer) = 0;
841 
850  rtc::IAudioDeviceManagerObserver *observer) = 0;
859  virtual const char* getExtensionId(const char* provider_name, const char* extension_name) = 0;
860 
861 #if defined (_WIN32) || (defined(__linux__) && !defined(__ANDROID__))
862 
868  virtual int loadExtensionProvider(const char* extension_lib_path) = 0;
869 #endif
870 
883  virtual int enableExtension(
884  const char* provider_name, const char* extension_name, const char* track_id = NULL,
885  bool auto_enable_on_track = false) = 0;
897  virtual int disableExtension(
898  const char* provider_name, const char* extension_name, const char* track_id = NULL) = 0;
899 
900  protected:
901  virtual ~IAgoraService() {}
902 };
903 
904 } // namespace base
905 } // namespace agora
906 
agora::base::AgoraServiceConfiguration::enableAudioDevice
bool enableAudioDevice
Definition: IAgoraService.h:99
agora::base::AudioSessionConfiguration::allowBluetoothA2DP
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:230
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:115
agora::base::AudioSessionConfiguration::chatMode
Optional< bool > chatMode
Definition: IAgoraService.h:180
agora::base::IAgoraService
Definition: IAgoraService.h:420
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:248
agora::base::IAgoraService::createRtmService
virtual rtm::IRtmService * createRtmService()=0
agora::base::IAgoraService::createMixedVideoTrack
virtual agora_refptr< rtc::ILocalVideoTrack > createMixedVideoTrack(agora_refptr< rtc::IVideoMixerSource > videoSource)=0
agora::base::AgoraServiceConfiguration
Definition: IAgoraService.h:82
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:88
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:638
agora::base::AudioSessionConfiguration::allowMixWithOthers
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:207
agora::base::IServiceObserver
Definition: IAgoraService.h:394
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:140
agora::base::AudioSessionConfiguration::outputNumberOfChannels
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:252
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:111
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:325
agora::base::AudioSessionConfiguration::allowBluetooth
Optional< bool > allowBluetooth
Definition: IAgoraService.h:218
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:171
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:105
agora::base::IAgoraService::createRecordingDeviceAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec)=0
agora::base::AudioSessionConfiguration
Definition: IAgoraService.h:158
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:402
agora::commons::LogConfig
Definition: IAgoraLog.h:84
agora::rtc::AudioEncoderConfiguration::audioProfile
AUDIO_PROFILE_TYPE audioProfile
Definition: IAgoraService.h:53
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:237
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:93
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:132
agora::base::AgoraServiceConfiguration::useStringUid
bool useStringUid
Definition: IAgoraService.h:136
agora::base::AudioSessionConfiguration::ioBufferDuration
Optional< double > ioBufferDuration
Definition: IAgoraService.h:244
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:383
agora::base::IAgoraService::setAudioSessionPreset
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario)=0
agora::base::AudioSessionConfiguration::defaultToSpeaker
Optional< bool > defaultToSpeaker
Definition: IAgoraService.h:189
agora::base::AgoraServiceConfiguration::audioScenario
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:128
agora::base::SenderOptions
Definition: IAgoraService.h:317
agora::rtc::AudioEncoderConfiguration
Definition: IAgoraService.h:49
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:407
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:198
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:120
agora::base::IAgoraService::createAudioDeviceManager
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
agora::base::SenderOptions::ccMode
TCcMode ccMode
Definition: IAgoraService.h:321
agora::Optional< bool >
agora::base::AgoraServiceConfiguration::channelProfile
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraService.h:124