nertc_channel.h

浏览该文件的文档.

 
#ifndef NERTC_CHANNEL_H
#define NERTC_CHANNEL_H
 
#include "nertc_base.h"
#include "nertc_base_types.h"
#include "nertc_engine_defines.h"
#include "nertc_channel_event_handler.h"
#include "nertc_engine_media_stats_observer.h"
 
namespace nertc
{
 
class IRtcChannel
{
public:
    virtual ~IRtcChannel() {}
 
    virtual void release() = 0;
    
    virtual const char* getChannelName() = 0;
    
    virtual int setChannelEventHandler(IRtcChannelEventHandler* handler) = 0;
 
    virtual int joinChannel(const char* token) = 0;
 
    virtual int joinChannel(const char* token, uid_t uid) = 0;
 
    virtual int joinChannel(const char* token, uid_t uid, NERtcJoinChannelOptions channel_options) = 0;
 
    virtual int leaveChannel() = 0;
 
    virtual int setStatsObserver(IRtcMediaStatsObserver* observer) = 0;
 
    virtual int enableLocalAudio(bool enabled) = 0;
 
    virtual int enableLocalSubStreamAudio(bool enabled) = 0;
 
    virtual int muteLocalAudioStream(bool mute) = 0;
 
    virtual int muteLocalSubStreamAudio(bool mute) = 0;
 
    virtual int enableLocalVideo(bool enabled) = 0;
 
    virtual int enableLocalVideo(NERtcVideoStreamType type, bool enabled) = 0;
 
 
    virtual int muteLocalVideoStream(bool mute) = 0;
 
    virtual int muteLocalVideoStream(NERtcVideoStreamType type, bool mute) = 0;
 
    virtual IScreenCaptureSourceList* getScreenCaptureSources(const NERtcSize& thumbSize, const NERtcSize& iconSize, const bool includeScreen) = 0;
 
