Agora C++ API Reference for All Platforms
|
6 #pragma once // NOLINT(build/header_guard)
10 #include "AgoraOptional.h"
11 #include <api/cpp/aosl_ares_class.h>
14 class ILocalDataChannel;
15 class IRemoteDataChannel;
16 struct DataChannelConfig;
20 class IRtmpConnection;
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;
50 class IMediaExtensionObserver;
51 class IExtensionProvider;
52 class IFileUploaderService;
291 #if defined(WEBRTC_IOS)
311 #if defined(WEBRTC_IOS)
323 #if defined(WEBRTC_IOS)
333 template <
typename T>
413 virtual int atExit(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
474 virtual int setLogFile(
const char* filePath,
unsigned int fileSize, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
493 virtual int setLogFilter(
unsigned int filters, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
707 const char*
id = OPTIONAL_NULLPTR) = 0;
721 const char*
id = OPTIONAL_NULLPTR) = 0;
753 const char*
id = OPTIONAL_NULLPTR) = 0;
755 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
918 virtual const char*
getExtensionId(
const char* provider_name,
const char* extension_name) = 0;
920 #if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
944 const char* provider_name,
const char* extension_name,
const char* track_id = NULL,
945 bool auto_enable_on_track =
false, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
958 const char* provider_name,
const char* extension_name,
const char* track_id = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
bool enableAudioDevice
Definition: IAgoraService.h:99
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:267
const char * appId
Definition: IAgoraService.h:115
Optional< bool > chatMode
Definition: IAgoraService.h:208
Definition: IAgoraService.h:395
Definition: AgoraBase.h:1233
Definition: IAgoraLog.h:50
virtual ~IAgoraService()
Definition: IAgoraService.h:1005
Definition: AgoraRefPtr.h:44
Optional< int > inputNumberOfChannels
Definition: IAgoraService.h:285
virtual rtm::IRtmService * createRtmService()=0
virtual agora_refptr< rtc::IFileUploaderService > createFileUploadService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
Definition: IAgoraService.h:82
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
AUDIO_PROFILE_TYPE
Definition: AgoraBase.h:2571
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
bool enableAudioProcessor
Definition: IAgoraService.h:88
Definition: IAgoraRtmService.h:637
ERROR_CODE_TYPE
Definition: AgoraBase.h:452
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2617
virtual ~IServiceObserver()
Definition: IAgoraService.h:359
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:235
Definition: IAgoraService.h:357
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaPlayerVideoTrack(agora_refptr< rtc::IMediaPlayerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
IServiceObserver * serviceObserver
Definition: IAgoraService.h:146
virtual agora_refptr< ILocalDataChannel > createLocalDataChannel(const DataChannelConfig &config)=0
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:289
virtual agora_refptr< rtc::IRtmpStreamingService > createRtmpStreamingService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=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 > createLocalMixedAudioTrack()=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IMediaPacketSender > source, const char *id=OPTIONAL_NULLPTR)=0
void * context
Definition: IAgoraService.h:111
AudioEncoderConfiguration()
Definition: IAgoraService.h:63
virtual agora_refptr< base::ISyncClient > createSyncClient(const base::SyncConfig &config)=0
Definition: NGIAgoraRtmpConnection.h:231
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalAudioTrack()=0
AGORA_API agora::base::IAgoraService *AGORA_CALL createAgoraService()
virtual agora_refptr< rtc::ILocalVideoTrack > createMixedVideoTrack(agora_refptr< rtc::IVideoMixerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
Optional< bool > allowBluetooth
Definition: IAgoraService.h:255
Definition: AgoraAtomicOps.h:21
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaPlayerAudioTrack(agora_refptr< rtc::IMediaPlayerSource > audioSource)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioEncodedFrameSender > audioSource, TMixMode mixMode)=0
Optional< bool > playbackAndRecord
Definition: IAgoraService.h:199
TMixMode
Definition: IAgoraService.h:343
bool operator!=(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:330
@ MIX_ENABLED
Definition: IAgoraService.h:347
bool domainLimit
Definition: IAgoraService.h:165
bool enableVideo
Definition: IAgoraService.h:105
Optional< rtc::THREAD_PRIORITY_TYPE > threadPriority __deprecated
Definition: IAgoraService.h:151
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:267
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer > screen, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createScreenCaptureAudioTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
Definition: NGIAgoraSyncClient.h:72
virtual agora::commons::ILogWriter * releaseLogWriter()=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoEncodedImageSender > videoSource, const rtc::SenderOptions &options, const char *id=OPTIONAL_NULLPTR)=0
Definition: IAgoraService.h:186
virtual int initialize(const AgoraServiceConfiguration &config)=0
virtual int setAudioSessionConfiguration(const AudioSessionConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual agora_refptr< rtc::IConfigCenter > getConfigCenter()=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCameraVideoTrack(agora_refptr< rtc::ICameraCapturer > 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 int getAudioSessionConfiguration(AudioSessionConfiguration *config)=0
bool operator==(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:316
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario, aosl_ref_t ares=AOSL_REF_INVALID)=0
AgoraServiceConfiguration()
Definition: IAgoraService.h:167
virtual agora_refptr< rtc::IRtmpConnection > createRtmpConnection(const rtc::RtmpConnectionConfiguration &cfg)=0
virtual agora_refptr< rtc::IMediaNodeFactory > createMediaNodeFactory()=0
virtual agora_refptr< rtc::IAudioDeviceManager > createAudioDeviceManagerComponent(rtc::IAudioDeviceManagerObserver *observer)=0
virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType)
Definition: IAgoraService.h:365
@ AUDIO_PROFILE_DEFAULT
Definition: AgoraBase.h:2580
Definition: IAgoraLog.h:83
AUDIO_PROFILE_TYPE audioProfile
Definition: IAgoraService.h:61
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IMediaPacketSender > source)=0
virtual agora_refptr< base::IAgoraParameter > getAgoraParameter()=0
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaStreamingAudioTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0
@ MIX_DISABLED
Definition: IAgoraService.h:351
Optional< double > sampleRate
Definition: IAgoraService.h:274
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource, bool enableAec)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoFrameSender > videoSource, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createDirectCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
virtual int32_t setLogWriter(agora::commons::ILogWriter *logWriter)=0
Definition: NGIAgoraAudioDeviceManager.h:91
Optional< int > category
Definition: IAgoraService.h:295
CONFIG_FETCH_TYPE
Definition: AgoraBase.h:6276
Definition: NGIAgoraRtcConnection.h:89
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IRemoteAudioMixerSource > audioSource)=0
PERMISSION_TYPE
Definition: AgoraBase.h:5941
virtual agora_refptr< rtc::IRtcConnection > createRtcConnection(const rtc::RtcConnectionConfiguration &cfg)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec, bool overlap)=0
commons::LogConfig logConfig
Definition: IAgoraService.h:138
const char * license
Definition: IAgoraService.h:129
virtual int removeExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
bool useStringUid
Definition: IAgoraService.h:142
Optional< double > ioBufferDuration
Definition: IAgoraService.h:281
virtual agora_refptr< rtc::IMediaRelayService > createMediaRelayService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
Optional< bool > allowDuckOthers
Definition: IAgoraService.h:244
virtual int setLogFile(const char *filePath, unsigned int fileSize, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setLogFilter(unsigned int filters, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaStreamingVideoTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource, const char *id=OPTIONAL_NULLPTR)=0
Optional< bool > defaultToSpeaker
Definition: IAgoraService.h:217
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:134
bool useExternalEglContext
Definition: IAgoraService.h:158
Definition: IAgoraService.h:57
void SetAll(const AudioSessionConfiguration &change)
Definition: IAgoraService.h:298
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
Definition: NGIAgoraSyncClient.h:83
virtual agora_refptr< rtc::ILocalVideoTrack > createTranscodedVideoTrack(agora_refptr< rtc::IVideoFrameTransceiver > transceiver, const char *id=OPTIONAL_NULLPTR)=0
virtual int loadExtensionProvider(const char *path, bool unload_after_use=false)=0
load the dynamic library of the extension
virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char *description)
Definition: IAgoraService.h:370
Definition: NGIAgoraDataChannel.h:18
Optional< bool > overrideSpeaker
Definition: IAgoraService.h:226
virtual const char * getExtensionId(const char *provider_name, const char *extension_name)=0
Get the ID of the registered extension.
unsigned int areaCode
Definition: IAgoraService.h:120
virtual void onFetchConfigResult(int code, rtc::CONFIG_FETCH_TYPE configType, const char *configContent)
Definition: IAgoraService.h:382
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
Definition: video_node_i.h:28
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraService.h:124
virtual int atExit(aosl_ref_t ares=AOSL_REF_INVALID)=0
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:279