INERtcEngine.h

浏览该文件的文档.

/*
 * Copyright (c) 2021 NetEase, Inc. All rights reserved.
 */
 
#ifndef INERtcEngine_h
#define INERtcEngine_h
 
#import <Foundation/Foundation.h>
#import "NERtcEngineEnum.h"
#import "NERtcEngineErrorCode.h"
#import "NERtcEngineDelegate.h"
 
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"
 
NS_ASSUME_NONNULL_BEGIN
 
@class NERtcJoinChannelExtraInfo;
 
typedef void(^NERtcJoinChannelCompletion)(NSError * _Nullable error, uint64_t channelId, uint64_t elapesd, uint64_t uid);
 
typedef void(^NERtcLiveStreamCompletion)(NSString *taskId, kNERtcLiveStreamError errorCode);
 
typedef void(^NERtcTakeSnapshotCallback)(int errorCode, UIImage * _Nullable image);
 
@class NERtcEngineContext;
@class NERtcCameraCaptureConfiguration;
@class NERtcVideoEncodeConfiguration;
@class NERtcVideoCanvas;
@class NERtcJoinChannelOptions;
 
@protocol INERtcEngine <NSObject>
 
 
@property (nonatomic, weak, readonly) id<NERtcEngineDelegateEx> engineDelegate;
 
- (NERtcConnectionStateType)connectionState;
 
- (int)setupEngineWithContext:(NERtcEngineContext *)context;
 
- (int)setEngineEventDelegate:(nullable id<NERtcEngineDelegateEx>)delegate;
 
- (int)setDelegateQueue:(nullable dispatch_queue_t)delegateQueue;
 
- (int)joinChannelWithToken:(NSString *)token
                channelName:(NSString *)channelName
                      myUid:(uint64_t)uId
                 completion:(NERtcJoinChannelCompletion)completion;
 
- (int)joinChannelWithToken:(NSString *)token
                channelName:(NSString *)channelName
                      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)switchChannelWithToken:(NSString *)token channelName:(NSString *)channelName completion:(NERtcJoinChannelCompletion)completion;
 
- (int)switchChannelWithToken:(NSString *)token channelName:(NSString *)channelName channelOptions:(nullable NERtcJoinChannelOptions *)channelOptions completion:(void(^)(NSError * _Nullable error, uint64_t channelId, uint64_t elapesd, uint64_t uid, NERtcJoinChannelExtraInfo * _Nullable info))completion;
 
 - (int)enableLocalAudio:(BOOL)enabled;
 
 - (int)enableLocalVideo:(BOOL)enabled;
 
 - (int)enableLocalVideo:(BOOL)enabled streamType:(NERtcStreamChannelType)streamType;
 
- (int)enableMediaPub:(BOOL)enabled withMediaType:(NERtcMediaPubType)mediaType;
 
- (int)setChannelProfile:(NERtcChannelProfileType)channelProfile;
 
 
- (int)setLocalVideoConfig:(NERtcVideoEncodeConfiguration *)config;
 
- (int)setLocalVideoConfig:(NERtcVideoEncodeConfiguration *)config streamType:(NERtcStreamChannelType)streamType;
 
- (int)setAudioProfile:(NERtcAudioProfileType)profile scenario:(NERtcAudioScenarioType)scenario;
 
- (int)setAudioProfile:(NERtcAudioProfileType)profile;
 
- (int)setAudioScenario:(NERtcAudioScenarioType)scenario;
 
- (int)setAINSMode:(NERtcAudioAINSMode)mode;
 
- (int)setupLocalVideoCanvas:(NERtcVideoCanvas * _Nullable)canvas;
 
- (int)setupRemoteVideoCanvas:(NERtcVideoCanvas * _Nullable)canvas forUserID:(uint64_t)userID;
 
 - (int)switchCamera;
 
- (int)setClientRole:(NERtcClientRole)role;
 
- (int)setParameters:(NSDictionary *)parameters;
 
- (NSString * _Nullable)getParameter:(NSString * _Nonnull)parameterKey extraInfo:(NSString * _Nullable)extraInfo;
 
@end
 
 
NS_ASSUME_NONNULL_END
 
#pragma clang diagnostic pop
 
#endif /* INERtcEngine_h */