Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
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
13namespace agora {
17
18namespace rtc {
19class IRtcConnection;
20class IRtmpConnection;
21class ILocalUser;
22class IMediaDeviceManager;
25struct TConnectionInfo;
31class ICameraCapturer;
32class IScreenCapturer;
38class IVideoSourceNode;
48class IAudioDeviceManager;
50
54class IConfigCenter;
66
67} // namespace rtc
68
69namespace rtm {
70class IRtmService;
71}
72
73namespace base {
75class ISyncClient;
76struct SyncConfig;
77
190
299
300#if defined(WEBRTC_IOS)
305#endif
306
307 void SetAll(const AudioSessionConfiguration& change) {
308 SetFrom(&playbackAndRecord, change.playbackAndRecord);
309 SetFrom(&chatMode, change.chatMode);
310 SetFrom(&defaultToSpeaker, change.defaultToSpeaker);
311 SetFrom(&overrideSpeaker, change.overrideSpeaker);
312 SetFrom(&allowMixWithOthers, change.allowMixWithOthers);
313 SetFrom(&allowDuckOthers, change.allowDuckOthers);
314 SetFrom(&allowBluetooth, change.allowBluetooth);
315 SetFrom(&allowBluetoothA2DP, change.allowBluetoothA2DP);
316 SetFrom(&sampleRate, change.sampleRate);
317 SetFrom(&ioBufferDuration, change.ioBufferDuration);
320#if defined(WEBRTC_IOS)
321 SetFrom(&category, change.category);
322#endif
323 }
324
339 bool operator!=(const AudioSessionConfiguration& o) const { return !(*this == o); }
340
341 private:
342 template <typename T>
343 static void SetFrom(Optional<T>* s, const Optional<T>& o) {
344 if (o) {
345 *s = o;
346 }
347 }
348};
349
362
367public:
368 virtual ~IServiceObserver() {}
369
374 virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType) {}
379 virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char* description) {}
391 virtual void onFetchConfigResult(int code, rtc::CONFIG_FETCH_TYPE configType, const char* configContent) {}
392
393#if defined(__ANDROID__)
398 virtual void onPermissionGranted(agora::rtc::PERMISSION_TYPE permissionType) {}
399#endif
400
407 virtual void onLocalUserRegistered(rtc::uid_t uid, const char* userAccount) {}
408
409};
410
422 public:
434 virtual int initialize(const AgoraServiceConfiguration& config) = 0;
435
439 virtual int atExit(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
440
448 virtual int release() = 0;
449
459 virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
460
469 virtual int setAudioSessionConfiguration(const AudioSessionConfiguration& config, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
470
480
500 virtual int setLogFile(const char* filePath, unsigned int fileSize, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
519 virtual int setLogFilter(unsigned int filters, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
520
530 const rtc::RtcConnectionConfiguration& cfg) = 0;
531
533 const rtc::RtmpConnectionConfiguration& cfg) = 0;
534
547
558
572
587
601
617
631
644
657 agora_refptr<rtc::IMediaStreamingSource> streamingSource) = 0;
658
673 agora_refptr<rtc::IRecordingDeviceSource> audioSource, bool enableAec, bool overlap, bool standaloneAdm) = 0;
674
683
684
693
702
715 agora_refptr<rtc::ICameraCapturer> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
716
729 const char* id = OPTIONAL_NULLPTR) = 0;
730
743 const char* id = OPTIONAL_NULLPTR) = 0;
744
746
757 agora_refptr<rtc::IVideoFrameSender> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
759
774 const rtc::SenderOptions& options,
775 const char* id = OPTIONAL_NULLPTR) = 0;
776
777#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
791
805#else
818 agora_refptr<rtc::IScreenCapturer> screen, const char* id = OPTIONAL_NULLPTR) = 0;
819
820
834#endif
835
837
848 agora_refptr<rtc::IMediaPacketSender> source, const char* id = OPTIONAL_NULLPTR) = 0;
850
861 agora_refptr<rtc::IMediaPlayerSource> videoSource, const char* id = OPTIONAL_NULLPTR) = 0;
862
874 agora_refptr<rtc::IMediaStreamingSource> streamingSource, const char* id = OPTIONAL_NULLPTR) = 0;
875
876
887 agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
888
900 agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
901
913 agora_refptr<rtc::IRtcConnection> rtcConnection, const char* appId) = 0;
914
923
924 virtual int addExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
925
926 virtual int removeExtensionObserver(agora::agora_refptr<agora::rtc::IMediaExtensionObserver> observer, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
927
937
946
955 virtual const char* getExtensionId(const char* provider_name, const char* extension_name) = 0;
956
957#if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
965 virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0;
966#endif
980 virtual int enableExtension(
981 const char* provider_name, const char* extension_name, const char* track_id = NULL,
982 bool auto_enable_on_track = false, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
994 virtual int disableExtension(
995 const char* provider_name, const char* extension_name, const char* track_id = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
996
1005
1014
1023
1031 virtual int32_t setLogWriter(agora::commons::ILogWriter* logWriter) = 0;
1032
1040
1041 protected:
1042 virtual ~IAgoraService() {}
1043};
1044
1045} // namespace base
1046} // namespace agora
1047
Definition NGIAgoraDataChannel.h:84
Definition NGIAgoraDataChannel.h:118
Definition AgoraOptional.h:413
Definition AgoraRefPtr.h:44
Definition IAgoraService.h:421
virtual agora_refptr< rtc::ILocalAudioTrack > createDirectCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
virtual int loadExtensionProvider(const char *path, bool unload_after_use=false)=0
load the dynamic library of the extension
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaStreamingAudioTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0
virtual agora_refptr< rtc::IFileUploaderService > createFileUploadService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IRemoteAudioMixerSource > audioSource)=0
virtual int setAudioSessionConfiguration(const AudioSessionConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setLogFile(const char *filePath, unsigned int fileSize, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoFrameSender > videoSource, const char *id=OPTIONAL_NULLPTR)=0
virtual int addExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaPlayerAudioTrack(agora_refptr< rtc::IMediaPlayerSource > audioSource)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
virtual agora_refptr< rtc::IMediaRelayService > createMediaRelayService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer > screen, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaPlayerVideoTrack(agora_refptr< rtc::IMediaPlayerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
virtual int removeExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createMixedVideoTrack(agora_refptr< rtc::IVideoMixerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::INGVideoDeviceManager > createVideoDeviceManager()=0
virtual agora_refptr< rtc::IRtmpStreamingService > createRtmpStreamingService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalMixedAudioTrack()=0
virtual const char * getExtensionId(const char *provider_name, const char *extension_name)=0
Get the ID of the registered extension.
virtual int initialize(const AgoraServiceConfiguration &config)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoEncodedImageSender > videoSource, const rtc::SenderOptions &options, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaStreamingVideoTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec, bool overlap, bool standaloneAdm)=0
virtual agora_refptr< rtc::IMediaNodeFactory > createMediaNodeFactory()=0
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalAudioTrack()=0
virtual int getAudioSessionConfiguration(AudioSessionConfiguration *config)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createTranscodedVideoTrack(agora_refptr< rtc::IVideoFrameTransceiver > transceiver, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createScreenCaptureAudioTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
virtual ~IAgoraService()
Definition IAgoraService.h:1042
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioEncodedFrameSender > audioSource, TMixMode mixMode)=0
virtual agora_refptr< rtc::IConfigCenter > getConfigCenter()=0
virtual agora_refptr< ILocalDataChannel > createLocalDataChannel(const DataChannelConfig &config)=0
virtual agora_refptr< base::IAgoraParameter > getAgoraParameter()=0
virtual agora_refptr< base::ISyncClient > createSyncClient(const base::SyncConfig &config)=0
virtual agora::commons::ILogWriter * releaseLogWriter()=0
virtual agora_refptr< rtc::IRtcConnection > createRtcConnection(const rtc::RtcConnectionConfiguration &cfg)=0
virtual int32_t setLogWriter(agora::commons::ILogWriter *logWriter)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
virtual int setLogFilter(unsigned int filters, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual agora_refptr< rtc::IAudioDeviceManager > createAudioDeviceManagerComponent(rtc::IAudioDeviceManagerObserver *observer)=0
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
virtual rtm::IRtmService * createRtmService()=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IMediaPacketSender > source, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
virtual int disableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IMediaPacketSender > source)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCameraVideoTrack(agora_refptr< rtc::ICameraCapturer > videoSource, const char *id=OPTIONAL_NULLPTR)=0
virtual int atExit(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createScreenCaptureAudioTrack(agora_refptr< rtc::IScreenCapturer > screen)=0
virtual agora_refptr< rtc::IRtmpConnection > createRtmpConnection(const rtc::RtmpConnectionConfiguration &cfg)=0
Definition IAgoraService.h:366
virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char *description)
Definition IAgoraService.h:379
virtual void onLocalUserRegistered(rtc::uid_t uid, const char *userAccount)
Definition IAgoraService.h:407
virtual ~IServiceObserver()
Definition IAgoraService.h:368
virtual void onFetchConfigResult(int code, rtc::CONFIG_FETCH_TYPE configType, const char *configContent)
Definition IAgoraService.h:391
virtual void onPermissionGranted(agora::rtc::PERMISSION_TYPE permissionType)
Definition IAgoraService.h:398
virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType)
Definition IAgoraService.h:374
Definition NGIAgoraSyncClient.h:90
Definition IAgoraLog.h:66
Definition NGIAgoraAudioDeviceManager.h:91
Definition NGIAgoraMediaNode.h:277
Definition NGIAgoraMediaNode.h:244
Definition NGIAgoraCameraCapturer.h:20
Definition NGIAgoraConfigCenter.h:15
Definition NGIAgoraExtensionProvider.h:35
Definition IAgoraFileUploader.h:38
Definition NGIAgoraAudioTrack.h:269
Definition NGIAgoraLocalUser.h:56
Definition NGIAgoraVideoTrack.h:394
Definition NGIAgoraMediaNode.h:230
Definition NGIAgoraMediaNodeFactory.h:37
Definition NGIAgoraMediaNode.h:361
Definition IAgoraMediaPlayerSource.h:22
Definition IAgoraMediaRelayService.h:15
The IMediaStreamingSource class provides access to a media streaming source demuxer....
Definition IAgoraMediaStreamingSource.h:97
Definition NGIAgoraAudioDeviceManager.h:203
Definition NGIAgoraVideoDeviceManager.h:68
Definition NGIAgoraAudioDeviceManager.h:140
Definition NGIAgoraRemoteAudioMixerSource.h:22
Definition NGIAgoraRtcConnection.h:191
Definition NGIAgoraRtmpConnection.h:317
Definition IAgoraRtmpStreamingService.h:90
Definition NGIAgoraScreenCapturer.h:146
Definition NGIAgoraScreenCapturer.h:19
Definition NGIAgoraMediaNode.h:470
Definition NGIAgoraMediaNode.h:446
Definition NGIAgoraMediaNode.h:662
Definition NGIAgoraVideoMixerSource.h:46
Definition IAgoraRtmService.h:637
AGORA_API agora::base::IAgoraService *AGORA_CALL createAgoraService()
Definition IAgoraService.h:73
TMixMode
Definition IAgoraService.h:352
@ MIX_ENABLED
Definition IAgoraService.h:356
@ MIX_DISABLED
Definition IAgoraService.h:360
Definition AgoraExtensions.h:5
AUDIO_SCENARIO_TYPE
The audio scenarios.
Definition AgoraBase.h:3210
PERMISSION_TYPE
The type of the device permission.
Definition AgoraBase.h:7553
AUDIO_PROFILE_TYPE
The audio profile.
Definition AgoraBase.h:3162
@ AUDIO_PROFILE_DEFAULT
Definition AgoraBase.h:3172
CONFIG_FETCH_TYPE
Definition AgoraBase.h:7926
unsigned int uid_t
Definition AgoraMediaBase.h:28
Definition AgoraAtomicOps.h:21
ERROR_CODE_TYPE
Error codes.
Definition AgoraBase.h:477
CHANNEL_PROFILE_TYPE
The channel profile.
Definition AgoraBase.h:267
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition AgoraBase.h:275
Definition video_node_i.h:28
Definition NGIAgoraDataChannel.h:18
Definition IAgoraService.h:83
bool useExternalEglContext
Definition IAgoraService.h:159
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition IAgoraService.h:125
IServiceObserver * serviceObserver
Definition IAgoraService.h:147
Optional< rtc::THREAD_PRIORITY_TYPE > threadPriority __deprecated
Definition IAgoraService.h:152
commons::LogConfig logConfig
Definition IAgoraService.h:139
bool domainLimit
Definition IAgoraService.h:166
unsigned int areaCode
Definition IAgoraService.h:121
bool useStringUid
Definition IAgoraService.h:143
bool enableAudioDevice
Definition IAgoraService.h:100
const char * appId
Definition IAgoraService.h:116
bool enableAudioProcessor
Definition IAgoraService.h:89
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition IAgoraService.h:135
bool enableVideo
Definition IAgoraService.h:106
void * context
Definition IAgoraService.h:112
const char * license
Definition IAgoraService.h:130
AgoraServiceConfiguration()
Definition IAgoraService.h:175
const char * parameters
Definition IAgoraService.h:173
Definition IAgoraService.h:195
Optional< bool > allowBluetoothA2DP
Definition IAgoraService.h:276
Optional< bool > overrideSpeaker
Definition IAgoraService.h:235
Optional< bool > allowBluetooth
Definition IAgoraService.h:264
Optional< int > outputNumberOfChannels
Definition IAgoraService.h:298
void SetAll(const AudioSessionConfiguration &change)
Definition IAgoraService.h:307
Optional< bool > chatMode
Definition IAgoraService.h:217
Optional< int > inputNumberOfChannels
Definition IAgoraService.h:294
bool operator==(const AudioSessionConfiguration &o) const
Definition IAgoraService.h:325
Optional< bool > playbackAndRecord
Definition IAgoraService.h:208
Optional< bool > defaultToSpeaker
Definition IAgoraService.h:226
Optional< bool > allowMixWithOthers
Definition IAgoraService.h:244
Optional< double > sampleRate
Definition IAgoraService.h:283
Optional< double > ioBufferDuration
Definition IAgoraService.h:290
Optional< int > category
Definition IAgoraService.h:304
bool operator!=(const AudioSessionConfiguration &o) const
Definition IAgoraService.h:339
Optional< bool > allowDuckOthers
Definition IAgoraService.h:253
Definition NGIAgoraSyncClient.h:79
Configuration of Agora SDK log files.
Definition IAgoraLog.h:124
AudioEncoderConfiguration()
Definition IAgoraService.h:64
AUDIO_PROFILE_TYPE audioProfile
Definition IAgoraService.h:62
Definition NGIAgoraRtcConnection.h:90
Definition NGIAgoraRtmpConnection.h:231
Definition AgoraBase.h:1428
Definition NGIAgoraRtcConnection.h:26