|
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;
41 struct VideoNetOptions;
43 struct CmdInjectStreamConfig;
52 #ifdef INTERNAL_ENGINE_STATUS
63 #endif // INTERNAL_ENGINE_STATUS
191 #if defined(P2P_SWITCH_DEFAULT_VALUE)
203 #if defined(P2P_SWITCH_DEFAULT_VALUE)
227 virtual bool onEvent(RTC_EVENT evt, std::string* payload) {
255 #if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IOS)
257 #endif // __APPLE__ && !TARGET_OS_IOS && TARGET_OS_MAC
259 virtual int printLog(
int level,
const char* message) = 0;
295 #if defined(FEATURE_ENABLE_UT_SUPPORT)
311 typedef const char*(AGORA_CALL* PFN_GetAgoraRtcEngineVersion)(
int* build);
312 typedef IRtcEngine*(AGORA_CALL* PFN_CreateAgoraRtcEngine)();
313 typedef void(AGORA_CALL* PFN_ShutdownAgoraRtcEngineService)();
316 typedef HINSTANCE lib_handle_t;
317 static HINSTANCE MyLoadLibrary(
const char* dllname) {
319 GetModuleFileNameA(GetCurrentModuleInstance(), path, MAX_PATH);
320 auto p = strrchr(path,
'\\');
321 strcpy(p + 1, dllname);
322 HINSTANCE hDll = LoadLibraryA(path);
323 if (hDll)
return hDll;
325 hDll = LoadLibraryA(dllname);
329 typedef void* lib_handle_t;
337 m_pfnCreateAgoraRtcEngine(nullptr),
338 m_pfnGetAgoraRtcEngineVersion(nullptr) {}
345 if (m_dllName.empty()) {
351 m_lib = MyLoadLibrary(m_dllName.c_str());
353 m_pfnCreateAgoraRtcEngine =
354 (PFN_CreateAgoraRtcEngine)GetProcAddress(m_lib,
"createAgoraRtcEngine");
355 m_pfnGetAgoraRtcEngineVersion =
356 (PFN_GetAgoraRtcEngineVersion)GetProcAddress(m_lib,
"getAgoraRtcEngineVersion");
358 #elif defined(__ANDROID__) || defined(__linux__)
359 m_lib = dlopen(m_dllName.c_str(), RTLD_LAZY);
361 m_pfnCreateAgoraRtcEngine = (PFN_CreateAgoraRtcEngine)dlsym(m_lib,
"createAgoraRtcEngine");
362 m_pfnGetAgoraRtcEngineVersion =
363 (PFN_GetAgoraRtcEngineVersion)dlsym(m_lib,
"getAgoraRtcEngineVersion");
374 #elif defined(__ANDROID__) || defined(__linux__)
381 m_pfnCreateAgoraRtcEngine =
nullptr;
382 m_pfnGetAgoraRtcEngineVersion =
nullptr;
387 bool isValid() {
return m_pfnCreateAgoraRtcEngine != NULL; }
390 return m_pfnCreateAgoraRtcEngine ? m_pfnCreateAgoraRtcEngine() : NULL;
394 return m_pfnGetAgoraRtcEngineVersion ? m_pfnGetAgoraRtcEngineVersion(build) :
nullptr;
400 std::string m_dllName;
401 PFN_CreateAgoraRtcEngine m_pfnCreateAgoraRtcEngine;
402 PFN_GetAgoraRtcEngineVersion m_pfnGetAgoraRtcEngineVersion;
427 #define NUM_OF_LAYOUT_REGIONS 17
virtual int soundPositionChannel(uid_t uid, const RtcConnection &connection)=0
int recfreq
Definition: rtc_engine_i.h:54
virtual int getVideoConfigParam(char *params, size_t size)=0
Definition: rtc_engine_i.h:310
agora::commons::cjson::JsonWrapper any_document_t
Definition: agora_service_i.h:52
unsigned int ts
Definition: rtc_engine_i.h:162
@ APP_TYPE_RUST
Definition: rtc_engine_i.h:147
virtual int reportRecordingArgusEvent(uint32_t *eventIds, int64_t *value, int count, RecordingEventType eventType)=0
@ APP_TYPE_UNITY
Definition: rtc_engine_i.h:138
@ APP_TYPE_APICLOUD
Definition: rtc_engine_i.h:143
@ AUDIO_SOURCE_LOOPBACK
Definition: rtc_engine_i.h:74
user_id_t userId
Definition: rtc_engine_i.h:216
virtual const char * eventHandlerType() const
Definition: rtc_engine_i.h:225
IRtcEngineEventHandler * eventHandler
Definition: IAgoraRtcEngine.h:2577
Definition: rtc_engine_i.h:215
RecordingEventKeyIndex
Definition: rtc_engine_i.h:92
Definition: rtc_engine_i.h:153
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:118
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:50
double x
Definition: rtc_engine_i.h:416
unsigned int frame_num
Definition: rtc_engine_i.h:155
region_info regions[NUM_OF_LAYOUT_REGIONS]
Definition: rtc_engine_i.h:434
Definition: rtc_engine_i.h:174
@ RECORDING_JOIN_EVT_MAXUDPPORT
Definition: rtc_engine_i.h:102
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:154
@ RECORDING_LEAVE_EVT_RESERVE5
Definition: rtc_engine_i.h:127
int audio_send_frame_rate
Definition: rtc_engine_i.h:56
INTERFACE_ID_EX_TYPE
Definition: rtc_engine_i.h:46
int delay
Definition: rtc_engine_i.h:217
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:112
@ RECORDING_EVENT_UNKNOWN
virtual int soundPositionChannel(uid_t uid)=0
const char * getVersion(int *build)
Definition: rtc_engine_i.h:393
@ APP_TYPE_C_SHARP
Definition: rtc_engine_i.h:148
const char * user_id_t
Definition: AgoraBase.h:782
unsigned int sent_ts
Definition: rtc_engine_i.h:156
Definition: AgoraBase.h:1596
@ APP_TYPE_CEF
Definition: rtc_engine_i.h:149
double height
Definition: rtc_engine_i.h:419
int bgcolor
Definition: rtc_engine_i.h:410
virtual int setCameraDevice(const char dev_id[MAX_DEVICE_ID_LENGTH])=0
Definition: rtc_engine_i.h:223
@ RECORDING_JOIN_EVT_RESERVE1
Definition: rtc_engine_i.h:113
@ APP_TYPE_NATIVE
Definition: rtc_engine_i.h:136
canvas_info canvas
Definition: rtc_engine_i.h:431
Definition: rtc_engine_i.h:429
virtual bool onEvent(RTC_EVENT evt, std::string *payload)
Definition: rtc_engine_i.h:227
@ APP_TYPE_COCOS
Definition: rtc_engine_i.h:137
@ RECORDING_JOIN_EVT_MIXMODE
Definition: rtc_engine_i.h:95
int audio_recv_packet_rate
Definition: rtc_engine_i.h:58
agora_refptr< IMediaExtensionObserver > extensionObserver
Definition: rtc_engine_i.h:179
Definition: rtc_engine_i.h:166
Definition: AgoraRefCountedObject.h:63
Definition: rtc_engine_i.h:407
Definition: AgoraAtomicOps.h:21
@ RECORDING_JOIN_EVT_AUDIOONLY
Definition: rtc_engine_i.h:107
@ APP_TYPE_UNI_APP
Definition: rtc_engine_i.h:150
@ RECORDING_JOIN_EVT_LIVEMODE
Definition: rtc_engine_i.h:105
virtual int addInjectStreamUrl2(const char *url, protocol::CmdInjectStreamConfig &config)=0
int render_mode
Definition: rtc_engine_i.h:423
unsigned int sent_ts
Definition: rtc_engine_i.h:163
int sentFrameRate
Definition: rtc_engine_i.h:218
@ SCREEN_SHARING_MOVIE
Definition: rtc_engine_i.h:50
virtual int32_t setAppType(APP_TYPE appType)=0
@ RECORDING_JOIN_EVT_TRIGGERMODE
Definition: rtc_engine_i.h:111
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:96
SCREEN_SHARING_MODE
Definition: rtc_engine_i.h:50
virtual int GetScreenCaptureType()=0
@ RECORDING_JOIN_EVT_IDLE
Definition: rtc_engine_i.h:106
virtual int reportArgusCounters(int *counterId, int *value, int count, uid_t uid)=0
Definition: rtc_engine_i.h:53
virtual int reportWebAgentVideoStats(const WebAgentVideoStats &stats)=0
@ RECORDING_JOIN_EVT_DECODEAUDIOTYPE
Definition: rtc_engine_i.h:103
AUDIO_SOURCE_TYPE
Definition: rtc_engine_i.h:68
virtual ~IRtcEngineInternal()
Definition: rtc_engine_i.h:239
@ RECORDING_JOIN_EVT_MIXHIGH
Definition: rtc_engine_i.h:97
int audio_send_packet_rate
Definition: rtc_engine_i.h:57
Definition: rtc_engine_i.h:237
int maxOutputBitrateKpbs
Definition: rtc_engine_i.h:176
virtual int releaseRecorder()=0
@ APP_TYPE_COCOS_CREATOR
Definition: rtc_engine_i.h:146
@ RECORDING_JOIN_EVT_START
Definition: rtc_engine_i.h:94
@ APP_TYPE_FLUTTER
Definition: rtc_engine_i.h:140
unsigned int ts
Definition: rtc_engine_i.h:157
virtual int setLogLevelEx(unsigned int filter)=0
int skippedFrames
Definition: rtc_engine_i.h:220
void deinitialize()
Definition: rtc_engine_i.h:370
Definition: IAgoraRtcEngineEx.h:20
@ AUDIO_SOURCE_EXTERNAL_AEC
Definition: rtc_engine_i.h:77
int farin_signal_level
Definition: rtc_engine_i.h:61
Definition: IAgoraRtcEngineEx.h:857
int alpha
Definition: rtc_engine_i.h:421
@ RECORDING_JOIN_EVT_MINUDPPORT
Definition: rtc_engine_i.h:101
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:175
virtual int setExternalVideoConfigEx(const VideoEncoderConfiguration &config)=0
@ RECORDING_JOIN_EVT_VIDEOONLY
Definition: rtc_engine_i.h:108
agora::rtc::IRtcEngine * createEngine()
Definition: rtc_engine_i.h:389
long long ms
Definition: rtc_engine_i.h:430
virtual int initializeEx(const RtcEngineContextInternal &context)=0
int renderedFrameRate
Definition: rtc_engine_i.h:219
unsigned id
Definition: rtc_engine_i.h:414
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:100
@ RECORDING_JOIN_EVT_SYSLOGFACILITY
Definition: rtc_engine_i.h:109
@ AGORA_IID_RTC_ENGINE_EX
Definition: rtc_engine_i.h:47
@ RECORDING_LEAVE_EVT_START
Definition: rtc_engine_i.h:121
double width
Definition: rtc_engine_i.h:418
Definition: rtc_engine_i.h:413
bool initialize()
Definition: rtc_engine_i.h:340
int height
Definition: rtc_engine_i.h:409
Definition: AgoraBase.h:97
virtual int startRecording(const RtcConnection &connection, const media::MediaRecorderConfiguration &config)=0
RecordingEventType
Definition: rtc_engine_i.h:83
@ RECORDING_LEAVE_EVT_LEAVEPATHCODE
Definition: rtc_engine_i.h:122
@ APP_TYPE_REACT_NATIVE
Definition: rtc_engine_i.h:144
~RtcEngineLibHelper()
Definition: rtc_engine_i.h:385
int zorder
Definition: rtc_engine_i.h:424
int playoutfreq
Definition: rtc_engine_i.h:55
virtual agora_refptr< IMediaPlayer > getMediaPlayer(int sourceId)=0
virtual void SetScreenCaptureSource(bool allow_magnification_api, bool allow_directx_capturer)=0
Definition: IAgoraRtcEngine.h:2573
bool isValid()
Definition: rtc_engine_i.h:387
Definition: IAgoraRtcEngine.h:2923
uid_t uid
Definition: rtc_engine_i.h:161
virtual int getProfile(any_document_t &result)=0
@ APP_TYPE_ELECTRON
Definition: rtc_engine_i.h:139
@ RECORDING_JOIN_EVT_MIXFPS
Definition: rtc_engine_i.h:99
@ AUDIO_SOURCE_MICROPHONE
Definition: rtc_engine_i.h:71
virtual ~IRtcAvTransportPacketInfoObserver()=default
bool is_p2p_switch_enabled_
Definition: rtc_engine_i.h:184
@ RECORDING_JOIN_EVT_DECODEVIDEOTYPE
Definition: rtc_engine_i.h:104
@ APP_TYPE_INVALID_VALUE
Definition: rtc_engine_i.h:135
int width
Definition: rtc_engine_i.h:408
virtual int monitorDeviceChange(bool enabled)=0
Definition: rtc_engine_i.h:160
APP_TYPE
Definition: rtc_engine_i.h:134
unsigned int uid_t
Definition: AgoraMediaBase.h:29
virtual int getAudioSessionParams(char *params)=0
@ RECORDING_LEAVE_EVT_RESERVE1
Definition: rtc_engine_i.h:123
virtual agora_refptr< IRtcConnection > getConnection(const RtcConnection &connection={}) const =0
double y
Definition: rtc_engine_i.h:417
virtual int getAudioOptionParams(char *params)=0
@ APP_TYPE_PYTHON
Definition: rtc_engine_i.h:145
virtual bool isMicrophoneOn()=0
int nearout_signal_level
Definition: rtc_engine_i.h:60
@ RECORDING_JOIN_EVT_STREAMTYPE
Definition: rtc_engine_i.h:110
virtual int setVideoConfigParam(const char *params)=0
unsigned int region_count
Definition: rtc_engine_i.h:433
@ AUDIO_SOURCE_TYPE_COUNT
Definition: rtc_engine_i.h:80
RtcEngineLibHelper(const char *dllname)
Definition: rtc_engine_i.h:333
@ MAX_RECORDING_JOIN_EVT_RESERVE15
Definition: rtc_engine_i.h:117
Definition: video_node_i.h:25
@ APP_TYPE_XAMARIN
Definition: rtc_engine_i.h:142
virtual int notifyNetworkChange(agora::commons::network::network_info_t &&networkInfo)=0
@ RECORDING_LEAVE_EVT_MAX
Definition: rtc_engine_i.h:128
@ APP_TYPE_UNREAL
Definition: rtc_engine_i.h:141
@ RECORDING_JOIN_EVT_MIXLOW
Definition: rtc_engine_i.h:98
int nearin_signal_level
Definition: rtc_engine_i.h:59
virtual int getOptionsByVideoProfile(int profile, VideoNetOptions &options)=0
virtual int32_t enableVosUserInfoHidden(bool enabled)=0