INERtcChannel.h

浏览该文件的文档.

//
//  INERtcChannel.h
//  NERtcSDK
//
//  Created by yuan on 2021/6/6.
//  Copyright © 2021 Netease. All rights reserved.
//
 
#ifndef INERtcChannel_h
#define INERtcChannel_h
 
#import <Foundation/Foundation.h>
#import "NERtcChannelDelegate.h"
#import "NERtcEngineStatistics.h"
#import "INERtcEngine.h"
 
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"
 
NS_ASSUME_NONNULL_BEGIN

@protocol INERtcChannel <NSObject>

- (int)destroy;

- (int)setChannelDelegate:(nullable id<NERtcChannelDelegate>)channelDelegate;

- (int)setDelegateQueue:(nullable dispatch_queue_t)delegateQueue;

- (NSString *)getChannelName;

- (NERtcConnectionStateType)connectionState;

- (int)joinChannelWithToken:(NSString *)token
                 completion:(NERtcJoinChannelCompletion)completion;

- (int)joinChannelWithToken:(NSString *)token
                      myUid:(uint64_t)uId
                 completion:(NERtcJoinChannelCompletion)completion;

- (int)joinChannelWithToken:(NSString *)token
                      myUid:(uint64_t)uId
             channelOptions:(nullable NERtcJoinChannelOptions *)channelOptions
                 completion:(void(^)(NSError * _Nullable error, uint64_t channelId, uint64_t elapesd, uint64_t uid, NERtcJoinChannelExtraInfo * _Nullable info))completion;
- (int)leaveChannel;

- (int)enableLocalAudio:(BOOL)enabled;

- (int)enableLocalVideo:(BOOL)enabled;

- (int)enableLocalVideo:(BOOL)enabled streamType:(NERtcStreamChannelType)streamType;

- (int)enableMediaPub:(BOOL)enabled withMediaType:(NERtcMediaPubType)mediaType;

- (int)enableDualStreamMode:(BOOL)enable;

- (int)setVideoStreamLayerCount:(NERtcVideoStreamLayerCount)layerCount;

- (int)setCameraCaptureConfig:(NERtcCameraCaptureConfiguration *)config;

- (int)setCameraCaptureConfig:(NERtcCameraCaptureConfiguration *)config streamType:(NERtcStreamChannelType)streamType;

- (int)setLocalVideoConfig:(NERtcVideoEncodeConfiguration *)config;

- (int)setLocalVideoConfig:(NERtcVideoEncodeConfiguration *)config streamType:(NERtcStreamChannelType)streamType;

 - (int)switchCamera;

- (int)switchCameraWithPosition:(NERtcCameraPosition)position;

- (int)subscribeRemoteAudio:(BOOL)subscribe forUserID:(uint64_t)userID;

- (int)subscribeAllRemoteAudio:(BOOL)subscribe;

- (int)setAudioSubscribeOnlyBy:(NSArray<NSNumber*> *)uidArray;

- (int)muteLocalAudio:(BOOL)muted;

- (int)enableAudioVolumeIndication:(BOOL)enable interval:(uint64_t)interval vad:(BOOL)enableVad;

- (int)setupLocalVideoCanvas:(NERtcVideoCanvas * _Nullable)canvas;

- (int)setLocalRenderScaleMode:(NERtcVideoRenderScaleMode)mode;

- (int)setupRemoteVideoCanvas:(NERtcVideoCanvas * _Nullable)canvas forUserID:(uint64_t)userID;

- (int)setupRemoteVideoCanvas:(NERtcVideoCanvas * _Nullable)canvas forUserID:(uint64_t)userID streamType:(NERtcStreamChannelType)streamType;

- (int)setRemoteRenderScaleMode:(NERtcVideoRenderScaleMode)mode forUserID:(uint64_t)userID;

- (int)subscribeRemoteVideo:(BOOL)subscribe forUserID:(uint64_t)userID streamType:(NERtcRemoteVideoStreamType)streamType;
       
- (int)subscribeRemoteVideo:(BOOL)subscribe forUserID:(uint64_t)userID streamType:(NERtcStreamChannelType)streamType subscribeType:(NERtcRemoteVideoStreamType)subscribeType;

- (int)muteLocalVideo:(BOOL)muted;

- (int)muteLocalVideo:(BOOL)muted streamType:(NERtcStreamChannelType)streamType;

- (int)setExternalVideoSource:(BOOL)enable streamType:(NERtcStreamChannelType)streamType;

- (int)pushExternalVideoFrame:(NERtcVideoFrame*)frame streamType:(NERtcStreamChannelType)streamType;

- (int)setClientRole:(NERtcClientRole)role;

- (int)adjustUserPlaybackSignalVolume:(uint32_t)volume forUserID:(uint64_t)userID;

- (int)adjustChannelPlaybackSignalVolume:(uint32_t)volume;
 
#pragma mark - Audio Sub Stream

- (int)enableLocalSubStreamAudio:(BOOL)enabled;

- (int)subscribeRemoteSubStreamAudio:(BOOL)subscribe forUserID:(uint64_t)userID;

- (int)muteLocalSubStreamAudio:(BOOL)muted;
 
 
#pragma mark - Sub Stream

- (int)setupLocalSubStreamVideoCanvas:(NERtcVideoCanvas * _Nullable)canvas;

- (int)startScreenCapture:(NERtcVideoSubStreamEncodeConfiguration *)config;

