NERtc macOS SDK  V5.5.40
nertc_engine_event_handler_ex.h
浏览该文件的文档.
1 
7 #ifndef NERTC_ENGINE_EVENT_HANDLER_EX_H
8 #define NERTC_ENGINE_EVENT_HANDLER_EX_H
9 
10 #include "nertc_base_types.h"
11 #include "nertc_engine_defines.h"
13 
18 namespace nertc
19 {
31 {
32 public:
33  virtual ~IRtcEngineEventHandlerEx() {}
34 
48  virtual void onUserSubStreamVideoStart(uid_t uid, NERtcVideoProfileType max_profile) {
49  (void)uid;
50  (void)max_profile;
51  }
63  virtual void onUserSubStreamVideoStop(uid_t uid) {
64  (void)uid;
65  }
66 
83 
101 
113  virtual void onUserVideoProfileUpdate(uid_t uid, NERtcVideoProfileType max_profile) {
114  (void)uid;
115  (void)max_profile;
116  }
129  virtual void onUserSubStreamAudioStart(uid_t uid) {
130  (void)uid;
131  }
144  virtual void onUserSubStreamAudioStop(uid_t uid) {
145  (void)uid;
146  }
160  virtual void onUserAudioMute(uid_t uid, bool mute) {
161  (void)uid;
162  (void)mute;
163  }
182  virtual void onUserSubStreamAudioMute(uid_t uid, bool mute) {
183  (void)uid;
184  (void)mute;
185  }
202  virtual void onUserVideoMute(uid_t uid, bool mute) {
203  (void)uid;
204  (void)mute;
205  }
206 
237  virtual void onUserVideoMute(NERtcVideoStreamType videoStreamType, uid_t uid, bool mute) {
238  (void)videoStreamType;
239  (void)uid;
240  (void)mute;
241  }
242 
257  virtual void onAudioDeviceStateChanged(const char device_id[kNERtcMaxDeviceIDLength],
258  NERtcAudioDeviceType device_type,
259  NERtcAudioDeviceState device_state) {
260  (void)device_id;
261  (void)device_type;
262  (void)device_state;
263  }
264 
277  virtual void onAudioDefaultDeviceChanged(const char device_id[kNERtcMaxDeviceIDLength],
278  NERtcAudioDeviceType device_type) {
279  (void)device_id;
280  (void)device_type;
281  }
282 
297  virtual void onVideoDeviceStateChanged(const char device_id[kNERtcMaxDeviceIDLength],
298  NERtcVideoDeviceType device_type,
299  NERtcVideoDeviceState device_state) {
300  (void)device_id;
301  (void)device_type;
302  (void)device_state;
303  }
304 
315  virtual void onFirstAudioDataReceived(uid_t uid) {
316  (void)uid;
317  }
318 
331  virtual void onFirstVideoDataReceived(uid_t uid) {
332  (void)uid;
333  }
334 
361  (void)uid;
362  (void)type;
363  }
364 
403  virtual void onRemoteVideoReceiveSizeChanged(uid_t uid, NERtcVideoStreamType type, uint32_t width, uint32_t height) {
404  (void)uid;
405  (void)type;
406  (void)width;
407  (void)height;
408  }
409 
443  virtual void onLocalVideoRenderSizeChanged(NERtcVideoStreamType type, uint32_t width, uint32_t height) {
444  (void)type;
445  (void)width;
446  (void)height;
447  }
448 
459  virtual void onFirstAudioFrameDecoded(uid_t uid) {
460  (void)uid;
461  }
462 
480  virtual void onFirstVideoFrameDecoded(uid_t uid, uint32_t width, uint32_t height) {
481  (void)uid;
482  (void)width;
483  (void)height;
484  }
485 
525  virtual void onFirstVideoFrameDecoded(NERtcVideoStreamType type, uid_t uid, uint32_t width, uint32_t height) {
526  (void)type;
527  (void)uid;
528  (void)width;
529  (void)height;
530  }
531 
572  virtual void onFirstVideoFrameRender(NERtcVideoStreamType type, uid_t uid, uint32_t width, uint32_t height, uint64_t elapsed) {
573  (void)type;
574  (void)uid;
575  (void)width;
576  (void)height;
577  (void)elapsed;
578  }
579 
606  virtual void onCaptureVideoFrame(void *data,
607  NERtcVideoType type,
608  uint32_t width,
609  uint32_t height,
610  uint32_t count,
611  uint32_t offset[kNERtcMaxPlaneCount],
612  uint32_t stride[kNERtcMaxPlaneCount],
613  NERtcVideoRotation rotation) {
614  (void)data;
615  (void)type;
616  (void)width;
617  (void)height;
618  (void)count;
619  (void)offset;
620  (void)stride;
621  (void)rotation;
622  }
623 
645  (void)state;
646  (void)error_code;
647  }
648 
661  virtual void onAudioMixingTimestampUpdate(uint64_t timestamp_ms) {
662  (void)timestamp_ms;
663  }
664 
699  virtual void onAudioEffectTimestampUpdate(uint32_t effect_id, uint64_t timestamp_ms) {
700  (void)effect_id;
701  (void)timestamp_ms;
702  }
703 
716  virtual void onAudioEffectFinished(uint32_t effect_id) {
717  (void)effect_id;
718  }
719 
738  virtual void onLocalAudioVolumeIndication(int volume) {
739  (void)volume;
740  }
741 
760  virtual void onLocalAudioVolumeIndication(int volume, bool enable_vad) {
761  (void)volume;
762  (void)enable_vad;
763  }
764 
789  virtual void onRemoteAudioVolumeIndication(const NERtcAudioVolumeInfo *speakers, unsigned int speaker_number, int total_volume) {
790  (void)speakers;
791  (void)speaker_number;
792  (void)total_volume;
793  }
794 
815  virtual void onAddLiveStreamTask(const char* task_id, const char* url, int error_code) {
816  (void)task_id;
817  (void)url;
818  (void)error_code;
819  }
820 
841  virtual void onUpdateLiveStreamTask(const char* task_id, const char* url, int error_code) {
842  (void)task_id;
843  (void)url;
844  (void)error_code;
845  }
846 
865  virtual void onRemoveLiveStreamTask(const char* task_id, int error_code) {
866  (void)task_id;
867  (void)error_code;
868  }
869 
892  virtual void onLiveStreamState(const char* task_id, const char* url, NERtcLiveStreamStateCode state) {
893  (void)task_id;
894  (void)url;
895  (void)state;
896  }
897 
920  virtual void onAudioHowling(bool howling) {
921  (void)howling;
922  }
923 
940  virtual void onRecvSEIMsg(uid_t uid, const char* data, uint32_t dataSize) {
941  (void)uid;
942  (void)data;
943  (void)dataSize;
944  }
945 
958  virtual void onAudioRecording(NERtcAudioRecordingCode code, const char* file_path) {
959  (void)code;
960  (void)file_path;
961  }
962 
977  virtual void onMediaRelayStateChanged(NERtcChannelMediaRelayState state, const char* channel_name) {
978  (void)state;
979  (void)channel_name;
980  }
981 
998  virtual void onMediaRelayEvent(NERtcChannelMediaRelayEvent event, const char* channel_name, NERtcErrorCode error) {
999  (void)event;
1000  (void)channel_name;
1001  (void)error;
1002  }
1003 
1024  virtual void onLocalPublishFallbackToAudioOnly(bool is_fallback, NERtcVideoStreamType stream_type) {
1025  (void)is_fallback;
1026  }
1027 
1050  virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool is_fallback, NERtcVideoStreamType stream_type) {
1051  (void)uid;
1052  (void)is_fallback;
1053  }
1054 
1071  (void)quality;
1072  }
1073 
1090  virtual void onLastmileProbeResult(const NERtcLastmileProbeResult& result) {
1091  (void)result;
1092  };
1093 
1116  virtual void onMediaRightChange(bool is_audio_banned, bool is_video_banned) {
1117  (void)is_audio_banned;
1118  (void)is_video_banned;
1119  }
1120 
1134  (void)result;
1135  }
1136 
1163  (void)enabled;
1164  (void)reason;
1165  }
1166 
1184  (void)videoStreamType;
1185  (void)state;
1186  }
1187 
1209  virtual void onPermissionKeyWillExpire() {}
1210 
1249  virtual void onUpdatePermissionKey(const char* key, NERtcErrorCode error, int timeout) {
1250  (void)key;
1251  (void)error;
1252  (void)timeout;
1253  }
1254 
1269  virtual void onUserDataReceiveMessage(uid_t uid, void* pData, uint64_t size) {
1270  (void)uid;
1271  (void)pData;
1272  (void)size;
1273  };
1274 
1287  virtual void onUserDataStart(uid_t uid){
1288  (void)uid;
1289  };
1290 
1301  virtual void onUserDataStop(uid_t uid) {
1302  (void)uid;
1303  };
1304 
1315  virtual void onUserDataStateChanged(uid_t uid) {
1316  (void)uid;
1317  };
1318 
1331  virtual void onUserDataBufferedAmountChanged(uid_t uid, uint64_t previousAmount) {
1332  (void)uid;
1333  (void)previousAmount;
1334  };
1335 
1344  virtual void onLabFeatureCallback(const char* key, const char* param) {
1345  (void)key;
1346  (void)param;
1347  }
1348 };
1349 } // namespace nertc
1350 
1351 #endif
Definition: nertc_engine_event_handler_ex.h:31
virtual void onLastmileQuality(NERtcNetworkQualityType quality)
Definition: nertc_engine_event_handler_ex.h:1070
virtual void onFirstVideoFrameRender(NERtcVideoStreamType type, uid_t uid, uint32_t width, uint32_t height, uint64_t elapsed)
Definition: nertc_engine_event_handler_ex.h:572
virtual void onAudioRecording(NERtcAudioRecordingCode code, const char *file_path)
Definition: nertc_engine_event_handler_ex.h:958
virtual void onFirstVideoFrameDecoded(uid_t uid, uint32_t width, uint32_t height)
Definition: nertc_engine_event_handler_ex.h:480
virtual void onLocalPublishFallbackToAudioOnly(bool is_fallback, NERtcVideoStreamType stream_type)
Definition: nertc_engine_event_handler_ex.h:1024
virtual void onMediaRightChange(bool is_audio_banned, bool is_video_banned)
Definition: nertc_engine_event_handler_ex.h:1116
virtual void onRemoveLiveStreamTask(const char *task_id, int error_code)
Definition: nertc_engine_event_handler_ex.h:865
virtual void onFirstAudioFrameDecoded(uid_t uid)
Definition: nertc_engine_event_handler_ex.h:459
virtual void onAudioMixingStateChanged(NERtcAudioMixingState state, NERtcAudioMixingErrorCode error_code)
Definition: nertc_engine_event_handler_ex.h:644
virtual void onUserAudioMute(uid_t uid, bool mute)
Definition: nertc_engine_event_handler_ex.h:160
virtual void onAudioHowling(bool howling)
Definition: nertc_engine_event_handler_ex.h:920
virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool is_fallback, NERtcVideoStreamType stream_type)
Definition: nertc_engine_event_handler_ex.h:1050
virtual void onFirstVideoFrameDecoded(NERtcVideoStreamType type, uid_t uid, uint32_t width, uint32_t height)
Definition: nertc_engine_event_handler_ex.h:525
virtual void onUserVideoMute(NERtcVideoStreamType videoStreamType, uid_t uid, bool mute)
Definition: nertc_engine_event_handler_ex.h:237
virtual void onFirstVideoDataReceived(uid_t uid)
Definition: nertc_engine_event_handler_ex.h:331
virtual void onUserSubStreamVideoStart(uid_t uid, NERtcVideoProfileType max_profile)
Definition: nertc_engine_event_handler_ex.h:48
virtual void onPermissionKeyWillExpire()
Definition: nertc_engine_event_handler_ex.h:1209
virtual void onMediaRelayEvent(NERtcChannelMediaRelayEvent event, const char *channel_name, NERtcErrorCode error)
Definition: nertc_engine_event_handler_ex.h:998
virtual void onVideoDeviceStateChanged(const char device_id[kNERtcMaxDeviceIDLength], NERtcVideoDeviceType device_type, NERtcVideoDeviceState device_state)
Definition: nertc_engine_event_handler_ex.h:297
virtual void onLastmileProbeResult(const NERtcLastmileProbeResult &result)
Definition: nertc_engine_event_handler_ex.h:1090
virtual void onUpdateLiveStreamTask(const char *task_id, const char *url, int error_code)
Definition: nertc_engine_event_handler_ex.h:841
virtual void onRemoteAudioVolumeIndication(const NERtcAudioVolumeInfo *speakers, unsigned int speaker_number, int total_volume)
Definition: nertc_engine_event_handler_ex.h:789
virtual void onFirstVideoDataReceived(NERtcVideoStreamType type, uid_t uid)
Definition: nertc_engine_event_handler_ex.h:360
virtual void onVirtualBackgroundSourceEnabled(bool enabled, NERtcVirtualBackgroundSourceStateReason reason)
Definition: nertc_engine_event_handler_ex.h:1162
virtual void onUserDataStateChanged(uid_t uid)
Definition: nertc_engine_event_handler_ex.h:1315
virtual void onUserDataReceiveMessage(uid_t uid, void *pData, uint64_t size)
Definition: nertc_engine_event_handler_ex.h:1269
virtual void onCheckNECastAudioDriverResult(NERtcInstallCastAudioDriverResult result)
Definition: nertc_engine_event_handler_ex.h:1133
virtual void onAudioEffectFinished(uint32_t effect_id)
Definition: nertc_engine_event_handler_ex.h:716
virtual void onLocalAudioVolumeIndication(int volume, bool enable_vad)
Definition: nertc_engine_event_handler_ex.h:760
virtual void onAudioDefaultDeviceChanged(const char device_id[kNERtcMaxDeviceIDLength], NERtcAudioDeviceType device_type)
Definition: nertc_engine_event_handler_ex.h:277
virtual void onScreenCaptureStatus(NERtcScreenCaptureStatus status)
Definition: nertc_engine_event_handler_ex.h:82
virtual void onLocalAudioVolumeIndication(int volume)
Definition: nertc_engine_event_handler_ex.h:738
virtual void onRecvSEIMsg(uid_t uid, const char *data, uint32_t dataSize)
Definition: nertc_engine_event_handler_ex.h:940
virtual void onLocalVideoRenderSizeChanged(NERtcVideoStreamType type, uint32_t width, uint32_t height)
Definition: nertc_engine_event_handler_ex.h:443
virtual void onUserDataStop(uid_t uid)
Definition: nertc_engine_event_handler_ex.h:1301
virtual void onUserDataStart(uid_t uid)
Definition: nertc_engine_event_handler_ex.h:1287
virtual void onAudioEffectTimestampUpdate(uint32_t effect_id, uint64_t timestamp_ms)
Definition: nertc_engine_event_handler_ex.h:699
virtual void onAudioDeviceStateChanged(const char device_id[kNERtcMaxDeviceIDLength], NERtcAudioDeviceType device_type, NERtcAudioDeviceState device_state)
Definition: nertc_engine_event_handler_ex.h:257
virtual void onMediaRelayStateChanged(NERtcChannelMediaRelayState state, const char *channel_name)
Definition: nertc_engine_event_handler_ex.h:977
virtual void onLiveStreamState(const char *task_id, const char *url, NERtcLiveStreamStateCode state)
Definition: nertc_engine_event_handler_ex.h:892
virtual void onUpdatePermissionKey(const char *key, NERtcErrorCode error, int timeout)
Definition: nertc_engine_event_handler_ex.h:1249
virtual void onUserSubStreamAudioStop(uid_t uid)
Definition: nertc_engine_event_handler_ex.h:144
virtual void onUserSubStreamVideoStop(uid_t uid)
Definition: nertc_engine_event_handler_ex.h:63
virtual void onUserSubStreamAudioStart(uid_t uid)
Definition: nertc_engine_event_handler_ex.h:129
virtual void onUserSubStreamAudioMute(uid_t uid, bool mute)
Definition: nertc_engine_event_handler_ex.h:182
virtual void onUserVideoMute(uid_t uid, bool mute)
Definition: nertc_engine_event_handler_ex.h:202
virtual void onAddLiveStreamTask(const char *task_id, const char *url, int error_code)
Definition: nertc_engine_event_handler_ex.h:815
virtual void onLabFeatureCallback(const char *key, const char *param)
Definition: nertc_engine_event_handler_ex.h:1344
virtual void onFirstAudioDataReceived(uid_t uid)
Definition: nertc_engine_event_handler_ex.h:315
virtual void onLocalVideoWatermarkState(NERtcVideoStreamType videoStreamType, NERtcLocalVideoWatermarkState state)
Definition: nertc_engine_event_handler_ex.h:1183
virtual void onCaptureVideoFrame(void *data, NERtcVideoType type, uint32_t width, uint32_t height, uint32_t count, uint32_t offset[kNERtcMaxPlaneCount], uint32_t stride[kNERtcMaxPlaneCount], NERtcVideoRotation rotation)
Definition: nertc_engine_event_handler_ex.h:606
virtual void onAudioMixingTimestampUpdate(uint64_t timestamp_ms)
Definition: nertc_engine_event_handler_ex.h:661
virtual void onRemoteVideoReceiveSizeChanged(uid_t uid, NERtcVideoStreamType type, uint32_t width, uint32_t height)
Definition: nertc_engine_event_handler_ex.h:403
virtual void onUserDataBufferedAmountChanged(uid_t uid, uint64_t previousAmount)
Definition: nertc_engine_event_handler_ex.h:1331
virtual void onUserVideoProfileUpdate(uid_t uid, NERtcVideoProfileType max_profile)
Definition: nertc_engine_event_handler_ex.h:113
virtual void onScreenCaptureSourceDataUpdate(NERtcScreenCaptureSourceData data)
Definition: nertc_engine_event_handler_ex.h:100
Definition: nertc_engine_event_handler.h:33
namespace nertc
NERtcLocalVideoWatermarkState
Definition: nertc_engine_defines.h:6059
NERtcAudioDeviceState
Definition: nertc_engine_defines.h:1813
NERtcChannelMediaRelayState
Definition: nertc_engine_defines.h:5832
NERtcVideoStreamType
Definition: nertc_engine_defines.h:5780
NERtcAudioDeviceType
Definition: nertc_engine_defines.h:1775
uint64_t uid_t
Definition: nertc_engine_defines.h:183
NERtcVideoRotation
Definition: nertc_engine_defines.h:5184
NERtcVideoProfileType
Definition: nertc_engine_defines.h:1670
NERtcAudioMixingErrorCode
Definition: nertc_error_code.h:925
NERtcVideoDeviceState
Definition: nertc_engine_defines.h:2084
NERtcScreenCaptureStatus
Definition: nertc_engine_defines.h:3931
NERtcVideoType
Definition: nertc_engine_defines.h:5128
NERtcAudioRecordingCode
Definition: nertc_engine_defines.h:6979
NERtcNetworkQualityType
Definition: nertc_engine_defines.h:3338
NERtcLiveStreamStateCode
Definition: nertc_engine_defines.h:1088
NERtcVirtualBackgroundSourceStateReason
Definition: nertc_engine_defines.h:7437
NERtcInstallCastAudioDriverResult
Definition: nertc_engine_defines.h:7397
NERtcAudioMixingState
Definition: nertc_engine_defines.h:5502
NERtcErrorCode
Definition: nertc_error_code.h:26
NERtcVideoDeviceType
Definition: nertc_engine_defines.h:2055
NERtcChannelMediaRelayEvent
Definition: nertc_engine_defines.h:5879
NERtc SDK definitions.
#define kNERtcMaxPlaneCount
Definition: nertc_engine_defines.h:19
#define kNERtcMaxDeviceIDLength
Definition: nertc_engine_defines.h:61
The interface header file of expansion callback of the NERTC SDK. All parameter descriptions of the N...
Definition: nertc_engine_defines.h:2440
Definition: nertc_engine_defines.h:7329
Definition: nertc_engine_defines.h:4109