NERtc Windows SDK  V4.6.53
nertc_channel.h
浏览该文件的文档.
1 
8 #ifndef NERTC_CHANNEL_H
9 #define NERTC_CHANNEL_H
10 
11 #include "nertc_base.h"
12 #include "nertc_base_types.h"
13 #include "nertc_engine_defines.h"
16 
21 namespace nertc
22 {
23 
33 {
34 public:
35  virtual ~IRtcChannel() {}
36 
47  virtual void release() = 0;
48 
65  virtual const char* getChannelName() = 0;
66 
89 
147  virtual int joinChannel(const char* token) = 0;
148 
198  virtual int joinChannel(const char* token, NERtcJoinChannelOptions channel_options) = 0;
199 
240  virtual int leaveChannel() = 0;
241 
260  virtual int setStatsObserver(IRtcMediaStatsObserver* observer) = 0;
261 
321  virtual int enableLocalAudio(bool enabled) = 0;
322 
349  virtual int enableLocalSubStreamAudio(bool enabled) = 0;
350 
410  virtual int muteLocalAudioStream(bool mute) = 0;
411 
438  virtual int muteLocalSubStreamAudio(bool mute) = 0;
439 
498  virtual int enableLocalVideo(bool enabled) = 0;
499 
564  virtual int enableLocalVideo(NERtcVideoStreamType type, bool enabled) = 0;
565 
566 
625  virtual int muteLocalVideoStream(bool mute) = 0;
626 
685  virtual int muteLocalVideoStream(NERtcVideoStreamType type, bool mute) = 0;
686 
720  virtual int startScreenCaptureByScreenRect(const NERtcRectangle& screen_rect, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
721 
753  virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
754 
789  virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
790 
811  virtual int updateScreenCaptureRegion(const NERtcRectangle& region_rect) = 0;
812 
835  virtual int setScreenCaptureMouseCursor(bool capture_cursor) = 0;
836 
872  virtual int stopScreenCapture() = 0;
873 
893  virtual int pauseScreenCapture() = 0;
894 
912  virtual int resumeScreenCapture() = 0;
913 
914 
940  virtual int setExcludeWindowList(source_id_t* window_list, int count) = 0;
941 
985 
1039  virtual int setupLocalVideoCanvas(NERtcVideoCanvas* canvas) = 0;
1040 
1041 
1066 
1110  virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
1111 
1136 
1162  virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode) = 0;
1163 
1215 
1276  virtual int setupRemoteVideoCanvas(uid_t uid, NERtcVideoCanvas* canvas) = 0;
1277 
1343 
1366  virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
1367 
1391  virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
1392 
1456  virtual int setClientRole(NERtcClientRole role) = 0;
1457 
1515  virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive) = 0;
1516 
1530 
1586  virtual int setCameraCaptureConfig(const NERtcCameraCaptureConfig& config) = 0;
1587 
1639 
1701  virtual int setVideoConfig(const NERtcVideoConfig& config) = 0;
1702 
1755  virtual int setVideoConfig(NERtcVideoStreamType type, const NERtcVideoConfig& config) = 0;
1756 
1757 
1807  virtual int enableDualStreamMode(bool enable) = 0;
1808 
1867  virtual int subscribeRemoteAudioStream(uid_t uid, bool subscribe) = 0;
1868 
1928  virtual int subscribeRemoteSubStreamAudio(uid_t uid, bool subscribe) = 0;
1929 
1980  virtual int subscribeAllRemoteAudioStream(bool subscribe) = 0;
1981 
2012  virtual int setAudioSubscribeOnlyBy(uid_t* uid_array, uint32_t size) = 0;
2013 
2077  virtual int subscribeRemoteVideoStream(uid_t uid, NERtcRemoteVideoStreamType type, bool subscribe) = 0;
2078 
2142  virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe) = 0;
2143 
2228  virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
2229 
2282  virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
2283 
2338  virtual int removeLiveStreamTask(const char* task_id) = 0;
2339 
2378  virtual int sendSEIMsg(const char* data, int length, NERtcVideoStreamType type) = 0;
2379 
2418  virtual int sendSEIMsg(const char* data, int length) = 0;
2419 
2450 
2515 
2546  virtual int takeLocalSnapshot(NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
2547 
2578  virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
2579 
2637  virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
2638 
2668  virtual int adjustChannelPlaybackSignalVolume(uint32_t volume) = 0;
2669 
2699 
2723 
2753  virtual int stopChannelMediaRelay() = 0;
2754 
2780 
2806 
2839  virtual int setRemoteHighPriorityAudioStream(bool enabled, uid_t uid) = 0;
2840 
2881  virtual int enableMediaPub(bool enabled, NERtcMediaPubType media_type) = 0;
2882 
2923  virtual int updatePermissionKey(const char* key) = 0;
2924 };
2925 } //namespace nertc
2926 
2927 #endif
Definition: nertc_channel_event_handler.h:34
Definition: nertc_channel.h:33
virtual int enableDualStreamMode(bool enable)=0
virtual int muteLocalVideoStream(bool mute)=0
virtual int subscribeAllRemoteAudioStream(bool subscribe)=0
virtual int setChannelEventHandler(IRtcChannelEventHandler *handler)=0
virtual int stopChannelMediaRelay()=0
virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode)=0
virtual int setupRemoteVideoCanvas(uid_t uid, NERtcVideoCanvas *canvas)=0
virtual int setClientRole(NERtcClientRole role)=0
virtual int sendSEIMsg(const char *data, int length)=0
virtual int resumeScreenCapture()=0
virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo &info)=0
virtual int subscribeRemoteVideoStream(uid_t uid, NERtcRemoteVideoStreamType type, bool subscribe)=0
virtual int sendSEIMsg(const char *data, int length, NERtcVideoStreamType type)=0
virtual int setupLocalVideoCanvas(NERtcVideoCanvas *canvas)=0
virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo &info)=0
virtual int startScreenCaptureByDisplayId(unsigned int display_id, const NERtcRectangle &region_rect, const NERtcScreenCaptureParameters &capture_params)=0
virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode)=0
virtual int setScreenCaptureMouseCursor(bool capture_cursor)=0
virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle &region_rect, const NERtcScreenCaptureParameters &capture_params)=0
virtual int setStatsObserver(IRtcMediaStatsObserver *observer)=0
virtual int subscribeRemoteAudioStream(uid_t uid, bool subscribe)=0
virtual int enableLocalVideo(NERtcVideoStreamType type, bool enabled)=0
virtual int muteLocalAudioStream(bool mute)=0
virtual int setLocalPublishFallbackOption(NERtcStreamFallbackOption option)=0
virtual int takeLocalSnapshot(NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback)=0
virtual int setRemoteSubscribeFallbackOption(NERtcStreamFallbackOption option)=0
virtual int muteLocalVideoStream(NERtcVideoStreamType type, bool mute)=0
virtual int updateScreenCaptureParameters(const nertc::NERtcScreenCaptureParameters &captureParams)=0
virtual int setupRemoteSubStreamVideoCanvas(uid_t uid, NERtcVideoCanvas *canvas)=0
virtual int setCameraCaptureConfig(NERtcVideoStreamType type, const NERtcCameraCaptureConfig &config)=0
virtual NERtcConnectionStateType getConnectionState()=0
virtual int muteLocalSubStreamAudio(bool mute)=0
virtual int setRemoteHighPriorityAudioStream(bool enabled, uid_t uid)=0
virtual int pauseScreenCapture()=0
virtual int setLocalCanvasWatermarkConfigs(NERtcVideoStreamType type, NERtcCanvasWatermarkConfig &config)=0
virtual int setRemoteCanvasWatermarkConfigs(uid_t uid, NERtcVideoStreamType type, NERtcCanvasWatermarkConfig &config)=0
virtual int setVideoConfig(NERtcVideoStreamType type, const NERtcVideoConfig &config)=0
virtual int setAudioSubscribeOnlyBy(uid_t *uid_array, uint32_t size)=0
virtual int adjustChannelPlaybackSignalVolume(uint32_t volume)=0
virtual int stopScreenCapture()=0
virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode)=0
virtual int setExcludeWindowList(source_id_t *window_list, int count)=0
virtual const char * getChannelName()=0
virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode)=0
virtual int updatePermissionKey(const char *key)=0
virtual int enableLocalVideo(bool enabled)=0
virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume)=0
virtual int enableLocalSubStreamAudio(bool enabled)=0
virtual int startChannelMediaRelay(NERtcChannelMediaRelayConfiguration *config)=0
virtual int enableLocalAudio(bool enabled)=0
virtual int leaveChannel()=0
virtual int setLocalSubStreamRenderMode(NERtcVideoScalingMode scaling_mode)=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 joinChannel(const char *token)=0
virtual int subscribeRemoteSubStreamAudio(uid_t uid, bool subscribe)=0
virtual int joinChannel(const char *token, NERtcJoinChannelOptions channel_options)=0
virtual void release()=0
virtual int enableMediaPub(bool enabled, NERtcMediaPubType media_type)=0
virtual int updateChannelMediaRelay(NERtcChannelMediaRelayConfiguration *config)=0
virtual int updateScreenCaptureRegion(const NERtcRectangle &region_rect)=0
virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive)=0
virtual int setCameraCaptureConfig(const NERtcCameraCaptureConfig &config)=0
virtual int setVideoConfig(const NERtcVideoConfig &config)=0
virtual int setLocalVideoMirrorMode(NERtcVideoStreamType type, NERtcVideoMirrorMode mirror_mode)=0
virtual int setupLocalSubStreamVideoCanvas(NERtcVideoCanvas *canvas)=0
virtual int removeLiveStreamTask(const char *task_id)=0
virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback)=0
Definition: nertc_engine_media_stats_observer.h:30
Definition: nertc_engine_defines.h:6535
namespace nertc
NERtcClientRole
Definition: nertc_engine_defines.h:244
NERtcStreamFallbackOption
Definition: nertc_engine_defines.h:7066
NERtcVideoScalingMode
Definition: nertc_engine_defines.h:2074
NERtcVideoStreamType
Definition: nertc_engine_defines.h:5456
NERtcMediaPriorityType
Definition: nertc_engine_defines.h:306
NERtcConnectionStateType
Definition: nertc_engine_defines.h:2205
uint64_t uid_t
Definition: nertc_engine_defines.h:183
void * source_id_t
Definition: nertc_engine_defines.h:204
NERtcVideoMirrorMode
Definition: nertc_engine_defines.h:2116
NERtcMediaPubType
Definition: nertc_engine_defines.h:7749
NERtcRemoteVideoStreamType
Definition: nertc_engine_defines.h:1698
Defines macro output. The file only defines macro output instead of anything else.
NERTC SDK IRtcChannel回调接口头文件。 NERTC SDK所有接口参数说明: 所有与字符串相关的参数(char *)全部为UTF-8编码。
NERtc SDK definitions.
The interface header file of expansion callback of the NERTC SDK. All parameter descriptions of the N...
Definition: nertc_engine_defines.h:1572
Definition: nertc_engine_defines.h:6036
Definition: nertc_engine_defines.h:5893
Definition: nertc_engine_defines.h:7710
Definition: nertc_engine_defines.h:964
Definition: nertc_engine_defines.h:3942
Definition: nertc_engine_defines.h:4066
Definition: nertc_engine_defines.h:4195
Definition: nertc_engine_defines.h:3561