- (int)stopScreenCapture;

- (int)setLocalRenderSubStreamScaleMode:(NERtcVideoRenderScaleMode)mode;

- (int)setupRemoteSubStreamVideoCanvas:(NERtcVideoCanvas * _Nullable)canvas forUserID:(uint64_t)userID;

- (int)subscribeRemoteSubStreamVideo:(BOOL)subscribe forUserID:(uint64_t)userID;

- (int)setRemoteRenderSubStreamVideoScaleMode:(NERtcVideoRenderScaleMode)mode forUserID:(uint64_t)userID;

- (int)setRemoteHighPriorityAudioStream:(BOOL)enable forUserID:(uint64_t)userID streamType:(NERtcAudioStreamType)streamType;

- (int)clearRemoteHighPriorityAudioStream;
 
#pragma mark - 3D Audio

- (int)setRangeAudioMode:(NERtcRangeAudioMode)mode;

-(int)setRangeAudioTeamID:(int32_t)teamId;

- (int)setAudioRecvRange:(int)audibleDistance conversationalDistance:(int)conversationalDistance rollOff:(NERtcDistanceRolloffModel)rollOff;

- (int)updateSelfPosition:(NERtcPositionInfo *)info;

- (int)enableSpatializerRoomEffects:(BOOL)enabled;

- (int)setSpatializerRoomProperty:(NERtcSpatializerRoomProperty *)roomProperty;

- (int)setSpatializerRenderMode:(NERtcSpatializerRenderMode)mode;

- (int)initSpatializer;

- (int)enableSpatializer:(BOOL)enabled applyToTeam:(BOOL)applyToTeam;
 
#pragma mark - ASL black and white list
- (int)setSubscribeAudioBlocklist:(NERtcAudioStreamType)type uidArray:(NSArray<NSNumber*> *)uidArray;

- (int)setSubscribeAudioAllowlist:(NSArray<NSNumber*> *)uidArray;
 
#pragma mark - Snapshot
- (int)takeLocalSnapshot:(NERtcStreamChannelType)streamType callback:(NERtcTakeSnapshotCallback)callback;

- (int)takeRemoteSnapshot:(NERtcStreamChannelType)streamType forUserID:(uint64_t)userID callback:(NERtcTakeSnapshotCallback)callback;
 
#pragma mark - SEI

- (int)sendSEIMsg:(NSData *)data streamChannelType:(NERtcStreamChannelType)type;

- (int)sendSEIMsg:(NSData *)data;
 
#pragma mark - Live Stream

- (int)addLiveStreamTask:(NERtcLiveStreamTaskInfo *)taskInfo compeltion:(NERtcLiveStreamCompletion)completion;

- (int)updateLiveStreamTask:(NERtcLiveStreamTaskInfo *)taskInfo compeltion:(NERtcLiveStreamCompletion)completion;

- (int)removeLiveStreamTask:(NSString *)taskId compeltion:(NERtcLiveStreamCompletion)completion;

- (int)addChannelMediaStatsObserver:(id<NERtcChannelMediaStatsObserver>)observer;

- (int)removeChannelMediaStatsObserver:(id<NERtcChannelMediaStatsObserver>)observer;

- (int)cleanupChannelMediaStatsObserver;
 

- (int)startChannelMediaRelay:(NERtcChannelMediaRelayConfiguration *_Nonnull)config;

- (int)updateChannelMediaRelay:(NERtcChannelMediaRelayConfiguration *_Nonnull)config;

- (int)stopChannelMediaRelay;

- (int)pauseChannelMediaRelay;

- (int)resumeChannelMediaRelay;

- (int)stopChannelMediaRelay;

- (int)setLocalMediaPriority:(NERtcMediaPriorityType)priority preemptive:(BOOL)preemptive;
 

- (int)setLocalPublishFallbackOption:(NERtcStreamFallbackOptions)option;

- (int)setRemoteSubscribeFallbackOption:(NERtcStreamFallbackOptions)option;

- (int)updatePermissionKey:(NSString *)key;

- (int)setLocalVideoMosaic:(BOOL)enabled streamType:(NERtcStreamChannelType)streamType rect:(NERtcFrameNormalizedRect *)rect;

- (int)setRemoteVideoMosaic:(BOOL)enabled userId:(uint64_t)userId streamType:(NERtcStreamChannelType)streamType rect:(NERtcFrameNormalizedRect *)rect;
 
#pragma mark - Video Blend

- (int)startBlendExternalVideo:(NERtcStreamChannelType)streamType blendConfig:(NERtcVideoExternalBlendConfig *)blendConfig;

- (int)stopBlendExternalVideo:(NERtcStreamChannelType)streamType;

- (int)pushBlendExternalVideoFrame:(NERtcStreamChannelType)streamType frame:(NERtcVideoFrame *)frame;

- (int)enableVideoDenoise:(BOOL)enabled streamType:(NERtcStreamChannelType)streamType;

- (int)enableVideoLowlightEnhance:(BOOL)enabled level:(NERtcVideoLowlightEnhanceLevel)level streamType:(NERtcStreamChannelType)streamType;
 
#pragma mark - Other

- (int)reportCustomEvent:(NSString *)eventName
          customIdentify:(NSString *)customIdentify
                   param:(NSDictionary *)param;
 
@end
 
NS_ASSUME_NONNULL_END
 
#pragma clang diagnostic pop
 
#endif /* INERtcChannel_h */