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 
41 class IRtcEngine;
42 class IMediaExtensionObserver;
43 class IExtensionProvider;
51  AUDIO_PROFILE_TYPE audioProfile;
52  // absl::optional<DtxStatus> dtx;
53  // double bitrate_priority = 1.0;
54  // absl::optional<int> ptime;
55  // FEC parameters
56  // Rtx parameters
57 
58  AudioEncoderConfiguration() : audioProfile(AUDIO_PROFILE_DEFAULT) {}
59 };
60 
61 } // namespace rtc
62 
63 namespace signaling {
64 class ISignalingEngine;
65 }
66 
67 namespace rtm {
68 class IRtmService;
69 }
70 
71 namespace base {
72 class IEngineBase;
73 class IServiceObserver;
74 
109  void* context;
113  const char* appId;
114 
118  unsigned int areaCode;
119 
122  agora::CHANNEL_PROFILE_TYPE channelProfile;
126  rtc::AUDIO_SCENARIO_TYPE audioScenario;
139 
141  enableAudioDevice(true),
142  enableVideo(false),
143  context(NULL),
144  appId(NULL),
145  areaCode(rtc::AREA_CODE_GLOB),
146  channelProfile(agora::CHANNEL_PROFILE_LIVE_BROADCASTING),
147  audioScenario(rtc::AUDIO_SCENARIO_DEFAULT),
148  useStringUid(false),
149  serviceObserver(NULL) {}
150 };
251 
252  void SetAll(AudioSessionConfiguration& change) {
253  SetFrom(&playbackAndRecord, change.playbackAndRecord);
254  SetFrom(&chatMode, change.chatMode);
255  SetFrom(&defaultToSpeaker, change.defaultToSpeaker);
256  SetFrom(&overrideSpeaker, change.overrideSpeaker);
257  SetFrom(&allowMixWithOthers, change.allowMixWithOthers);
258  SetFrom(&allowBluetooth, change.allowBluetooth);
259  SetFrom(&allowBluetoothA2DP, change.allowBluetoothA2DP);
260  SetFrom(&sampleRate, change.sampleRate);
261  SetFrom(&ioBufferDuration, change.ioBufferDuration);
264  }
265 
266  bool operator==(const AudioSessionConfiguration& o) const {
274  }
275  bool operator!=(const AudioSessionConfiguration& o) const { return !(*this == o); }
276 
277  private:
278  template <typename T>
279  static void SetFrom(Optional<T>* s, const Optional<T>& o) {
280  if (o) {
281  *s = o;
282  }
283  }
284 };
288 enum TMixMode {
292  MIX_ENABLED,
296  MIX_DISABLED,
297 };
301 enum TCcMode {
305  CC_ENABLED,
309  CC_DISABLED,
310 };
311 
319  TCcMode ccMode;
323  rtc::VIDEO_CODEC_TYPE codecType;
324 
382 
383  SenderOptions()
384  : ccMode(CC_ENABLED),
385  codecType(rtc::VIDEO_CODEC_H264),
386  targetBitrate(6500) {}
387 };
388 
393 public:
394  virtual ~IServiceObserver() {}
395 
400  virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType) {}
405  virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char* description) {}
406 };
407 
419  public:
431  virtual int initialize(const AgoraServiceConfiguration& config) = 0;
432 
436  virtual void atExit() = 0;
437 
445  virtual int release() = 0;
446 
456  virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario) = 0;
457 
467 
477 
497  virtual int setLogFile(const char* filePath, unsigned int fileSize) = 0;
516  virtual int setLogFilter(unsigned int filters) = 0;
517 
527  const rtc::RtcConnectionConfiguration& cfg) = 0;
528 
529  virtual agora_refptr<rtc::IRtmpConnection> createRtmpConnection(
530  const rtc::RtmpConnectionConfiguration& cfg) = 0;
531 
544 
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) = 0;
675 
687  agora_refptr<rtc::IScreenCapturer> videoSource) = 0;
688 
701 
714 
716 
727  agora_refptr<rtc::IVideoFrameSender> videoSource) = 0;
729 
744  SenderOptions& options) = 0;
745 
747 
760 
771  agora_refptr<rtc::IMediaPlayerSource> videoSource) = 0;
772 
784  agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
785 
786 
797  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
798 
810  agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
811 
820 
821  virtual int addExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer) = 0;
822 
823  virtual int removeExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer) = 0;
824 
825  virtual int addExtensionProvider(const char* id,
827 
828  virtual int removeExtensionProvider(const char* id) = 0;
829 
830  protected:
831  virtual ~IAgoraService() {}
832 };
833 
834 } // namespace base
835 } // namespace agora
836 
agora::base::AgoraServiceConfiguration::enableAudioDevice
bool enableAudioDevice
Definition: IAgoraService.h:97
agora::base::AudioSessionConfiguration::allowBluetoothA2DP
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:228
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:113
agora::base::AudioSessionConfiguration::chatMode
Optional< bool > chatMode
Definition: IAgoraService.h:178
agora::base::IAgoraService
Definition: IAgoraService.h:418
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:246
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:80
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:86
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:638
agora::base::AudioSessionConfiguration::allowMixWithOthers
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:205
agora::base::IServiceObserver
Definition: IAgoraService.h:392
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:138
agora::base::AudioSessionConfiguration::outputNumberOfChannels
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:250
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:109
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:323
agora::base::AudioSessionConfiguration::allowBluetooth
Optional< bool > allowBluetooth
Definition: IAgoraService.h:216
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:169
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:103
agora::base::IAgoraService::createRecordingDeviceAudioTrack
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec)=0
agora::base::AudioSessionConfiguration
Definition: IAgoraService.h:156
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::IServiceObserver::onPermissionError
virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType)
Definition: IAgoraService.h:400
agora::commons::LogConfig
Definition: IAgoraLog.h:84
agora::rtc::AudioEncoderConfiguration::audioProfile
AUDIO_PROFILE_TYPE audioProfile
Definition: IAgoraService.h:51
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:235
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::AgoraServiceConfiguration::logConfig
commons::LogConfig logConfig
Definition: IAgoraService.h:130
agora::base::AgoraServiceConfiguration::useStringUid
bool useStringUid
Definition: IAgoraService.h:134
agora::base::AudioSessionConfiguration::ioBufferDuration
Optional< double > ioBufferDuration
Definition: IAgoraService.h:242
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:381
agora::base::IAgoraService::setAudioSessionPreset
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario)=0
agora::base::AudioSessionConfiguration::defaultToSpeaker
Optional< bool > defaultToSpeaker
Definition: IAgoraService.h:187
agora::base::AgoraServiceConfiguration::audioScenario
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:126
agora::base::SenderOptions
Definition: IAgoraService.h:315
agora::rtc::AudioEncoderConfiguration
Definition: IAgoraService.h:47
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:405
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:196
agora::base::AgoraServiceConfiguration::areaCode
unsigned int areaCode
Definition: IAgoraService.h:118
agora::base::IAgoraService::createAudioDeviceManager
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
agora::base::SenderOptions::ccMode
TCcMode ccMode
Definition: IAgoraService.h:319
agora::Optional< bool >
agora::base::AgoraServiceConfiguration::channelProfile
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraService.h:122