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 
300  virtual int subscribeAllRemoteAudioStream(bool subscribe) = 0;
301 
328  virtual int setVideoConfig(const NERtcVideoConfig& config) = 0;
329 
358  virtual int enableDualStreamMode(bool enable) = 0;
359 
382 
404  virtual int setLocalSubStreamRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
405 
426  virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
427 
428 
449  virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode) = 0;
450 
471  virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
472 
502 
532  virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe) = 0;
533 
555  virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
556 
577  virtual int startVideoPreview() = 0;
578 
595  virtual int stopVideoPreview() = 0;
596 
630  virtual int muteLocalVideoStream(bool mute) = 0;
631 
664  virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive) = 0;
665 
682  virtual int setParameters(const char* parameters) = 0;
683 
709 
735 
736 
763  virtual int setMixedAudioFrameParameters(int sample_rate) = 0;
764 
784 
799  virtual int startAudioDump() = 0;
800 
801  virtual int startAudioDump(NERtcAudioDumpType type) = 0;
802 
817  virtual int stopAudioDump() = 0;
818 
849 
866  virtual int stopAudioMixing() = 0;
867 
884  virtual int pauseAudioMixing() = 0;
885 
902  virtual int resumeAudioMixing() = 0;
903 
922  virtual int setAudioMixingSendVolume(uint32_t volume) = 0;
923 
942  virtual int getAudioMixingSendVolume(uint32_t *volume) = 0;
943 
962  virtual int setAudioMixingPlaybackVolume(uint32_t volume) = 0;
963 
982  virtual int getAudioMixingPlaybackVolume(uint32_t *volume) = 0;
983 
1002  virtual int getAudioMixingDuration(uint64_t *duration) = 0;
1003 
1022  virtual int getAudioMixingCurrentPosition(uint64_t *position) = 0;
1023 
1042  virtual int setAudioMixingPosition(uint64_t seek_position) = 0;
1043 
1072  virtual int playEffect(uint32_t effect_id, NERtcCreateAudioEffectOption *option) = 0;
1073 
1092  virtual int stopEffect(uint32_t effect_id) = 0;
1093 
1109  virtual int stopAllEffects() = 0;
1110 
1129  virtual int pauseEffect(uint32_t effect_id) = 0;
1130 
1149  virtual int resumeEffect(uint32_t effect_id) = 0;
1150 
1167  virtual int pauseAllEffects() = 0;
1168 
1185  virtual int resumeAllEffects() = 0;
1186 
1207  virtual int setEffectSendVolume(uint32_t effect_id, uint32_t volume) = 0;
1228  virtual int getEffectSendVolume(uint32_t effect_id, uint32_t *volume) = 0;
1229 
1250  virtual int setEffectPlaybackVolume(uint32_t effect_id, uint32_t volume) = 0;
1251 
1272  virtual int getEffectPlaybackVolume(uint32_t effect_id, uint32_t *volume) = 0;
1273 
1308  virtual int enableLoopbackRecording(bool enabled, const char *device_name) = 0;
1309 
1330  virtual int adjustLoopbackRecordingSignalVolume(int volume) = 0;
1331 
1356  virtual int enableEarback(bool enabled, uint32_t volume) = 0;
1357 
1376  virtual int setEarbackVolume(uint32_t volume) = 0;
1377 
1394  virtual int setStatsObserver(IRtcMediaStatsObserver *observer) = 0;
1395 
1418  virtual int enableAudioVolumeIndication(bool enable, uint64_t interval) = 0;
1419 
1451  virtual int startScreenCaptureByScreenRect(const NERtcRectangle& screen_rect, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
1452 
1482  virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
1483 
1516  virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
1517 
1536  virtual int updateScreenCaptureRegion(const NERtcRectangle& region_rect) = 0;
1537 
1557  virtual int stopScreenCapture() = 0;
1558 
1576  virtual int pauseScreenCapture() = 0;
1577 
1593  virtual int resumeScreenCapture() = 0;
1594 
1595 
1625  virtual int setExcludeWindowList(source_id_t* window_list, int count) = 0;
1626 
1651  virtual int setExternalVideoSource(bool enabled) = 0;
1652 
1673  virtual int pushExternalVideoFrame(NERtcVideoFrame* frame) = 0;
1674 
1675 
1716  virtual int setExternalAudioSource(bool enabled, int sample_rate, int channels) = 0;
1717 
1746  virtual int pushExternalAudioFrame(NERtcAudioFrame* frame) = 0;
1747 
1792  virtual int setExternalAudioRender(bool enabled, int sample_rate, int channels) = 0;
1793 
1826  virtual int pullExternalAudioFrame(void* data, int len) = 0;
1827 
1842  virtual const char* getVersion(int* build) = 0;
1843 
1858  virtual const char* getErrorDescription(int error_code) = 0;
1859 
1874  virtual void uploadSdkInfo() = 0;
1875 
1902  virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1903 
1926  virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1927 
1952  virtual int removeLiveStreamTask(const char* task_id) = 0;
1953 
1990  virtual int sendSEIMsg(const char* data, int length, NERtcVideoStreamType type) = 0;
1991 
2028  virtual int sendSEIMsg(const char* data, int length) = 0;
2029 
2058 
2090 
2119  virtual int takeLocalSnapshot(NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
2120 
2149  virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
2150 
2151 
2194  virtual int startAudioRecording(const char* file_path, int sample_rate, NERtcAudioRecordingQuality quality) = 0;
2195 
2196 
2222 
2241  virtual int stopAudioRecording() = 0;
2242 
2275  virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
2276 
2305 
2329 
2348  virtual int stopChannelMediaRelay() = 0;
2349 
2350 
2376 
2402 
2431  virtual int enableSuperResolution(bool enable) = 0;
2432 
2467  virtual int enableEncryption(bool enable, NERtcEncryptionConfig config) = 0;
2468 
2498  virtual int startLastmileProbeTest(const NERtcLastmileProbeConfig& config) = 0;
2499 
2516  virtual int stopLastmileProbeTest() = 0;
2517 
2534  virtual int setRemoteHighPriorityAudioStream(bool enabled, uid_t uid) = 0;
2535 
2554  virtual int checkNECastAudioDriver() = 0;
2555 
2567  virtual int enableFaceEnhance(bool enable) = 0;
2568 
2614  virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource) = 0;
2615 
2636  virtual int setCloudProxy(int proxyType) = 0;
2637 
2638 
2639 
2640 };
2641 
2642 } //namespace nertc
2643 
2644 #endif
Definition: nertc_engine_defines.h:4288
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 enableFaceEnhance(bool enable)=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:5466
namespace nertc
NERtcAudioProfileType
Definition: nertc_engine_defines.h:1024
NERtcStreamFallbackOption
Definition: nertc_engine_defines.h:5891
NERtcVideoScalingMode
Definition: nertc_engine_defines.h:2025
NERtcVideoStreamType
Definition: nertc_engine_defines.h:4835
NERtcVoiceChangerType
Definition: nertc_engine_defines.h:1140
NERtcMediaPriorityType
Definition: nertc_engine_defines.h:252
NERtcAudioDumpType
Definition: nertc_engine_defines.h:6373
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:5745
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:4254
Definition: nertc_engine_defines.h:4151
Definition: nertc_engine_defines.h:5797
Definition: nertc_engine_defines.h:1491
Definition: nertc_engine_defines.h:5406
Definition: nertc_engine_defines.h:5272
Definition: nertc_engine_defines.h:4749
Definition: nertc_engine_defines.h:4662
Definition: nertc_engine_defines.h:5957
Definition: nertc_engine_defines.h:5988
Definition: nertc_engine_defines.h:847
Definition: nertc_engine_defines.h:3784
Definition: nertc_engine_defines.h:3901
Definition: nertc_engine_defines.h:4004
Definition: nertc_engine_defines.h:3403
Definition: nertc_engine_defines.h:4500
Definition: nertc_engine_defines.h:6295