NERtc Windows SDK  V4.4.301
nertc_engine_ex.h
浏览该文件的文档.
1 
7 #ifndef NERTC_ENGINE_EX_H
8 #define NERTC_ENGINE_EX_H
9 
10 #include "nertc_base.h"
11 #include "nertc_base_types.h"
12 #include "nertc_engine_defines.h"
15 #include "nertc_engine.h"
16 
21 namespace nertc
22 {
27 class IRtcEngineEx : public IRtcEngine
28 {
29 public:
30  virtual ~IRtcEngineEx() {}
31 
37 
52  virtual int muteLocalAudioStream(bool mute) = 0;
53 
67  virtual int setAudioProfile(NERtcAudioProfileType profile, NERtcAudioScenarioType scenario) = 0;
68 
84 
98 
113  virtual int setLocalVoicePitch(double pitch) = 0;
114 
126  virtual int setLocalVoiceEqualization(NERtcVoiceEqualizationBand band_frequency, int band_gain) = 0;
127 
145  virtual int subscribeRemoteAudioStream(uid_t uid, bool subscribe) = 0;
146 
160  virtual int setVideoConfig(const NERtcVideoConfig& config) = 0;
161 
178  virtual int enableDualStreamMode(bool enable) = 0;
179 
190 
202  virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
203 
215  virtual int setLocalSubStreamRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
216 
229  virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode) = 0;
230 
241  virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
242 
259 
275  virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe) = 0;
276 
287  virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
288 
301  virtual int startVideoPreview() = 0;
302 
311  virtual int stopVideoPreview() = 0;
312 
331  virtual int muteLocalVideoStream(bool mute) = 0;
332 
351  virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive) = 0;
352 
361  virtual int setParameters(const char* parameters) = 0;
362 
378 
394 
395 
411  virtual int setMixedAudioFrameParameters(int sample_rate) = 0;
412 
424 
431  virtual int startAudioDump() = 0;
438  virtual int stopAudioDump() = 0;
439 
459 
468  virtual int stopAudioMixing() = 0;
469 
478  virtual int pauseAudioMixing() = 0;
479 
488  virtual int resumeAudioMixing() = 0;
489 
500  virtual int setAudioMixingSendVolume(uint32_t volume) = 0;
501 
512  virtual int getAudioMixingSendVolume(uint32_t *volume) = 0;
513 
524  virtual int setAudioMixingPlaybackVolume(uint32_t volume) = 0;
525 
536  virtual int getAudioMixingPlaybackVolume(uint32_t *volume) = 0;
537 
548  virtual int getAudioMixingDuration(uint64_t *duration) = 0;
549 
560  virtual int getAudioMixingCurrentPosition(uint64_t *position) = 0;
561 
572  virtual int setAudioMixingPosition(uint64_t seek_position) = 0;
573 
590  virtual int playEffect(uint32_t effect_id, NERtcCreateAudioEffectOption *option) = 0;
591 
602  virtual int stopEffect(uint32_t effect_id) = 0;
603 
610  virtual int stopAllEffects() = 0;
611 
622  virtual int pauseEffect(uint32_t effect_id) = 0;
623 
634  virtual int resumeEffect(uint32_t effect_id) = 0;
635 
644  virtual int pauseAllEffects() = 0;
645 
654  virtual int resumeAllEffects() = 0;
655 
667  virtual int setEffectSendVolume(uint32_t effect_id, uint32_t volume) = 0;
679  virtual int getEffectSendVolume(uint32_t effect_id, uint32_t *volume) = 0;
680 
692  virtual int setEffectPlaybackVolume(uint32_t effect_id, uint32_t volume) = 0;
693 
705  virtual int getEffectPlaybackVolume(uint32_t effect_id, uint32_t *volume) = 0;
706 
728  virtual int enableLoopbackRecording(bool enabled, const char *device_name) = 0;
729 
742  virtual int adjustLoopbackRecordingSignalVolume(int volume) = 0;
743 
760  virtual int enableEarback(bool enabled, uint32_t volume) = 0;
761 
772  virtual int setEarbackVolume(uint32_t volume) = 0;
773 
782  virtual int setStatsObserver(IRtcMediaStatsObserver *observer) = 0;
783 
797  virtual int enableAudioVolumeIndication(bool enable, uint64_t interval) = 0;
798 
817  virtual int startScreenCaptureByScreenRect(const NERtcRectangle& screen_rect, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
818 
836  virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
837 
856  virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
857 
865  virtual int updateScreenCaptureRegion(const NERtcRectangle& region_rect) = 0;
866 
875  virtual int stopScreenCapture() = 0;
876 
883  virtual int pauseScreenCapture() = 0;
884 
891  virtual int resumeScreenCapture() = 0;
892 
893 
902  virtual int setExcludeWindowList(source_id_t* window_list, int count) = 0;
903 
918  virtual int setExternalVideoSource(bool enabled) = 0;
919 
932  virtual int pushExternalVideoFrame(NERtcVideoFrame* frame) = 0;
933 
934 
957  virtual int setExternalAudioSource(bool enabled, int sample_rate, int channels) = 0;
958 
976  virtual int pushExternalAudioFrame(NERtcAudioFrame* frame) = 0;
977 
1002  virtual int setExternalAudioRender(bool enabled, int sample_rate, int channels) = 0;
1003 
1022  virtual int pullExternalAudioFrame(void* data, int len) = 0;
1023 
1031  virtual const char* getVersion(int* build) = 0;
1032 
1041  virtual const char* getErrorDescription(int error_code) = 0;
1042 
1049  virtual void uploadSdkInfo() = 0;
1050 
1062  virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1063 
1073  virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1074 
1085  virtual int removeLiveStreamTask(const char* task_id) = 0;
1086 
1108  virtual int sendSEIMsg(const char* data, int length, NERtcVideoStreamType type) = 0;
1109 
1131  virtual int sendSEIMsg(const char* data, int length) = 0;
1132 
1149 
1167 
1184  virtual int takeLocalSnapshot(NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
1185 
1202  virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
1203 
1204 
1228  virtual int startAudioRecording(const char* file_path, int sample_rate, NERtcAudioRecordingQuality quality) = 0;
1229 
1240  virtual int stopAudioRecording() = 0;
1241 
1260  virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
1261 
1268 
1275 
1280  virtual int stopChannelMediaRelay() = 0;
1281 
1282 
1294  virtual int setLocalPublishFallbackOption(int option) = 0;
1295 
1309  virtual int setRemoteSubscribeFallbackOption(int option) = 0;
1310 
1327  virtual int enableSuperResolution(bool enable) = 0;
1328 
1348  virtual int enableEncryption(bool enable, NERtcEncryptionConfig config) = 0;
1349 
1370  virtual int setCloudProxy(int proxyType) = 0;
1371 };
1372 
1373 } //namespace nertc
1374 
1375 #endif
Definition: nertc_engine_defines.h:966
Definition: nertc_engine_ex.h:28
virtual int setRemoteSubscribeFallbackOption(int option)=0
virtual int takeLocalSnapshot(NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback)=0
virtual int setRemoteCanvasWatermarkConfigs(uid_t uid, NERtcVideoStreamType type, NERtcCanvasWatermarkConfig &config)=0
virtual int pushExternalAudioFrame(NERtcAudioFrame *frame)=0
virtual int getAudioMixingSendVolume(uint32_t *volume)=0
virtual int setAudioMixingPlaybackVolume(uint32_t volume)=0
virtual int startScreenCaptureByScreenRect(const NERtcRectangle &screen_rect, const NERtcRectangle &region_rect, const NERtcScreenCaptureParameters &capture_params)=0
virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe)=0
virtual int pullExternalAudioFrame(void *data, int len)=0
virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback)=0
virtual int enableSuperResolution(bool enable)=0
virtual NERtcConnectionStateType getConnectionState()=0
virtual int setExternalAudioSource(bool enabled, int sample_rate, int channels)=0
virtual int setAudioProfile(NERtcAudioProfileType profile, NERtcAudioScenarioType scenario)=0
virtual int setEffectSendVolume(uint32_t effect_id, uint32_t volume)=0
virtual int setExternalAudioRender(bool enabled, int sample_rate, int channels)=0
virtual int resumeEffect(uint32_t effect_id)=0
virtual int stopAudioRecording()=0
virtual int stopEffect(uint32_t effect_id)=0
virtual int startChannelMediaRelay(NERtcChannelMediaRelayConfiguration *config)=0
virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode)=0
virtual int enableEncryption(bool enable, NERtcEncryptionConfig config)=0
virtual int muteLocalAudioStream(bool mute)=0
virtual int enableLoopbackRecording(bool enabled, const char *device_name)=0
virtual int updateChannelMediaRelay(NERtcChannelMediaRelayConfiguration *config)=0
virtual int setParameters(const char *parameters)=0
virtual int startAudioMixing(NERtcCreateAudioMixingOption *option)=0
virtual int updateScreenCaptureRegion(const NERtcRectangle &region_rect)=0
virtual int enableEarback(bool enabled, uint32_t volume)=0
virtual int stopChannelMediaRelay()=0
virtual int setStatsObserver(IRtcMediaStatsObserver *observer)=0
virtual int startAudioDump()=0
virtual int getEffectSendVolume(uint32_t effect_id, uint32_t *volume)=0
virtual int adjustLoopbackRecordingSignalVolume(int volume)=0
virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle &region_rect, const NERtcScreenCaptureParameters &capture_params)=0
virtual void uploadSdkInfo()=0
virtual int setLocalPublishFallbackOption(int option)=0
virtual int getAudioMixingCurrentPosition(uint64_t *position)=0
virtual int stopScreenCapture()=0
virtual int setupRemoteSubStreamVideoCanvas(uid_t uid, NERtcVideoCanvas *canvas)=0
virtual int resumeScreenCapture()=0
virtual int pauseAudioMixing()=0
virtual int pauseEffect(uint32_t effect_id)=0
virtual int pauseScreenCapture()=0
virtual int resumeAllEffects()=0
virtual int setVoiceBeautifierPreset(NERtcVoiceBeautifierType type)=0
virtual int enableAudioVolumeIndication(bool enable, uint64_t interval)=0
virtual int setEffectPlaybackVolume(uint32_t effect_id, uint32_t volume)=0
virtual int setMixedAudioFrameParameters(int sample_rate)=0
virtual int muteLocalVideoStream(bool mute)=0
virtual int stopAudioDump()=0
virtual int stopAudioMixing()=0
virtual int setLocalCanvasWatermarkConfigs(NERtcVideoStreamType type, NERtcCanvasWatermarkConfig &config)=0
virtual int resumeAudioMixing()=0
virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode)=0
virtual int setAudioMixingSendVolume(uint32_t volume)=0
virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle &region_rect, const NERtcScreenCaptureParameters &capture_params)=0
virtual const char * getErrorDescription(int error_code)=0
virtual int sendSEIMsg(const char *data, int length, NERtcVideoStreamType type)=0
virtual int getAudioMixingPlaybackVolume(uint32_t *volume)=0
virtual int setupLocalSubStreamVideoCanvas(NERtcVideoCanvas *canvas)=0
virtual int stopVideoPreview()=0
virtual int playEffect(uint32_t effect_id, NERtcCreateAudioEffectOption *option)=0
virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode)=0
virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode)=0
virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive)=0
virtual int setLocalVoicePitch(double pitch)=0
virtual int setAudioFrameObserver(INERtcAudioFrameObserver *observer)=0
virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo &info)=0
virtual int setAudioMixingPosition(uint64_t seek_position)=0
virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume)=0
virtual int setVideoConfig(const NERtcVideoConfig &config)=0
virtual int enableDualStreamMode(bool enable)=0
virtual int subscribeRemoteAudioStream(uid_t uid, bool subscribe)=0
virtual int setPlaybackAudioFrameParameters(NERtcAudioFrameRequestFormat *format)=0
virtual int getEffectPlaybackVolume(uint32_t effect_id, uint32_t *volume)=0
virtual int setExternalVideoSource(bool enabled)=0
virtual int stopAllEffects()=0
virtual int setCloudProxy(int proxyType)=0
virtual int setLocalVoiceEqualization(NERtcVoiceEqualizationBand band_frequency, int band_gain)=0
virtual int removeLiveStreamTask(const char *task_id)=0
virtual int setRecordingAudioFrameParameters(NERtcAudioFrameRequestFormat *format)=0
virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo &info)=0
virtual const char * getVersion(int *build)=0
virtual int sendSEIMsg(const char *data, int length)=0
virtual int startAudioRecording(const char *file_path, int sample_rate, NERtcAudioRecordingQuality quality)=0
virtual int setAudioEffectPreset(NERtcVoiceChangerType type)=0
virtual int setEarbackVolume(uint32_t volume)=0
virtual int setExcludeWindowList(source_id_t *window_list, int count)=0
virtual int setLocalSubStreamRenderMode(NERtcVideoScalingMode scaling_mode)=0
virtual int startVideoPreview()=0
virtual int getAudioMixingDuration(uint64_t *duration)=0
virtual int pauseAllEffects()=0
virtual int pushExternalVideoFrame(NERtcVideoFrame *frame)=0
Definition: nertc_engine.h:40
Definition: nertc_engine_media_stats_observer.h:24
Definition: nertc_engine_defines.h:1248
namespace nertc
NERtcAudioProfileType
Definition: nertc_engine_defines.h:326
NERtcVideoScalingMode
Definition: nertc_engine_defines.h:489
NERtcVideoStreamType
Definition: nertc_engine_defines.h:1131
NERtcVoiceChangerType
Definition: nertc_engine_defines.h:350
NERtcMediaPriorityType
Definition: nertc_engine_defines.h:56
NERtcConnectionStateType
Definition: nertc_engine_defines.h:534
uint64_t uid_t
Definition: nertc_engine_defines.h:31
NERtcVoiceEqualizationBand
Definition: nertc_engine_defines.h:379
NERtcAudioRecordingQuality
Definition: nertc_engine_defines.h:1298
NERtcAudioScenarioType
Definition: nertc_engine_defines.h:337
void * source_id_t
Definition: nertc_engine_defines.h:33
NERtcVideoMirrorMode
Definition: nertc_engine_defines.h:497
NERtcVoiceBeautifierType
Definition: nertc_engine_defines.h:363
Defines macro output. The file only defines macro output instead of anything else.
The interface header file of NERTC SDK. All parameter descriptions of the NERTC SDK....
NERtc SDK definitions.
The interface header file of expansion callback of the NERTC SDK. All parameter descriptions of the N...
The interface header file of expansion callback of the NERTC SDK. All parameter descriptions of the N...
Definition: nertc_engine_defines.h:957
Definition: nertc_engine_defines.h:941
Definition: nertc_engine_defines.h:1238
Definition: nertc_engine_defines.h:1214
Definition: nertc_engine_defines.h:1096
Definition: nertc_engine_defines.h:1060
Definition: nertc_engine_defines.h:1342
Definition: nertc_engine_defines.h:278
Definition: nertc_engine_defines.h:849
Definition: nertc_engine_defines.h:880
Definition: nertc_engine_defines.h:894
Definition: nertc_engine_defines.h:744
Definition: nertc_engine_defines.h:1030