NERtc Linux SDK  V4.4.9
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 {
33 class IRtcEngineEx : public IRtcEngine
34 {
35 public:
36  virtual ~IRtcEngineEx() {}
37 
49 
76  virtual int muteLocalAudioStream(bool mute) = 0;
77 
103 
131 
155 
182  virtual int setLocalVoicePitch(double pitch) = 0;
183 
206  virtual int setLocalVoiceEqualization(NERtcVoiceEqualizationBand band_frequency, int band_gain) = 0;
207 
236  virtual int subscribeRemoteAudioStream(uid_t uid, bool subscribe) = 0;
237 
262  virtual int setVideoConfig(const NERtcVideoConfig& config) = 0;
263 
294  virtual int enableDualStreamMode(bool enable) = 0;
295 
318 
342  virtual int setLocalSubStreamRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
343 
366  virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
367 
368 
391  virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode) = 0;
392 
415  virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
416 
446 
476  virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe) = 0;
477 
501  virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
502 
523  virtual int startVideoPreview() = 0;
524 
541  virtual int stopVideoPreview() = 0;
542 
575  virtual int muteLocalVideoStream(bool mute) = 0;
576 
611  virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive) = 0;
612 
629  virtual int setParameters(const char* parameters) = 0;
630 
656 
682 
683 
710  virtual int setMixedAudioFrameParameters(int sample_rate) = 0;
711 
731 
746  virtual int startAudioDump() = 0;
761  virtual int stopAudioDump() = 0;
762 
795 
814  virtual int stopAudioMixing() = 0;
815 
834  virtual int pauseAudioMixing() = 0;
835 
854  virtual int resumeAudioMixing() = 0;
855 
876  virtual int setAudioMixingSendVolume(uint32_t volume) = 0;
877 
898  virtual int getAudioMixingSendVolume(uint32_t *volume) = 0;
899 
920  virtual int setAudioMixingPlaybackVolume(uint32_t volume) = 0;
921 
942  virtual int getAudioMixingPlaybackVolume(uint32_t *volume) = 0;
943 
964  virtual int getAudioMixingDuration(uint64_t *duration) = 0;
965 
986  virtual int getAudioMixingCurrentPosition(uint64_t *position) = 0;
987 
1008  virtual int setAudioMixingPosition(uint64_t seek_position) = 0;
1009 
1040  virtual int playEffect(uint32_t effect_id, NERtcCreateAudioEffectOption *option) = 0;
1041 
1062  virtual int stopEffect(uint32_t effect_id) = 0;
1063 
1080  virtual int stopAllEffects() = 0;
1081 
1102  virtual int pauseEffect(uint32_t effect_id) = 0;
1103 
1124  virtual int resumeEffect(uint32_t effect_id) = 0;
1125 
1144  virtual int pauseAllEffects() = 0;
1145 
1164  virtual int resumeAllEffects() = 0;
1165 
1188  virtual int setEffectSendVolume(uint32_t effect_id, uint32_t volume) = 0;
1211  virtual int getEffectSendVolume(uint32_t effect_id, uint32_t *volume) = 0;
1212 
1235  virtual int setEffectPlaybackVolume(uint32_t effect_id, uint32_t volume) = 0;
1236 
1259  virtual int getEffectPlaybackVolume(uint32_t effect_id, uint32_t *volume) = 0;
1260 
1297  virtual int enableLoopbackRecording(bool enabled, const char *device_name) = 0;
1298 
1321  virtual int adjustLoopbackRecordingSignalVolume(int volume) = 0;
1322 
1347  virtual int enableEarback(bool enabled, uint32_t volume) = 0;
1348 
1367  virtual int setEarbackVolume(uint32_t volume) = 0;
1368 
1385  virtual int setStatsObserver(IRtcMediaStatsObserver *observer) = 0;
1386 
1409  virtual int enableAudioVolumeIndication(bool enable, uint64_t interval) = 0;
1410 
1442  virtual int startScreenCaptureByScreenRect(const NERtcRectangle& screen_rect, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
1443 
1473  virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
1474 
1507  virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
1508 
1527  virtual int updateScreenCaptureRegion(const NERtcRectangle& region_rect) = 0;
1528 
1548  virtual int stopScreenCapture() = 0;
1549 
1567  virtual int pauseScreenCapture() = 0;
1568 
1584  virtual int resumeScreenCapture() = 0;
1585 
1586 
1614  virtual int setExcludeWindowList(source_id_t* window_list, int count) = 0;
1615 
1640  virtual int setExternalVideoSource(bool enabled) = 0;
1641 
1662  virtual int pushExternalVideoFrame(NERtcVideoFrame* frame) = 0;
1663 
1664 
1705  virtual int setExternalAudioSource(bool enabled, int sample_rate, int channels) = 0;
1706 
1737  virtual int pushExternalAudioFrame(NERtcAudioFrame* frame) = 0;
1738 
1783  virtual int setExternalAudioRender(bool enabled, int sample_rate, int channels) = 0;
1784 
1817  virtual int pullExternalAudioFrame(void* data, int len) = 0;
1818 
1833  virtual const char* getVersion(int* build) = 0;
1834 
1849  virtual const char* getErrorDescription(int error_code) = 0;
1850 
1865  virtual void uploadSdkInfo() = 0;
1866 
1895  virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1896 
1921  virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
1922 
1949  virtual int removeLiveStreamTask(const char* task_id) = 0;
1950 
1987  virtual int sendSEIMsg(const char* data, int length, NERtcVideoStreamType type) = 0;
1988 
2025  virtual int sendSEIMsg(const char* data, int length) = 0;
2026 
2057 
2091 
2122  virtual int takeLocalSnapshot(NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
2123 
2154  virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
2155 
2156 
2199  virtual int startAudioRecording(const char* file_path, int sample_rate, NERtcAudioRecordingQuality quality) = 0;
2200 
2221  virtual int stopAudioRecording() = 0;
2222 
2257  virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
2258 
2289 
2315 
2336  virtual int stopChannelMediaRelay() = 0;
2337 
2338 
2366 
2394 
2425  virtual int enableSuperResolution(bool enable) = 0;
2426 
2463  virtual int enableEncryption(bool enable, NERtcEncryptionConfig config) = 0;
2464 };
2465 
2466 } //namespace nertc
2467 
2468 #endif
Definition: nertc_engine_defines.h:4188
Definition: nertc_engine_ex.h:34
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 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 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 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:124
Definition: nertc_engine_media_stats_observer.h:30
Definition: nertc_engine_defines.h:5276
namespace nertc
NERtcAudioProfileType
Definition: nertc_engine_defines.h:986
NERtcStreamFallbackOption
Definition: nertc_engine_defines.h:5617
NERtcVideoScalingMode
Definition: nertc_engine_defines.h:1985
NERtcVideoStreamType
Definition: nertc_engine_defines.h:4683
NERtcVoiceChangerType
Definition: nertc_engine_defines.h:1102
NERtcMediaPriorityType
Definition: nertc_engine_defines.h:251
NERtcConnectionStateType
Definition: nertc_engine_defines.h:2114
uint64_t uid_t
Definition: nertc_engine_defines.h:133
NERtcVoiceEqualizationBand
Definition: nertc_engine_defines.h:1313
NERtcAudioRecordingQuality
Definition: nertc_engine_defines.h:5519
NERtcAudioScenarioType
Definition: nertc_engine_defines.h:1060
void * source_id_t
Definition: nertc_engine_defines.h:151
NERtcVideoMirrorMode
Definition: nertc_engine_defines.h:2024
NERtcVoiceBeautifierType
Definition: nertc_engine_defines.h:1194
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:4156
Definition: nertc_engine_defines.h:4062
Definition: nertc_engine_defines.h:5219
Definition: nertc_engine_defines.h:5091
Definition: nertc_engine_defines.h:4606
Definition: nertc_engine_defines.h:4528
Definition: nertc_engine_defines.h:5683
Definition: nertc_engine_defines.h:815
Definition: nertc_engine_defines.h:3713
Definition: nertc_engine_defines.h:3824
Definition: nertc_engine_defines.h:3917
Definition: nertc_engine_defines.h:3414
Definition: nertc_engine_defines.h:4374