NERtc UE SDK  V5.4.109
INertcEngineEventHandler.h
1 
8 #pragma once
9 
10 #include "NertcBaseTypes.h"
11 #include "NertcEngineDefines.h"
12 #include "NertcErrorCode.h"
13 #include "NertcWarnCode.h"
14 
19 namespace nertc {
35  public:
36  virtual ~IRtcEngineEventHandler() {}
37 
54  virtual void onError(int error_code, const char* msg) {
55  (void)error_code;
56  (void)msg;
57  }
58 
74  virtual void onWarning(int warn_code, const char* msg) {
75  (void)warn_code;
76  (void)msg;
77  }
94  virtual void onApiCallExecuted(const char* api_name, NERtcErrorCode error_code, const char* msg) {
95  (void)api_name;
96  (void)error_code;
97  (void)msg;
98  };
99 
112  virtual void onReleasedHwResources(NERtcErrorCode result) { (void)result; }
113 
132  virtual void onJoinChannel(channel_id_t cid, uid_t uid, NERtcErrorCode result, uint64_t elapsed) {
133  (void)cid;
134  (void)uid;
135  (void)result;
136  (void)elapsed;
137  }
138 
154  virtual void onReconnectingStart(channel_id_t cid, uid_t uid) {
155  (void)cid;
156  (void)uid;
157  }
158 
175  (void)state;
176  (void)reason;
177  }
190  virtual void onNetworkTypeChanged(NERtcNetworkType new_type) {
191  (void)new_type;
192  };
212  virtual void onRejoinChannel(channel_id_t cid, uid_t uid, NERtcErrorCode result, uint64_t elapsed) {
213  (void)cid;
214  (void)uid;
215  (void)result;
216  (void)elapsed;
217  }
218 
232  virtual void onLeaveChannel(NERtcErrorCode result, uint64_t channel_id) {
233  (void)result;
234  (void)channel_id;
235 }
236 
255  virtual void onDisconnect(NERtcErrorCode reason) { (void)reason; }
256 
284  virtual void onClientRoleChanged(NERtcClientRole oldRole, NERtcClientRole newRole) {
285  (void)oldRole;
286  (void)newRole;
287  }
288 
307  virtual void onUserJoined(uid_t uid, const char* user_name, const NERtcUserJoinExtraInfo& custom_info) {
308  (void)uid;
309  (void)user_name;
310  (void)custom_info;
311  }
312 
335  virtual void onUserLeft(uid_t uid, NERtcSessionLeaveReason reason, const NERtcUserJoinExtraInfo& custom_info) {
336  (void)uid;
337  (void)reason;
338  (void)custom_info;
339  }
351  virtual void onUserAudioStart(NERtcAudioStreamType type, uid_t uid) {
352  (void)type;
353  (void)uid;
354  }
365  virtual void onUserAudioStop(NERtcAudioStreamType type, uid_t uid) {
366  (void)type;
367  (void)uid;
368  }
382  virtual void onUserVideoStart(NERtcVideoStreamType type, uid_t uid, NERtcVideoProfileType max_profile) {
383  (void)type;
384  (void)uid;
385  (void)max_profile;
386  }
398  virtual void onUserVideoStop(NERtcVideoStreamType type, uid_t uid) {
399  (void)type;
400  (void)uid;
401 }
416  virtual void onScreenCaptureStatusChanged(NERtcScreenCaptureStatus status) {(void)status;}
428  virtual void onUserVideoProfileUpdate(uid_t uid, NERtcVideoProfileType max_profile) {
429  (void)uid;
430  (void)max_profile;
431  }
445  virtual void onUserAudioMute(NERtcAudioStreamType stream_type, uid_t uid, bool mute) {
446  (void)stream_type;
447  (void)uid;
448  (void)mute;
449  }
463  virtual void onUserVideoMute(NERtcVideoStreamType stream_type, uid_t uid, bool mute){
464  (void)stream_type;
465  (void)uid;
466  (void)mute;
467  }
479  (void)routing;
480  }
495  virtual void onAudioDeviceStateChanged(const char* device_id,NERtcAudioDeviceType device_type, NERtcAudioDeviceState device_state) {
496  (void)device_id;
497  (void)device_type;
498  (void)device_state;
499  }
512  virtual void onAudioDefaultDeviceChanged(const char* device_id, NERtcAudioDeviceType device_type){
513  (void)device_id;
514  (void)device_type;
515  }
530  virtual void onVideoDeviceStateChanged(const char* device_id,NERtcVideoDeviceType device_type,NERtcVideoDeviceState device_state){
531  (void)device_id;
532  (void)device_type;
533  (void)device_state;
534  }
553  (void)info;
554  }
571  (void)info;
572  }
585  (void)type;
586  (void)uid;
587  }
602  (void)uid;
603  (void)type;
604  }
616  (void)type;
617  (void)uid;
618  }
636  virtual void onFirstVideoFrameDecoded(NERtcVideoStreamType type, uid_t uid, uint32_t width, uint32_t height){
637  (void)type;
638  (void)uid;
639  (void)width;
640  (void)height;
641  }
668  void* data,
669  NERtcVideoType type,
670  uint32_t width,
671  uint32_t height,
672  uint32_t count,
673  uint32_t* offset,
674  uint32_t* stride,
675  NERtcVideoRotation rotation){
676  (void)data;
677  (void)type;
678  (void)width;
679  (void)height;
680  (void)count;
681  (void)offset;
682  (void)stride;
683  (void)rotation;
684  }
711  (void)state;
712  (void)error_code;
713  }
727  virtual void onAudioMixingTimestampUpdate(uint64_t timestamp_ms){
728  (void)timestamp_ms;
729  }
764  virtual void onAudioEffectTimestampUpdate(uint32_t effect_id, uint64_t timestamp_ms){
765  (void)effect_id;
766  (void)timestamp_ms;
767  }
780  virtual void onAudioEffectFinished(uint32_t effect_id){
781  (void)effect_id;
782  }
801  virtual void onLocalAudioVolumeIndication(int volume, bool enable_vad){
802  (void)volume;
803  (void)enable_vad;
804  }
831  virtual void onRemoteAudioVolumeIndication(const NERtcAudioVolumeInfo* speakers,uint32_t speaker_number,int total_volume){
832  (void)speakers;
833  (void)speaker_number;
834  (void)total_volume;
835  }
858  virtual void onAddLiveStreamTask(const char* task_id, const char* url, int error_code) {
859  (void)task_id;
860  (void)url;
861  (void)error_code;
862  }
885  virtual void onUpdateLiveStreamTask(const char* task_id, const char* url, int error_code){
886  (void)task_id;
887  (void)url;
888  (void)error_code;
889  }
910  virtual void onRemoveLiveStreamTask(const char* task_id, int error_code){
911  (void)task_id;
912  (void)error_code;
913  }
936  virtual void onLiveStreamStateChanged(const char* task_id, const char* url, NERtcLiveStreamStateCode state){
937  (void)task_id;
938  (void)url;
939  (void)state;
940  }
967  virtual void onAudioHowling(bool howling){
968  (void)howling;
969  }
986  virtual void onRecvSEIMsg(uid_t uid, const uint8_t* data, uint32_t dataSize){
987  (void)uid;
988  (void)data;
989  (void)dataSize;
990  }
1003  virtual void onAudioRecording(NERtcAudioRecordingCode code, const char* file_path){
1004  (void)code;
1005  (void)file_path;
1006  }
1021  virtual void onMediaRelayStateChanged(NERtcChannelMediaRelayState state, const char* channel_name){
1022  (void)state;
1023  (void)channel_name;
1024  }
1041  virtual void onMediaRelayEvent(NERtcChannelMediaRelayEvent event,const char* channel_name, NERtcErrorCode error){
1042  (void)event;
1043  (void)channel_name;
1044  (void)error;
1045  }
1070  virtual void onPublishFallbackToAudioOnly(bool is_fallback, NERtcVideoStreamType type){
1071  (void)is_fallback;
1072  (void)type;
1073  }
1102  virtual void onSubscribeFallbackToAudioOnly(uid_t uid, bool is_fallback, NERtcVideoStreamType type){
1103  (void)uid;
1104  (void)is_fallback;
1105  (void)type;
1106  }
1125  (void)quality;
1126  }
1146  virtual void onLastmileProbeResult(const NERtcLastmileProbeResult& result){
1147  (void)result;
1148  }
1171  virtual void onMediaRightChange(bool is_audio_banned, bool is_video_banned){
1172  (void)is_audio_banned;
1173  (void)is_video_banned;
1174  }
1188  (void)result;
1189  }
1190 
1217  (void)enabled;
1218  (void)reason;
1219  }
1220 
1238  (void)type;
1239  (void)state;
1240  }
1241 
1263  virtual void onPermissionKeyWillExpire(){}
1264 
1303  virtual void onUpdatePermissionKey(const char* key, NERtcErrorCode error, int timeout){
1304  (void)key;
1305  (void)error;
1306  (void)timeout;
1307  }
1308 
1324  virtual void onUserDataReceiveMessage(uid_t uid, const char* source_id, void* data, uint64_t size){
1325  (void)uid;
1326  (void)data;
1327  (void)size;
1328  }
1329 
1342  virtual void onUserDataStart(uid_t uid){
1343  (void)uid;
1344  }
1345 
1356  virtual void onUserDataStop(uid_t uid){
1357  (void)uid;
1358  }
1359 
1372  virtual void onUserDataStateChanged(uid_t uid, const char* source_id){
1373  (void)uid;
1374  (void)source_id;
1375  }
1376 
1391  virtual void onUserDataBufferedAmountChanged(uid_t uid, const char* source_id, uint64_t previous_amount){
1392  (void)uid;
1393  (void)source_id;
1394  (void)previous_amount;
1395  }
1396 };
1397 } // namespace nertc
The definition of error codes of NERtc SDK.
Definition: INertcEngineEventHandler.h:34
virtual void onUserVideoStop(NERtcVideoStreamType type, uid_t uid)
Definition: INertcEngineEventHandler.h:398
virtual void onPermissionKeyWillExpire()
Definition: INertcEngineEventHandler.h:1263
virtual void onUserDataStop(uid_t uid)
Definition: INertcEngineEventHandler.h:1356
virtual void onSubscribeFallbackToAudioOnly(uid_t uid, bool is_fallback, NERtcVideoStreamType type)
Definition: INertcEngineEventHandler.h:1102
virtual void onAudioMixingTimestampUpdate(uint64_t timestamp_ms)
Definition: INertcEngineEventHandler.h:727
virtual void onAudioEffectTimestampUpdate(uint32_t effect_id, uint64_t timestamp_ms)
Definition: INertcEngineEventHandler.h:764
virtual void onAudioMixingStateChanged(NERtcAudioMixingState state, NERtcAudioMixingErrorCode error_code)
Definition: INertcEngineEventHandler.h:710
virtual void onUserAudioStart(NERtcAudioStreamType type, uid_t uid)
Definition: INertcEngineEventHandler.h:351
virtual void onLocalAudioVolumeIndication(int volume, bool enable_vad)
Definition: INertcEngineEventHandler.h:801
virtual void onUserDataStateChanged(uid_t uid, const char *source_id)
Definition: INertcEngineEventHandler.h:1372
virtual void onMediaRightChange(bool is_audio_banned, bool is_video_banned)
Definition: INertcEngineEventHandler.h:1171
virtual void onAudioDeviceStateChanged(const char *device_id, NERtcAudioDeviceType device_type, NERtcAudioDeviceState device_state)
Definition: INertcEngineEventHandler.h:495
virtual void onScreenCaptureStatusChanged(NERtcScreenCaptureStatus status)
Definition: INertcEngineEventHandler.h:416
virtual void onJoinChannel(channel_id_t cid, uid_t uid, NERtcErrorCode result, uint64_t elapsed)
Definition: INertcEngineEventHandler.h:132
virtual void onUserDataStart(uid_t uid)
Definition: INertcEngineEventHandler.h:1342
virtual void onUserVideoProfileUpdate(uid_t uid, NERtcVideoProfileType max_profile)
Definition: INertcEngineEventHandler.h:428
virtual void onLocalVideoWatermarkState(NERtcVideoStreamType type, NERtcLocalVideoWatermarkState state)
Definition: INertcEngineEventHandler.h:1237
virtual void onAudioHowling(bool howling)
Definition: INertcEngineEventHandler.h:967
virtual void onUpdateLiveStreamTask(const char *task_id, const char *url, int error_code)
Definition: INertcEngineEventHandler.h:885
virtual void onClientRoleChanged(NERtcClientRole oldRole, NERtcClientRole newRole)
Definition: INertcEngineEventHandler.h:284
virtual void onCameraFocusChanged(const NERtcCameraFocusAndExposureInfo &info)
Definition: INertcEngineEventHandler.h:552
virtual void onFirstVideoFrameDecoded(NERtcVideoStreamType type, uid_t uid, uint32_t width, uint32_t height)
Definition: INertcEngineEventHandler.h:636
virtual void onUserVideoMute(NERtcVideoStreamType stream_type, uid_t uid, bool mute)
Definition: INertcEngineEventHandler.h:463
virtual void onAudioEffectFinished(uint32_t effect_id)
Definition: INertcEngineEventHandler.h:780
void onCaptureVideoFrame(void *data, NERtcVideoType type, uint32_t width, uint32_t height, uint32_t count, uint32_t *offset, uint32_t *stride, NERtcVideoRotation rotation)
Definition: INertcEngineEventHandler.h:667
virtual void onPublishFallbackToAudioOnly(bool is_fallback, NERtcVideoStreamType type)
Definition: INertcEngineEventHandler.h:1070
virtual void onAudioDefaultDeviceChanged(const char *device_id, NERtcAudioDeviceType device_type)
Definition: INertcEngineEventHandler.h:512
virtual void onFirstAudioDataReceived(NERtcAudioStreamType type, uid_t uid)
Definition: INertcEngineEventHandler.h:584
virtual void onWarning(int warn_code, const char *msg)
Definition: INertcEngineEventHandler.h:74
virtual void onVirtualBackgroundSourceEnabled(bool enabled, NERtcVirtualBackgroundSourceStateReason reason)
Definition: INertcEngineEventHandler.h:1216
virtual void onReleasedHwResources(NERtcErrorCode result)
Definition: INertcEngineEventHandler.h:112
virtual void onUserVideoStart(NERtcVideoStreamType type, uid_t uid, NERtcVideoProfileType max_profile)
Definition: INertcEngineEventHandler.h:382
virtual void onRejoinChannel(channel_id_t cid, uid_t uid, NERtcErrorCode result, uint64_t elapsed)
Definition: INertcEngineEventHandler.h:212
virtual void onLeaveChannel(NERtcErrorCode result, uint64_t channel_id)
Definition: INertcEngineEventHandler.h:232
virtual void onFirstVideoDataReceived(NERtcVideoStreamType type, uid_t uid)
Definition: INertcEngineEventHandler.h:601
virtual void onVideoDeviceStateChanged(const char *device_id, NERtcVideoDeviceType device_type, NERtcVideoDeviceState device_state)
Definition: INertcEngineEventHandler.h:530
virtual void onLastmileProbeResult(const NERtcLastmileProbeResult &result)
Definition: INertcEngineEventHandler.h:1146
virtual void onUserAudioStop(NERtcAudioStreamType type, uid_t uid)
Definition: INertcEngineEventHandler.h:365
virtual void onNetworkTypeChanged(NERtcNetworkType new_type)
Definition: INertcEngineEventHandler.h:190
virtual void onError(int error_code, const char *msg)
Definition: INertcEngineEventHandler.h:54
virtual void onLiveStreamStateChanged(const char *task_id, const char *url, NERtcLiveStreamStateCode state)
Definition: INertcEngineEventHandler.h:936
virtual void onRecvSEIMsg(uid_t uid, const uint8_t *data, uint32_t dataSize)
Definition: INertcEngineEventHandler.h:986
virtual void onUserAudioMute(NERtcAudioStreamType stream_type, uid_t uid, bool mute)
Definition: INertcEngineEventHandler.h:445
virtual void onApiCallExecuted(const char *api_name, NERtcErrorCode error_code, const char *msg)
Definition: INertcEngineEventHandler.h:94
virtual void onRemoveLiveStreamTask(const char *task_id, int error_code)
Definition: INertcEngineEventHandler.h:910
virtual void onUpdatePermissionKey(const char *key, NERtcErrorCode error, int timeout)
Definition: INertcEngineEventHandler.h:1303
virtual void onUserDataReceiveMessage(uid_t uid, const char *source_id, void *data, uint64_t size)
Definition: INertcEngineEventHandler.h:1324
virtual void onMediaRelayEvent(NERtcChannelMediaRelayEvent event, const char *channel_name, NERtcErrorCode error)
Definition: INertcEngineEventHandler.h:1041
virtual void onLastmileQuality(NERtcNetworkQualityType quality)
Definition: INertcEngineEventHandler.h:1124
virtual void onConnectionStateChange(NERtcConnectionStateType state, NERtcReasonConnectionChangedType reason)
Definition: INertcEngineEventHandler.h:174
virtual void onReconnectingStart(channel_id_t cid, uid_t uid)
Definition: INertcEngineEventHandler.h:154
virtual void onAddLiveStreamTask(const char *task_id, const char *url, int error_code)
Definition: INertcEngineEventHandler.h:858
virtual void onCheckNECastAudioDriverResult(NERtcInstallCastAudioDriverResult result)
Definition: INertcEngineEventHandler.h:1187
virtual void onAudioDeviceRoutingDidChange(NERtcAudioOutputRouting routing)
Definition: INertcEngineEventHandler.h:478
virtual void onCameraExposureChanged(const NERtcCameraFocusAndExposureInfo &info)
Definition: INertcEngineEventHandler.h:570
virtual void onUserDataBufferedAmountChanged(uid_t uid, const char *source_id, uint64_t previous_amount)
Definition: INertcEngineEventHandler.h:1391
virtual void onUserLeft(uid_t uid, NERtcSessionLeaveReason reason, const NERtcUserJoinExtraInfo &custom_info)
Definition: INertcEngineEventHandler.h:335
virtual void onFirstAudioFrameDecoded(NERtcAudioStreamType type, uid_t uid)
Definition: INertcEngineEventHandler.h:615
virtual void onRemoteAudioVolumeIndication(const NERtcAudioVolumeInfo *speakers, uint32_t speaker_number, int total_volume)
Definition: INertcEngineEventHandler.h:831
virtual void onDisconnect(NERtcErrorCode reason)
Definition: INertcEngineEventHandler.h:255
virtual void onMediaRelayStateChanged(NERtcChannelMediaRelayState state, const char *channel_name)
Definition: INertcEngineEventHandler.h:1021
virtual void onUserJoined(uid_t uid, const char *user_name, const NERtcUserJoinExtraInfo &custom_info)
Definition: INertcEngineEventHandler.h:307
virtual void onAudioRecording(NERtcAudioRecordingCode code, const char *file_path)
Definition: INertcEngineEventHandler.h:1003
namespace nertc
Definition: INertcAudioDeviceManager.h:11
NERtcClientRole
Definition: NertcEngineDefines.h:198
NERtcLocalVideoWatermarkState
Definition: NertcEngineDefines.h:5514
NERtcAudioDeviceState
Definition: NertcEngineDefines.h:1758
NERtcNetworkType
Definition: NertcEngineDefines.h:8103
NERtcChannelMediaRelayState
Definition: NertcEngineDefines.h:5295
NERtcReasonConnectionChangedType
Definition: NertcEngineDefines.h:2246
NERtcVideoStreamType
Definition: NertcEngineDefines.h:5257
NERtcSessionLeaveReason
Definition: NertcEngineDefines.h:4946
NERtcAudioOutputRouting
Definition: NertcEngineDefines.h:8054
NERtcConnectionStateType
Definition: NertcEngineDefines.h:2190
NERtcAudioDeviceType
Definition: NertcEngineDefines.h:1720
uint64_t uid_t
Definition: NertcEngineDefines.h:138
NERtcVideoRotation
Definition: NertcEngineDefines.h:4661
NERtcVideoProfileType
Definition: NertcEngineDefines.h:1600
NERtcAudioStreamType
Definition: NertcEngineDefines.h:3003
NERtcAudioMixingErrorCode
Definition: NertcErrorCode.h:836
NERtcVideoDeviceState
Definition: NertcEngineDefines.h:2029
uint64_t channel_id_t
Definition: NertcEngineDefines.h:147
NERtcScreenCaptureStatus
Definition: NertcEngineDefines.h:3769
NERtcVideoType
Definition: NertcEngineDefines.h:4596
NERtcAudioRecordingCode
Definition: NertcEngineDefines.h:6353
NERtcNetworkQualityType
Definition: NertcEngineDefines.h:3237
NERtcLiveStreamStateCode
Definition: NertcEngineDefines.h:948
NERtcVirtualBackgroundSourceStateReason
Definition: NertcEngineDefines.h:6758
NERtcInstallCastAudioDriverResult
Definition: NertcEngineDefines.h:6719
NERtcAudioMixingState
Definition: NertcEngineDefines.h:5003
NERtcErrorCode
Definition: NertcErrorCode.h:23
NERtcVideoDeviceType
Definition: NertcEngineDefines.h:2000
NERtcChannelMediaRelayEvent
Definition: NertcEngineDefines.h:5342
Definition: NertcEngineDefines.h:2374
Definition: NertcEngineDefines.h:8116
Definition: NertcEngineDefines.h:6652
Definition: NertcEngineDefines.h:7080