Agora C++ API Reference for All Platforms
|
13 #include "AgoraBase.h"
14 #include "api2/NGIAgoraAudioDeviceManager.h"
15 #include "api2/NGIAgoraExtensionProvider.h"
16 #include "api2/AgoraRefCountedObject.h"
17 #include "api2/NGIAgoraRtcConnection.h"
18 #include "IAgoraRtcEngineEx.h"
19 #include "rtc/rtc_event.h"
20 #include "utils/thread/thread_pool.h"
21 #include "main/extension_event_handler.h"
22 #include "base/time_utils.h"
25 extern HINSTANCE GetCurrentModuleInstance();
26 #elif defined(__ANDROID__) || defined(__linux__)
36 struct network_info_t;
50 struct VideoNetOptions;
52 struct CmdInjectStreamConfig;
61 #ifdef INTERNAL_ENGINE_STATUS
72 #endif // INTERNAL_ENGINE_STATUS
182 #if defined(P2P_SWITCH_DEFAULT_VALUE)
194 #if defined(P2P_SWITCH_DEFAULT_VALUE)
218 virtual bool onEvent(RTC_EVENT evt, std::string* payload) {
246 #if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IOS)
248 #endif // __APPLE__ && !TARGET_OS_IOS && TARGET_OS_MAC
250 virtual int printLog(
int level,
const char* message) = 0;
285 #if defined(FEATURE_ENABLE_UT_SUPPORT)
301 typedef const char*(AGORA_CALL* PFN_GetAgoraRtcEngineVersion)(
int* build);
302 typedef IRtcEngine*(AGORA_CALL* PFN_CreateAgoraRtcEngine)();
303 typedef void(AGORA_CALL* PFN_ShutdownAgoraRtcEngineService)();
306 typedef HINSTANCE lib_handle_t;
307 static HINSTANCE MyLoadLibrary(
const char* dllname) {
309 GetModuleFileNameA(GetCurrentModuleInstance(), path, MAX_PATH);
310 auto p = strrchr(path,
'\\');
311 strcpy(p + 1, dllname);
312 HINSTANCE hDll = LoadLibraryA(path);
313 if (hDll)
return hDll;
315 hDll = LoadLibraryA(dllname);
319 typedef void* lib_handle_t;
327 m_pfnCreateAgoraRtcEngine(nullptr),
328 m_pfnGetAgoraRtcEngineVersion(nullptr) {}
335 if (m_dllName.empty()) {
341 m_lib = MyLoadLibrary(m_dllName.c_str());
343 m_pfnCreateAgoraRtcEngine =
344 (PFN_CreateAgoraRtcEngine)GetProcAddress(m_lib,
"createAgoraRtcEngine");
345 m_pfnGetAgoraRtcEngineVersion =
346 (PFN_GetAgoraRtcEngineVersion)GetProcAddress(m_lib,
"getAgoraRtcEngineVersion");
348 #elif defined(__ANDROID__) || defined(__linux__)
349 m_lib = dlopen(m_dllName.c_str(), RTLD_LAZY);
351 m_pfnCreateAgoraRtcEngine = (PFN_CreateAgoraRtcEngine)dlsym(m_lib,
"createAgoraRtcEngine");
352 m_pfnGetAgoraRtcEngineVersion =
353 (PFN_GetAgoraRtcEngineVersion)dlsym(m_lib,
"getAgoraRtcEngineVersion");
364 #elif defined(__ANDROID__) || defined(__linux__)
371 m_pfnCreateAgoraRtcEngine =
nullptr;
372 m_pfnGetAgoraRtcEngineVersion =
nullptr;
377 bool isValid() {
return m_pfnCreateAgoraRtcEngine != NULL; }
380 return m_pfnCreateAgoraRtcEngine ? m_pfnCreateAgoraRtcEngine() : NULL;
384 return m_pfnGetAgoraRtcEngineVersion ? m_pfnGetAgoraRtcEngineVersion(build) :
nullptr;
390 std::string m_dllName;
391 PFN_CreateAgoraRtcEngine m_pfnCreateAgoraRtcEngine;
392 PFN_GetAgoraRtcEngineVersion m_pfnGetAgoraRtcEngineVersion;
417 #define NUM_OF_LAYOUT_REGIONS 17
virtual int soundPositionChannel(uid_t uid, const RtcConnection &connection)=0
int recfreq
Definition: rtc_engine_i.h:63
virtual int getVideoConfigParam(char *params, size_t size)=0
Definition: rtc_engine_i.h:300
agora::commons::cjson::JsonWrapper any_document_t
Definition: agora_service_i.h:52
unsigned int ts
Definition: rtc_engine_i.h:153
@ APP_TYPE_RUST
Definition: rtc_engine_i.h:138
virtual int reportRecordingArgusEvent(uint32_t *eventIds, int64_t *value, int count, RecordingEventType eventType)=0
@ APP_TYPE_UNITY
Definition: rtc_engine_i.h:129
@ APP_TYPE_APICLOUD
Definition: rtc_engine_i.h:134
user_id_t userId
Definition: rtc_engine_i.h:207
virtual const char * eventHandlerType() const
Definition: rtc_engine_i.h:216
IRtcEngineEventHandler * eventHandler
Definition: IAgoraRtcEngine.h:2931
Definition: rtc_engine_i.h:206
RecordingEventKeyIndex
Definition: rtc_engine_i.h:83
Definition: rtc_engine_i.h:144
virtual base::NtpTime getNtpTime()=0
Definition: AgoraRefPtr.h:44
virtual int setProfile(const char *profile, bool merge)=0
@ RECORDING_JOIN_EVT_MAX
Definition: rtc_engine_i.h:109
virtual void onVideoTransportPacketInfo(const video_transport_packet_info &info)=0
virtual int runOnWorkerThread(std::function< void(void)> &&f)=0
@ SCREEN_SHARING_NORMAL
Definition: rtc_engine_i.h:59
double x
Definition: rtc_engine_i.h:406
unsigned int frame_num
Definition: rtc_engine_i.h:146
region_info regions[NUM_OF_LAYOUT_REGIONS]
Definition: rtc_engine_i.h:424
Definition: rtc_engine_i.h:165
@ RECORDING_JOIN_EVT_MAXUDPPORT
Definition: rtc_engine_i.h:93
virtual int setAudioSessionParams(const char *params)=0
Definition: common_defines.h:11
virtual int printLog(int level, const char *message)=0
Definition: time_utils.h:13
uid_t uid
Definition: rtc_engine_i.h:145
@ RECORDING_LEAVE_EVT_RESERVE5
Definition: rtc_engine_i.h:118
int audio_send_frame_rate
Definition: rtc_engine_i.h:65
INTERFACE_ID_EX_TYPE
Definition: rtc_engine_i.h:55
int delay
Definition: rtc_engine_i.h:208
Definition: IAgoraRtcEngineEx.h:42
virtual int setMediaRecorderObserver(const RtcConnection &connection, media::IMediaRecorderObserver *observer, int sys_version=0)=0
@ RECORDING_JOIN_EVT_LANGUAGE
Definition: rtc_engine_i.h:103
@ RECORDING_EVENT_UNKNOWN
virtual int soundPositionChannel(uid_t uid)=0
const char * getVersion(int *build)
Definition: rtc_engine_i.h:383
@ APP_TYPE_C_SHARP
Definition: rtc_engine_i.h:139
const char * user_id_t
Definition: AgoraBase.h:798
virtual int setParametersInternal(const char *parameters)=0
unsigned int sent_ts
Definition: rtc_engine_i.h:147
Definition: AgoraBase.h:1700
@ APP_TYPE_CEF
Definition: rtc_engine_i.h:140
double height
Definition: rtc_engine_i.h:409
int bgcolor
Definition: rtc_engine_i.h:400
virtual int setCameraDevice(const char dev_id[MAX_DEVICE_ID_LENGTH])=0
Definition: rtc_engine_i.h:214
@ RECORDING_JOIN_EVT_RESERVE1
Definition: rtc_engine_i.h:104
@ APP_TYPE_NATIVE
Definition: rtc_engine_i.h:127
canvas_info canvas
Definition: rtc_engine_i.h:421
Definition: rtc_engine_i.h:419
virtual bool onEvent(RTC_EVENT evt, std::string *payload)
Definition: rtc_engine_i.h:218
@ APP_TYPE_COCOS
Definition: rtc_engine_i.h:128
@ RECORDING_JOIN_EVT_MIXMODE
Definition: rtc_engine_i.h:86
int audio_recv_packet_rate
Definition: rtc_engine_i.h:67
agora_refptr< IMediaExtensionObserver > extensionObserver
Definition: rtc_engine_i.h:170
Definition: rtc_engine_i.h:157
Definition: AgoraRefCountedObject.h:63
Definition: rtc_engine_i.h:397
Definition: AgoraAtomicOps.h:21
@ RECORDING_JOIN_EVT_AUDIOONLY
Definition: rtc_engine_i.h:98
@ APP_TYPE_UNI_APP
Definition: rtc_engine_i.h:141
@ RECORDING_JOIN_EVT_LIVEMODE
Definition: rtc_engine_i.h:96
int render_mode
Definition: rtc_engine_i.h:413
unsigned int sent_ts
Definition: rtc_engine_i.h:154
int sentFrameRate
Definition: rtc_engine_i.h:209
@ SCREEN_SHARING_MOVIE
Definition: rtc_engine_i.h:59
virtual int32_t setAppType(APP_TYPE appType)=0
@ RECORDING_JOIN_EVT_TRIGGERMODE
Definition: rtc_engine_i.h:102
virtual int stopRecording(const RtcConnection &connection)=0
virtual int enableYuvDumper(bool enable)=0
virtual void onAudioTransportPacketInfo(const audio_transport_packet_info &info)=0
@ RECORDING_JOIN_EVT_MIXEDVIDEOAUDIOMODE
Definition: rtc_engine_i.h:87
SCREEN_SHARING_MODE
Definition: rtc_engine_i.h:59
virtual int GetScreenCaptureType()=0
@ RECORDING_JOIN_EVT_IDLE
Definition: rtc_engine_i.h:97
virtual int reportArgusCounters(int *counterId, int *value, int count, uid_t uid)=0
virtual ~IParameterEngine()
Definition: rtc_engine_i.h:45
Definition: rtc_engine_i.h:62
virtual int reportWebAgentVideoStats(const WebAgentVideoStats &stats)=0
@ RECORDING_JOIN_EVT_DECODEAUDIOTYPE
Definition: rtc_engine_i.h:94
virtual ~IRtcEngineInternal()
Definition: rtc_engine_i.h:230
@ RECORDING_JOIN_EVT_MIXHIGH
Definition: rtc_engine_i.h:88
int audio_send_packet_rate
Definition: rtc_engine_i.h:66
Definition: rtc_engine_i.h:228
int maxOutputBitrateKpbs
Definition: rtc_engine_i.h:167
virtual int releaseRecorder()=0
@ APP_TYPE_COCOS_CREATOR
Definition: rtc_engine_i.h:137
@ RECORDING_JOIN_EVT_START
Definition: rtc_engine_i.h:85
@ APP_TYPE_FLUTTER
Definition: rtc_engine_i.h:131
unsigned int ts
Definition: rtc_engine_i.h:148
virtual int setLogLevelEx(unsigned int filter)=0
int skippedFrames
Definition: rtc_engine_i.h:211
void deinitialize()
Definition: rtc_engine_i.h:360
Definition: IAgoraRtcEngineEx.h:20
int farin_signal_level
Definition: rtc_engine_i.h:70
Definition: IAgoraRtcEngineEx.h:1033
int alpha
Definition: rtc_engine_i.h:411
@ RECORDING_JOIN_EVT_MINUDPPORT
Definition: rtc_engine_i.h:92
virtual int simulateOnSetParameters(const std::string ¶meters)=0
virtual int setExternalVideoConfigEx(const VideoEncoderConfiguration &config, const RtcConnection &connection)=0
virtual int setAudioOptionParams(const char *params)=0
bool isPassThruMode
Definition: rtc_engine_i.h:166
virtual int setExternalVideoConfigEx(const VideoEncoderConfiguration &config)=0
@ RECORDING_JOIN_EVT_VIDEOONLY
Definition: rtc_engine_i.h:99
agora::rtc::IRtcEngine * createEngine()
Definition: rtc_engine_i.h:379
long long ms
Definition: rtc_engine_i.h:420
virtual int initializeEx(const RtcEngineContextInternal &context)=0
int renderedFrameRate
Definition: rtc_engine_i.h:210
unsigned id
Definition: rtc_engine_i.h:404
AGORA_API bool AGORA_CALL decode_sei_layout(const void *data, unsigned size, layout_info *layout)
@ RECORDING_JOIN_EVT_MIXKBPS
Definition: rtc_engine_i.h:91
@ RECORDING_JOIN_EVT_SYSLOGFACILITY
Definition: rtc_engine_i.h:100
@ AGORA_IID_RTC_ENGINE_EX
Definition: rtc_engine_i.h:56
@ RECORDING_LEAVE_EVT_START
Definition: rtc_engine_i.h:112
double width
Definition: rtc_engine_i.h:408
Definition: rtc_engine_i.h:403
bool initialize()
Definition: rtc_engine_i.h:330
int height
Definition: rtc_engine_i.h:399
Definition: rtc_engine_i.h:41
virtual int startRecording(const RtcConnection &connection, const media::MediaRecorderConfiguration &config)=0
RecordingEventType
Definition: rtc_engine_i.h:74
@ RECORDING_LEAVE_EVT_LEAVEPATHCODE
Definition: rtc_engine_i.h:113
@ APP_TYPE_REACT_NATIVE
Definition: rtc_engine_i.h:135
~RtcEngineLibHelper()
Definition: rtc_engine_i.h:375
int zorder
Definition: rtc_engine_i.h:414
int playoutfreq
Definition: rtc_engine_i.h:64
virtual agora_refptr< IMediaPlayer > getMediaPlayer(int sourceId)=0
virtual void SetScreenCaptureSource(bool allow_magnification_api, bool allow_directx_capturer)=0
Definition: IAgoraRtcEngine.h:2927
bool isValid()
Definition: rtc_engine_i.h:377
Definition: IAgoraRtcEngine.h:3339
uid_t uid
Definition: rtc_engine_i.h:152
virtual int getProfile(any_document_t &result)=0
@ APP_TYPE_ELECTRON
Definition: rtc_engine_i.h:130
@ RECORDING_JOIN_EVT_MIXFPS
Definition: rtc_engine_i.h:90
virtual ~IRtcAvTransportPacketInfoObserver()=default
bool is_p2p_switch_enabled_
Definition: rtc_engine_i.h:175
@ RECORDING_JOIN_EVT_DECODEVIDEOTYPE
Definition: rtc_engine_i.h:95
@ APP_TYPE_INVALID_VALUE
Definition: rtc_engine_i.h:126
int width
Definition: rtc_engine_i.h:398
virtual int getParameters(const char *key, any_document_t &result)=0
virtual int monitorDeviceChange(bool enabled)=0
Definition: rtc_engine_i.h:151
APP_TYPE
Definition: rtc_engine_i.h:125
unsigned int uid_t
Definition: AgoraMediaBase.h:29
virtual int getAudioSessionParams(char *params)=0
@ RECORDING_LEAVE_EVT_RESERVE1
Definition: rtc_engine_i.h:114
virtual agora_refptr< IRtcConnection > getConnection(const RtcConnection &connection={}) const =0
double y
Definition: rtc_engine_i.h:407
virtual int getAudioOptionParams(char *params)=0
@ APP_TYPE_PYTHON
Definition: rtc_engine_i.h:136
virtual bool isMicrophoneOn()=0
int nearout_signal_level
Definition: rtc_engine_i.h:69
@ RECORDING_JOIN_EVT_STREAMTYPE
Definition: rtc_engine_i.h:101
virtual int setVideoConfigParam(const char *params)=0
unsigned int region_count
Definition: rtc_engine_i.h:423
RtcEngineLibHelper(const char *dllname)
Definition: rtc_engine_i.h:323
@ MAX_RECORDING_JOIN_EVT_RESERVE15
Definition: rtc_engine_i.h:108
Definition: video_node_i.h:25
@ APP_TYPE_XAMARIN
Definition: rtc_engine_i.h:133
virtual int notifyNetworkChange(agora::commons::network::network_info_t &&networkInfo)=0
@ RECORDING_LEAVE_EVT_MAX
Definition: rtc_engine_i.h:119
@ APP_TYPE_UNREAL
Definition: rtc_engine_i.h:132
@ RECORDING_JOIN_EVT_MIXLOW
Definition: rtc_engine_i.h:89
int nearin_signal_level
Definition: rtc_engine_i.h:68
virtual int getOptionsByVideoProfile(int profile, VideoNetOptions &options)=0
virtual int32_t enableVosUserInfoHidden(bool enabled)=0