    virtual int startScreenCaptureByScreenRect(const NERtcRectangle& screen_rect, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
 
    virtual int startScreenCaptureByDisplayId(source_id_t display_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
 
    virtual int startScreenCaptureByWindowId(source_id_t window_id, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
 
    virtual int32_t setScreenCaptureSource(const NERtcScreenCaptureSourceInfo& source, const NERtcRectangle& region_rect, const NERtcScreenCaptureParameters& capture_params) = 0;
 
    virtual int updateScreenCaptureRegion(const NERtcRectangle& region_rect) = 0;
 
    virtual int setScreenCaptureMouseCursor(bool capture_cursor) = 0;
 
    virtual int stopScreenCapture() = 0;
 
    virtual int pauseScreenCapture() = 0;
 
    virtual int resumeScreenCapture() = 0;
 
 
    virtual int setExcludeWindowList(source_id_t* window_list, int count) = 0;
 
    virtual int updateScreenCaptureParameters(const nertc::NERtcScreenCaptureParameters &captureParams) = 0;
 
    virtual int setupLocalVideoCanvas(NERtcVideoCanvas* canvas) = 0;
 
 
    virtual int setupLocalSubStreamVideoCanvas(NERtcVideoCanvas* canvas) = 0;
  
    virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
 
    virtual int setLocalRenderMode(NERtcVideoScalingMode scaling_mode, NERtcVideoStreamType stream_type) = 0;
 
    virtual int setLocalSubStreamRenderMode(NERtcVideoScalingMode scaling_mode) = 0;
 
    virtual int setLocalVideoMirrorMode(NERtcVideoMirrorMode mirror_mode) = 0;
 
    virtual int setLocalVideoMirrorMode(NERtcVideoStreamType type, NERtcVideoMirrorMode mirror_mode) = 0;
 
    virtual int setupRemoteVideoCanvas(uid_t uid, NERtcVideoCanvas* canvas) = 0;
 
    virtual int setupRemoteSubStreamVideoCanvas(uid_t uid, NERtcVideoCanvas* canvas) = 0;
 
    virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
 
    virtual int setRemoteRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode, NERtcVideoStreamType stream_type) = 0;
 
    virtual int setRemoteSubSteamRenderMode(uid_t uid, NERtcVideoScalingMode scaling_mode) = 0;
    
    virtual int setClientRole(NERtcClientRole role) = 0;
 
    virtual int setLocalMediaPriority(NERtcMediaPriorityType priority, bool is_preemptive) = 0;
 
    virtual NERtcConnectionStateType getConnectionState() = 0;
 
    virtual int setCameraCaptureConfig(const NERtcCameraCaptureConfig& config) = 0;
 
    virtual int setCameraCaptureConfig(NERtcVideoStreamType type, const NERtcCameraCaptureConfig& config) = 0;
 
    virtual int setVideoConfig(const NERtcVideoConfig& config) = 0;
 
    virtual int setVideoConfig(NERtcVideoStreamType type, const NERtcVideoConfig& config) = 0;
 
    virtual int enableDualStreamMode(bool enable) = 0;
 
    virtual int subscribeRemoteAudioStream(uid_t uid, bool subscribe) = 0;
 
    virtual int subscribeRemoteSubStreamAudio(uid_t uid, bool subscribe) = 0;
 
    virtual int subscribeAllRemoteAudioStream(bool subscribe) = 0;
 
    virtual int setAudioSubscribeOnlyBy(uid_t* uid_array, uint32_t size) = 0;
 
    virtual int setSubscribeAudioAllowlist(uid_t* uid_array, uint32_t size) = 0;
 
    virtual int setSubscribeAudioBlocklist(NERtcAudioStreamType type, uid_t* uid_array, uint32_t size) = 0;
 
    virtual int subscribeRemoteVideoStream(uid_t uid, NERtcRemoteVideoStreamType type, bool subscribe) = 0;
 
    virtual int subscribeRemoteVideoSubStream(uid_t uid, bool subscribe) = 0;
 
    virtual int addLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
 
    virtual int updateLiveStreamTask(const NERtcLiveStreamTaskInfo& info) = 0;
 
    virtual int removeLiveStreamTask(const char* task_id) = 0;
 
    virtual int sendSEIMsg(const char* data, int length, NERtcVideoStreamType type) = 0;
 
    virtual int sendSEIMsg(const char* data, int length) = 0;
 
    virtual int takeLocalSnapshot(NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
 
    virtual int takeRemoteSnapshot(uid_t uid, NERtcVideoStreamType stream_type, NERtcTakeSnapshotCallback *callback) = 0;
 
    virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
 
    virtual int adjustChannelPlaybackSignalVolume(uint32_t volume) = 0;
    
    virtual int startChannelMediaRelay(NERtcChannelMediaRelayConfiguration* config) = 0;
 
    virtual int updateChannelMediaRelay(NERtcChannelMediaRelayConfiguration* config) = 0;
 
    virtual int stopChannelMediaRelay() = 0;
 
    virtual int setLocalPublishFallbackOption(NERtcStreamFallbackOption option) = 0;
 
    virtual int setRemoteSubscribeFallbackOption(NERtcStreamFallbackOption option) = 0;
    
    virtual int setRemoteHighPriorityAudioStream(bool enabled, uid_t uid) = 0;
 
    virtual int setExternalVideoSource(bool enabled) = 0;
 
    virtual int setExternalVideoSource(NERtcVideoStreamType type, bool enabled) = 0;
 
    virtual int pushExternalVideoFrame(NERtcVideoFrame* frame) = 0;
 
    virtual int pushExternalVideoFrame(NERtcVideoStreamType type, NERtcVideoFrame* frame) = 0;
 
    
    virtual int enableMediaPub(bool enabled, NERtcMediaPubType media_type) = 0;
 
    virtual int updatePermissionKey(const char* key) = 0;
    virtual int reportCustomEvent(const char* event_name, const char* custom_identify, const char* parameters) = 0;
    virtual int enableAudioVolumeIndication(bool enable, uint64_t interval, bool enable_vad) = 0;
 
    virtual int setRangeAudioMode(NERtcRangeAudioMode mode) = 0;
 
    virtual int setRangeAudioTeamID(int32_t team_id) = 0;
 
    virtual int setAudioRecvRange(int audible_distance, int conversational_distance, NERtcDistanceRolloffModel roll_off) = 0;
    
    virtual int updateSelfPosition(const NERtcPositionInfo& info) = 0;
 
    virtual int enableSpatializerRoomEffects(bool enable) = 0;
 
    virtual int setSpatializerRoomProperty(const NERtcSpatializerRoomProperty& room_property) = 0;
 
    virtual int setSpatializerRenderMode(NERtcSpatializerRenderMode mode) = 0;
 
    virtual int initSpatializer() = 0;
 
    virtual int enableSpatializer(bool enable, bool apply_to_team) = 0;
};
} //namespace nertc
 
#endif