NERtc macOS SDK V5.6.20
载入中...
搜索中...
未找到
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"
16
21namespace nertc
22{
23
33{
34public:
35 virtual ~IRtcChannel() {}
36
47 virtual void release() = 0;
48
65 virtual const char* getChannelName() = 0;
66
89
148 virtual int joinChannel(const char* token) = 0;
149
213 virtual int joinChannel(const char* token, uid_t uid) = 0;
214
273 virtual int joinChannel(const char* token, uid_t uid, NERtcJoinChannelOptions channel_options) = 0;
274
315 virtual int leaveChannel() = 0;
316
335 virtual int setStatsObserver(IRtcMediaStatsObserver* observer) = 0;
336
396 virtual int enableLocalAudio(bool enabled) = 0;
397
424 virtual int enableLocalSubStreamAudio(bool enabled) = 0;
425
485 virtual int muteLocalAudioStream(bool mute) = 0;
486
513 virtual int muteLocalSubStreamAudio(bool mute) = 0;
514
573 virtual int enableLocalVideo(bool enabled) = 0;
574
639 virtual int enableLocalVideo(NERtcVideoStreamType type, bool enabled) = 0;
640
641
700 virtual int muteLocalVideoStream(bool mute) = 0;
701
760 virtual int muteLocalVideoStream(NERtcVideoStreamType type, bool mute) = 0;
761
789 virtual IScreenCaptureSourceList* getScreenCaptureSources(const NERtcSize& thumbSize, const NERtcSize& iconSize, const bool includeScreen) = 0;
790
824 virtual int startScreenCaptureByScreenRect(const NERtcRectangle& screen_rect, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
825
857 virtual int startScreenCaptureByDisplayId(source_id_t display_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
858
893 virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
894
909 virtual int32_t setScreenCaptureSource(const NERtcScreenCaptureSourceInfo& source, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
910
931 virtual int updateScreenCaptureRegion(const NERtcRectangle& region_rect) = 0;
932
955 virtual int setScreenCaptureMouseCursor(bool capture_cursor) = 0;
956
992 virtual int stopScreenCapture() = 0;
993
1013 virtual int pauseScreenCapture() = 0;
1014
1032 virtual int resumeScreenCapture() = 0;
1033
1034
1060 virtual int setExcludeWindowList(source_id_t* window_list, int count) = 0;
1061
1105
1159 virtual int setupLocalVideoCanvas(NERtcVideoCanvas* canvas) = 0;
1160
1161
1186
1230 virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
1231
1256
1282 virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode) = 0;
1283
1335
1396 virtual int setupRemoteVideoCanvas(uid_t uid, NERtcVideoCanvas* canvas) = 0;
1397
1463
1486 virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
1487
1511 virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
1512
1576 virtual int setClientRole(NERtcClientRole role) = 0;
1577
1635 virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive) = 0;
1636
1650
1706 virtual int setCameraCaptureConfig(const NERtcCameraCaptureConfig& config) = 0;
1707
1759
1821 virtual int setVideoConfig(const NERtcVideoConfig& config) = 0;
1822
1875 virtual int setVideoConfig(NERtcVideoStreamType type, const NERtcVideoConfig& config) = 0;
1876
1926 virtual int enableDualStreamMode(bool enable) = 0;
1927
1986 virtual int subscribeRemoteAudioStream(uid_t uid, bool subscribe) = 0;
1987
2047 virtual int subscribeRemoteSubStreamAudio(uid_t uid, bool subscribe) = 0;
2048
2099 virtual int subscribeAllRemoteAudioStream(bool subscribe) = 0;
2100
2131 virtual int setAudioSubscribeOnlyBy(uid_t* uid_array, uint32_t size) = 0;
2132
2148 virtual int setSubscribeAudioAllowlist(uid_t* uid_array, uint32_t size) = 0;
2149
2165 virtual int setSubscribeAudioBlocklist(NERtcAudioStreamType type, uid_t* uid_array, uint32_t size) = 0;
2166
2230 virtual int subscribeRemoteVideoStream(uid_t uid, NERtcRemoteVideoStreamType type, bool subscribe) = 0;
2231
2295 virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe) = 0;
2296
2381 virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
2382
2435 virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
2436
2490 virtual int removeLiveStreamTask(const char* task_id) = 0;
2491
2530 virtual int sendSEIMsg(const char* data, int length, NERtcVideoStreamType type) = 0;
2531
2570 virtual int sendSEIMsg(const char* data, int length) = 0;
2571
2603
2634 virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
2635
2694 virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
2695
2725 virtual int adjustChannelPlaybackSignalVolume(uint32_t volume) = 0;
2726
2756
2780
2810 virtual int stopChannelMediaRelay() = 0;
2811
2837
2863
2896 virtual int setRemoteHighPriorityAudioStream(bool enabled, uid_t uid) = 0;
2897
2922 virtual int setExternalVideoSource(bool enabled) = 0;
2923
2951 virtual int setExternalVideoSource(NERtcVideoStreamType type, bool enabled) = 0;
2952
2974
2996
2997
3038 virtual int enableMediaPub(bool enabled, NERtcMediaPubType media_type) = 0;
3039
3082 virtual int updatePermissionKey(const char* key) = 0;
3092 virtual int reportCustomEvent(const char* event_name, const char* custom_identify, const char* parameters) = 0;
3156 virtual int enableAudioVolumeIndication(bool enable, uint64_t interval, bool enable_vad) = 0;
3157
3169
3180 virtual int setRangeAudioTeamID(int32_t team_id) = 0;
3181
3197 virtual int setAudioRecvRange(int audible_distance, int conversational_distance, NERtcDistanceRolloffModel roll_off) = 0;
3198
3232 virtual int updateSelfPosition(const NERtcPositionInfo& info) = 0;
3233
3247 virtual int enableSpatializerRoomEffects(bool enable) = 0;
3248
3262 virtual int setSpatializerRoomProperty(const NERtcSpatializerRoomProperty& room_property) = 0;
3263
3278
3288 virtual int initSpatializer() = 0;
3289
3309 virtual int enableSpatializer(bool enable, bool apply_to_team) = 0;
3310};
3311} //namespace nertc
3312
3313#endif
Definition nertc_channel_event_handler.h:34
Definition nertc_channel.h:33
virtual int enableDualStreamMode(bool enable)=0
virtual int setSpatializerRoomProperty(const NERtcSpatializerRoomProperty &room_property)=0
virtual int muteLocalVideoStream(bool mute)=0
virtual int subscribeAllRemoteAudioStream(bool subscribe)=0
virtual int setChannelEventHandler(IRtcChannelEventHandler *handler)=0
virtual IScreenCaptureSourceList * getScreenCaptureSources(const NERtcSize &thumbSize, const NERtcSize &iconSize, const bool includeScreen)=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 initSpatializer()=0
virtual int enableAudioVolumeIndication(bool enable, uint64_t interval, bool enable_vad)=0
virtual int setSubscribeAudioAllowlist(uid_t *uid_array, uint32_t size)=0
virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo &info)=0
virtual int subscribeRemoteVideoStream(uid_t uid, NERtcRemoteVideoStreamType type, bool subscribe)=0
virtual int enableSpatializerRoomEffects(bool enable)=0
virtual int sendSEIMsg(const char *data, int length, NERtcVideoStreamType type)=0
virtual int pushExternalVideoFrame(NERtcVideoFrame *frame)=0
virtual int setSpatializerRenderMode(NERtcSpatializerRenderMode mode)=0
virtual int setupLocalVideoCanvas(NERtcVideoCanvas *canvas)=0
virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo &info)=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 setSubscribeAudioBlocklist(NERtcAudioStreamType type, uid_t *uid_array, uint32_t size)=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 enableSpatializer(bool enable, bool apply_to_team)=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 joinChannel(const char *token, uid_t uid, NERtcJoinChannelOptions channel_options)=0
virtual int muteLocalSubStreamAudio(bool mute)=0
virtual int setRemoteHighPriorityAudioStream(bool enabled, uid_t uid)=0
virtual int setRangeAudioTeamID(int32_t team_id)=0
virtual int updateSelfPosition(const NERtcPositionInfo &info)=0
virtual int pauseScreenCapture()=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 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 setAudioRecvRange(int audible_distance, int conversational_distance, NERtcDistanceRolloffModel roll_off)=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 setRangeAudioMode(NERtcRangeAudioMode mode)=0
virtual int32_t setScreenCaptureSource(const NERtcScreenCaptureSourceInfo &source, const NERtcRectangle &region_rect, const NERtcScreenCaptureParameters &capture_params)=0
virtual int subscribeRemoteSubStreamAudio(uid_t uid, bool subscribe)=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 pushExternalVideoFrame(NERtcVideoStreamType type, NERtcVideoFrame *frame)=0
virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive)=0
virtual int joinChannel(const char *token, uid_t uid)=0
virtual int setCameraCaptureConfig(const NERtcCameraCaptureConfig &config)=0
virtual int setVideoConfig(const NERtcVideoConfig &config)=0
virtual int reportCustomEvent(const char *event_name, const char *custom_identify, const char *parameters)=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 startScreenCaptureByDisplayId(source_id_t display_id, const NERtcRectangle &region_rect, const NERtcScreenCaptureParameters &capture_params)=0
virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback)=0
virtual const char * getChannelName()=0
virtual int setExternalVideoSource(bool enabled)=0
virtual int setExternalVideoSource(NERtcVideoStreamType type, bool enabled)=0
Definition nertc_engine_media_stats_observer.h:30
Definition nertc_engine_defines.h:8233
Definition nertc_engine_defines.h:6613
namespace nertc
NERtcClientRole
Definition nertc_engine_defines.h:244
NERtcStreamFallbackOption
Definition nertc_engine_defines.h:7101
NERtcVideoScalingMode
Definition nertc_engine_defines.h:2168
NERtcVideoStreamType
Definition nertc_engine_defines.h:5835
NERtcMediaPriorityType
Definition nertc_engine_defines.h:377
NERtcConnectionStateType
Definition nertc_engine_defines.h:2299
NERtcRangeAudioMode
Definition nertc_engine_defines.h:7763
uint64_t uid_t
Definition nertc_engine_defines.h:183
NERtcSpatializerRenderMode
Definition nertc_engine_defines.h:8404
NERtcAudioStreamType
Definition nertc_engine_defines.h:3142
void * source_id_t
Definition nertc_engine_defines.h:204
NERtcVideoMirrorMode
Definition nertc_engine_defines.h:2210
NERtcMediaPubType
Definition nertc_engine_defines.h:7840
NERtcDistanceRolloffModel
Definition nertc_engine_defines.h:8430
NERtcRemoteVideoStreamType
Definition nertc_engine_defines.h:1769
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:1643
Definition nertc_engine_defines.h:6060
Definition nertc_engine_defines.h:7738
Definition nertc_engine_defines.h:1035
Definition nertc_engine_defines.h:8455
Definition nertc_engine_defines.h:4064
Definition nertc_engine_defines.h:4315
Definition nertc_engine_defines.h:8183
Definition nertc_engine_defines.h:8137
Definition nertc_engine_defines.h:8477
Definition nertc_engine_defines.h:4573
Definition nertc_engine_defines.h:3683
Definition nertc_engine_defines.h:5286