NERtc Windows SDK  V4.6.0
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 #include "nertc_channel.h"
17 
22 namespace nertc
23 {
34 class IRtcEngineEx : public IRtcEngine
35 {
36 public:
37  virtual ~IRtcEngineEx() {}
38 
53  virtual IRtcChannel* createChannel(const char* channel_name) = 0;
54 
66 
94  virtual int muteLocalAudioStream(bool mute) = 0;
95 
121 
147 
169 
194  virtual int setLocalVoicePitch(double pitch) = 0;
195 
216  virtual int setLocalVoiceEqualization(NERtcVoiceEqualizationBand band_frequency, int band_gain) = 0;
217 
246  virtual int subscribeRemoteAudioStream(uid_t uid, bool subscribe) = 0;
247 
248 
275  virtual int setCameraCaptureConfig(const NERtcCameraCaptureConfig& config) = 0;
276 
301  virtual int subscribeAllRemoteAudioStream(bool subscribe) = 0;
302 
329  virtual int setVideoConfig(const NERtcVideoConfig& config) = 0;
330 
359  virtual int enableDualStreamMode(bool enable) = 0;
360 
383 
405  virtual int setLocalSubStreamRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
406 
427  virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
428 
429 
450  virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode) = 0;
451 
472  virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
473 
503 
533  virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe) = 0;
534 
556  virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
557 
578  virtual int startVideoPreview() = 0;
579 
596  virtual int stopVideoPreview() = 0;
597 
631  virtual int muteLocalVideoStream(bool mute) = 0;
632 
665  virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive) = 0;
666 
683  virtual int setParameters(const char* parameters) = 0;
684 
710 
736 
737 
764  virtual int setMixedAudioFrameParameters(int sample_rate) = 0;
765 
785 
800  virtual int startAudioDump() = 0;
801 
802  virtual int startAudioDump(NERtcAudioDumpType type) = 0;
803 
818  virtual int stopAudioDump() = 0;
819 
850 
867  virtual int stopAudioMixing() = 0;
868 
885  virtual int pauseAudioMixing() = 0;
886 
903  virtual int resumeAudioMixing() = 0;
904 
923  virtual int setAudioMixingSendVolume(uint32_t volume) = 0;
924 
943  virtual int getAudioMixingSendVolume(uint32_t *volume) = 0;
944 
963  virtual int setAudioMixingPlaybackVolume(uint32_t volume) = 0;
964 
983  virtual int getAudioMixingPlaybackVolume(uint32_t *volume) = 0;
984 
1003  virtual int getAudioMixingDuration(uint64_t *duration) = 0;
1004 
1023  virtual int getAudioMixingCurrentPosition(uint64_t *position) = 0;
1024 
1043  virtual int setAudioMixingPosition(uint64_t seek_position) = 0;
1044 
1073  virtual int playEffect(uint32_t effect_id, NERtcCreateAudioEffectOption *option) = 0;
1074 
1093  virtual int stopEffect(uint32_t effect_id) = 0;
1094 
1110  virtual int stopAllEffects() = 0;
1111 
1130  virtual int pauseEffect(uint32_t effect_id) = 0;
1131 
1150  virtual int resumeEffect(uint32_t effect_id) = 0;
1151 
1168  virtual int pauseAllEffects() = 0;
1169 
1186  virtual int resumeAllEffects() = 0;
1187 
1208  virtual int setEffectSendVolume(uint32_t effect_id, uint32_t volume) = 0;
1229  virtual int getEffectSendVolume(uint32_t effect_id, uint32_t *volume) = 0;
1230 
1251  virtual int setEffectPlaybackVolume(uint32_t effect_id, uint32_t volume) = 0;
1252 
1273  virtual int getEffectPlaybackVolume(uint32_t effect_id, uint32_t *volume) = 0;
1274 
1309  virtual int enableLoopbackRecording(bool enabled, const char *device_name) = 0;
1310 
1331  virtual int adjustLoopbackRecordingSignalVolume(int volume) = 0;
1332 
1357  virtual int enableEarback(bool enabled, uint32_t volume) = 0;
1358 
1377  virtual int setEarbackVolume(uint32_t volume) = 0;
1378 
1395  virtual int setStatsObserver(IRtcMediaStatsObserver *observer) = 0;
1396 
1419  virtual int enableAudioVolumeIndication(bool enable, uint64_t interval) = 0;
1420 
1454  virtual int startScreenCaptureByScreenRect(const NERtcRectangle& screen_rect, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
1455 
1485  virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
1486 
1519  virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
1520 
1539  virtual int updateScreenCaptureRegion(const NERtcRectangle& region_rect) = 0;
1540 
1560  virtual int stopScreenCapture() = 0;
1561 
1579  virtual int pauseScreenCapture() = 0;
1580 
1596  virtual int resumeScreenCapture() = 0;
1597 
1598 
1628  virtual int setExcludeWindowList(source_id_t* window_list, int count) = 0;
1629 
1654  virtual int setExternalVideoSource(bool enabled) = 0;
1655 
1676  virtual int pushExternalVideoFrame(NERtcVideoFrame* frame) = 0;
1677 
1678 
1719  virtual int setExternalAudioSource(bool enabled, int sample_rate, int channels) = 0;
1720 
1749  virtual int pushExternalAudioFrame(NERtcAudioFrame* frame) = 0;
1750 
1795  virtual int setExternalAudioRender(bool enabled, int sample_rate, int channels) = 0;
1796 
1829  virtual int pullExternalAudioFrame(void* data, int len) = 0;
1830 
1845  virtual const char* getVersion(int* build) = 0;
1846 
1861  virtual const char* getErrorDescription(int error_code) = 0;
1862 
1877  virtual void uploadSdkInfo() = 0;
1878 
1905  virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1906 
1929  virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1930 
1955  virtual int removeLiveStreamTask(const char* task_id) = 0;
1956 
1993  virtual int sendSEIMsg(const char* data, int length, NERtcVideoStreamType type) = 0;
1994 
2031  virtual int sendSEIMsg(const char* data, int length) = 0;
2032 
2061 
2093 
2122  virtual int takeLocalSnapshot(NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
2123 
2152  virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
2153 
2154 
2197  virtual int startAudioRecording(const char* file_path, int sample_rate, NERtcAudioRecordingQuality quality) = 0;
2198 
2199 
2246 
2265  virtual int stopAudioRecording() = 0;
2266 
2299  virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
2300 
2329 
2353 
2372  virtual int stopChannelMediaRelay() = 0;
2373 
2374 
2400 
2426 
2455  virtual int enableSuperResolution(bool enable) = 0;
2456 
2491  virtual int enableEncryption(bool enable, NERtcEncryptionConfig config) = 0;
2492 
2522  virtual int startLastmileProbeTest(const NERtcLastmileProbeConfig& config) = 0;
2523 
2540  virtual int stopLastmileProbeTest() = 0;
2541 
2572  virtual int setRemoteHighPriorityAudioStream(bool enabled, uid_t uid) = 0;
2573 
2592  virtual int checkNECastAudioDriver() = 0;
2593 
2613  virtual int enableFaceEnhance(bool enable) = 0;
2614 
2660  virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource) = 0;
2661 
2682  virtual int setCloudProxy(int proxyType) = 0;
2683 
2684 
2685 
2686 };
2687 
2688 } //namespace nertc
2689 
2690 #endif
Definition: nertc_engine_defines.h:4291
Definition: nertc_channel.h:33
Definition: nertc_engine_ex.h:35
virtual int setLocalPublishFallbackOption(NERtcStreamFallbackOption 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 checkNECastAudioDriver()=0
virtual int setCameraCaptureConfig(const NERtcCameraCaptureConfig &config)=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 setRemoteSubscribeFallbackOption(NERtcStreamFallbackOption option)=0
virtual int adjustLoopbackRecordingSignalVolume(int volume)=0
virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle &region_rect, const NERtcScreenCaptureParameters &capture_params)=0
virtual int subscribeAllRemoteAudioStream(bool subscribe)=0
virtual void uploadSdkInfo()=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 startAudioRecordingWithConfig(const NERtcAudioRecordingConfiguration &config)=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 enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource)=0
virtual int setupLocalSubStreamVideoCanvas(NERtcVideoCanvas *canvas)=0
virtual int stopVideoPreview()=0
virtual int startLastmileProbeTest(const NERtcLastmileProbeConfig &config)=0
virtual int playEffect(uint32_t effect_id, NERtcCreateAudioEffectOption *option)=0
virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode)=0
virtual IRtcChannel * createChannel(const char *channel_name)=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 stopLastmileProbeTest()=0
virtual int startAudioRecording(const char *file_path, int sample_rate, NERtcAudioRecordingQuality quality)=0
virtual int setRemoteHighPriorityAudioStream(bool enabled, uid_t uid)=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:124
Definition: nertc_engine_media_stats_observer.h:30
Definition: nertc_engine_defines.h:5469
namespace nertc
NERtcAudioProfileType
Definition: nertc_engine_defines.h:1024
NERtcStreamFallbackOption
Definition: nertc_engine_defines.h:5894
NERtcVideoScalingMode
Definition: nertc_engine_defines.h:2025
NERtcVideoStreamType
Definition: nertc_engine_defines.h:4838
NERtcVoiceChangerType
Definition: nertc_engine_defines.h:1140
NERtcMediaPriorityType
Definition: nertc_engine_defines.h:252
NERtcAudioDumpType
Definition: nertc_engine_defines.h:6381
NERtcConnectionStateType
Definition: nertc_engine_defines.h:2154
uint64_t uid_t
Definition: nertc_engine_defines.h:134
NERtcVoiceEqualizationBand
Definition: nertc_engine_defines.h:1351
NERtcAudioRecordingQuality
Definition: nertc_engine_defines.h:5748
NERtcAudioScenarioType
Definition: nertc_engine_defines.h:1098
void * source_id_t
Definition: nertc_engine_defines.h:152
NERtcVideoMirrorMode
Definition: nertc_engine_defines.h:2064
NERtcVoiceBeautifierType
Definition: nertc_engine_defines.h:1232
Defines macro output. The file only defines macro output instead of anything else.
NERTC SDK IRtcChannel接口头文件。 NERTC SDK所有接口参数说明: 所有与字符串相关的参数(char *)全部为UTF-8编码。
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:4257
Definition: nertc_engine_defines.h:4154
Definition: nertc_engine_defines.h:5800
Definition: nertc_engine_defines.h:1491
Definition: nertc_engine_defines.h:5409
Definition: nertc_engine_defines.h:5275
Definition: nertc_engine_defines.h:4752
Definition: nertc_engine_defines.h:4665
Definition: nertc_engine_defines.h:5960
Definition: nertc_engine_defines.h:5991
Definition: nertc_engine_defines.h:847
Definition: nertc_engine_defines.h:3784
Definition: nertc_engine_defines.h:3901
Definition: nertc_engine_defines.h:4007
Definition: nertc_engine_defines.h:3403
Definition: nertc_engine_defines.h:4503
Definition: nertc_engine_defines.h:6298