NERtc Windows SDK
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 
161  virtual int setVideoConfig(const NERtcVideoConfig& config) = 0;
162 
179  virtual int enableDualStreamMode(bool enable) = 0;
180 
191 
203  virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
204 
216  virtual int setLocalSubStreamRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
217 
230  virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode) = 0;
231 
242  virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
243 
260 
276  virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe) = 0;
277 
288  virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
289 
302  virtual int startVideoPreview() = 0;
303 
312  virtual int stopVideoPreview() = 0;
313 
332  virtual int muteLocalVideoStream(bool mute) = 0;
333 
352  virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive) = 0;
353 
362  virtual int setParameters(const char* parameters) = 0;
363 
379 
395 
396 
412  virtual int setMixedAudioFrameParameters(int sample_rate) = 0;
413 
425 
432  virtual int startAudioDump() = 0;
439  virtual int stopAudioDump() = 0;
440 
460 
469  virtual int stopAudioMixing() = 0;
470 
479  virtual int pauseAudioMixing() = 0;
480 
489  virtual int resumeAudioMixing() = 0;
490 
501  virtual int setAudioMixingSendVolume(uint32_t volume) = 0;
502 
513  virtual int getAudioMixingSendVolume(uint32_t *volume) = 0;
514 
525  virtual int setAudioMixingPlaybackVolume(uint32_t volume) = 0;
526 
537  virtual int getAudioMixingPlaybackVolume(uint32_t *volume) = 0;
538 
549  virtual int getAudioMixingDuration(uint64_t *duration) = 0;
550 
561  virtual int getAudioMixingCurrentPosition(uint64_t *position) = 0;
562 
573  virtual int setAudioMixingPosition(uint64_t seek_position) = 0;
574 
591  virtual int playEffect(uint32_t effect_id, NERtcCreateAudioEffectOption *option) = 0;
592 
603  virtual int stopEffect(uint32_t effect_id) = 0;
604 
611  virtual int stopAllEffects() = 0;
612 
623  virtual int pauseEffect(uint32_t effect_id) = 0;
624 
635  virtual int resumeEffect(uint32_t effect_id) = 0;
636 
645  virtual int pauseAllEffects() = 0;
646 
655  virtual int resumeAllEffects() = 0;
656 
668  virtual int setEffectSendVolume(uint32_t effect_id, uint32_t volume) = 0;
680  virtual int getEffectSendVolume(uint32_t effect_id, uint32_t *volume) = 0;
681 
693  virtual int setEffectPlaybackVolume(uint32_t effect_id, uint32_t volume) = 0;
694 
706  virtual int getEffectPlaybackVolume(uint32_t effect_id, uint32_t *volume) = 0;
707 
729  virtual int enableLoopbackRecording(bool enabled, const char *device_name) = 0;
730 
743  virtual int adjustLoopbackRecordingSignalVolume(int volume) = 0;
744 
761  virtual int enableEarback(bool enabled, uint32_t volume) = 0;
762 
773  virtual int setEarbackVolume(uint32_t volume) = 0;
774 
783  virtual int setStatsObserver(IRtcMediaStatsObserver *observer) = 0;
784 
798  virtual int enableAudioVolumeIndication(bool enable, uint64_t interval) = 0;
799 
818  virtual int startScreenCaptureByScreenRect(const NERtcRectangle& screen_rect, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
819 
837  virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
838 
857  virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
858 
866  virtual int updateScreenCaptureRegion(const NERtcRectangle& region_rect) = 0;
867 
876  virtual int stopScreenCapture() = 0;
877 
884  virtual int pauseScreenCapture() = 0;
885 
892  virtual int resumeScreenCapture() = 0;
893 
894 
903  virtual int setExcludeWindowList(source_id_t* window_list, int count) = 0;
904 
919  virtual int setExternalVideoSource(bool enabled) = 0;
920 
933  virtual int pushExternalVideoFrame(NERtcVideoFrame* frame) = 0;
934 
935 
958  virtual int setExternalAudioSource(bool enabled, int sample_rate, int channels) = 0;
959 
977  virtual int pushExternalAudioFrame(NERtcAudioFrame* frame) = 0;
978 
1003  virtual int setExternalAudioRender(bool enabled, int sample_rate, int channels) = 0;
1004 
1023  virtual int pullExternalAudioFrame(void* data, int len) = 0;
1024 
1032  virtual const char* getVersion(int* build) = 0;
1033 
1042  virtual const char* getErrorDescription(int error_code) = 0;
1043 
1050  virtual void uploadSdkInfo() = 0;
1051 
1063  virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1064 
1074  virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1075 
1086  virtual int removeLiveStreamTask(const char* task_id) = 0;
1087 
1109  virtual int sendSEIMsg(const char* data, int length, NERtcVideoStreamType type) = 0;
1110 
1132  virtual int sendSEIMsg(const char* data, int length) = 0;
1133 
1150 
1168 
1185  virtual int takeLocalSnapshot(NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
1186 
1203  virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
1204 
1205 
1229  virtual int startAudioRecording(const char* file_path, int sample_rate, NERtcAudioRecordingQuality quality) = 0;
1230 
1241  virtual int stopAudioRecording() = 0;
1242 
1261  virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
1262 
1269 
1276 
1281  virtual int stopChannelMediaRelay() = 0;
1282 
1283 
1296  virtual int setLocalPublishFallbackOption(int option) = 0;
1297 
1311  virtual int setRemoteSubscribeFallbackOption(int option) = 0;
1312 
1330  virtual int enableSuperResolution(bool enable) = 0;
1331 
1351  virtual int enableEncryption(bool enable, NERtcEncryptionConfig config) = 0;
1352 };
1353 
1354 } //namespace nertc
1355 
1356 #endif
Definition: nertc_engine_defines.h:958
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 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:1239
namespace nertc
NERtcAudioProfileType
Definition: nertc_engine_defines.h:326
NERtcVideoScalingMode
Definition: nertc_engine_defines.h:489
NERtcVideoStreamType
Definition: nertc_engine_defines.h:1122
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:1285
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
定义导出宏。该文件只定义导出宏,不定义其他任何东西!
SDK基本类型定义
NERTC SDK接口头文件。 NERTC SDK所有接口参数说明: 所有与字符串相关的参数(char *)全部为UTF-8编码。
NERtc SDK的一些定义
NERTC SDK回调接口头文件。 NERTC SDK所有接口参数说明: 所有与字符串相关的参数(char *)全部为UTF-8编码。
NERTC SDK回调扩展接口头文件。 NERTC SDK所有接口参数说明: 所有与字符串相关的参数(char *)全部为UTF-8编码。
Definition: nertc_engine_defines.h:949
Definition: nertc_engine_defines.h:933
Definition: nertc_engine_defines.h:1229
Definition: nertc_engine_defines.h:1205
Definition: nertc_engine_defines.h:1087
Definition: nertc_engine_defines.h:1051
Definition: nertc_engine_defines.h:1329
Definition: nertc_engine_defines.h:278
Definition: nertc_engine_defines.h:841
Definition: nertc_engine_defines.h:872
Definition: nertc_engine_defines.h:886
Definition: nertc_engine_defines.h:735
Definition: nertc_engine_defines.h:1022