NECallEngine.h

浏览该文件的文档.

// Copyright (c) 2022 NetEase, Inc. All rights reserved.
// Use of this source code is governed by a MIT license that can be
// found in the LICENSE file.
 
#import <Foundation/Foundation.h>
 
#import "NECallConfig.h"
#import "NECallConnectedInfo.h"
#import "NECallEndInfo.h"
#import "NECallEngineConsts.h"
#import "NECallInfo.h"
#import "NECallInviteParam.h"
#import "NECallInviteResult.h"
#import "NECallInviteStateInfo.h"
#import "NECallMemberChangeInfo.h"
#import "NECallMemberInfo.h"
#import "NECallModeChangeInfo.h"
#import "NECallParam.h"
#import "NECallPushConfig.h"
#import "NECallSystemIncomingCallParam.h"
#import "NECallTypeChangeInfo.h"
#import "NEHangupParam.h"
#import "NEInviteInfo.h"
#import "NERecordConfig.h"
#import "NESetupConfig.h"
#import "NESwitchParam.h"
#import "NEUserInfo.h"
 
NS_ASSUME_NONNULL_BEGIN
 
@protocol NECallEngineRtcDelegateEx <NSObject>
 
- (void)onNERtcEngineVirtualBackgroundSourceEnabled:(BOOL)enabled
                                             reason:(NERtcVirtualBackgroundSourceStateReason)reason;
 
@end
 
@protocol NERecordProvider <NSObject>
 
- (void)onRecordSend:(NERecordConfig *)config;
 
@end
 
@protocol NECallMultiDelegate <NSObject>
 
#pragma mark - 多人通话回调接口
 
@optional
 
- (void)onCallModeChanged:(NECallModeChangeInfo *)info;
 
- (void)onCallMembersChanged:(NECallMemberChangeInfo *)info;
 
- (void)onCallInviteStateChanged:(NSArray<NECallInviteStateInfo *> *)infos;
 
@end
 
@protocol NECallEngineDelegate <NECallMultiDelegate>
 
#pragma mark - 回调接口
 
@optional
 
- (void)onReceiveInvited:(NEInviteInfo *)info;
 
- (void)onCallEnd:(NECallEndInfo *)info;
 
- (void)onCallConnected:(NECallInfo *)info;
 
- (void)onCallTypeChange:(NECallTypeChangeInfo *)info;
 
- (void)onVideoAvailable:(BOOL)available userID:(NSString *)userId;
 
- (void)onVideoMuted:(BOOL)muted userID:(NSString *)userId;
 
- (void)onAudioMuted:(BOOL)muted userID:(NSString *)userId;
 
- (void)onLocalAudioMuted:(BOOL)muted;
 
#pragma mark - 生命周期回调接口
 
- (void)onRtcInitEnd;
 
@end
 
@interface NECallEngine : NSObject
 
@property(nonatomic, assign, readonly) NERtcCallStatus callStatus;
 
@property(nonatomic, assign) NSTimeInterval timeOutSeconds;
 
@property(nonatomic, weak) id<NERtcEngineDelegateEx> engineDelegate;
 
@property(nonatomic, weak) id<NERtcEngineMediaStatsObserver> observer;
 
@property(nonatomic, readonly, strong) NESetupConfig *config;
 
+ (instancetype)sharedInstance;
 
- (void)destroy;
 
#pragma mark - 主流程
 
- (void)setup:(NESetupConfig *)config;
 
- (void)call:(NECallParam *)param
    completion:
        (nullable void (^)(NSError *_Nullable error, NECallInfo *_Nullable callInfo))completion;
 
- (void)accept:(nullable void (^)(NSError *_Nullable error,
                                  NECallInfo *_Nullable callInfo))completion;
 
- (void)hangup:(NEHangupParam *)param
    completion:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)inviteMembers:(NECallInviteParam *)param
           completion:(nullable void (^)(NSError *_Nullable error,
                                          NECallInviteResult *_Nullable result))completion;
 
#pragma mark - 配置接口
 
- (void)switchCallType:(NESwitchParam *)param
            completion:(nullable void (^)(NSError *_Nullable))completion;
 
- (void)setTimeout:(int)time;
 
- (int)setupLocalView:(nullable UIView *)view;
 
- (int)setupRemoteView:(nullable UIView *)view;
 
- (int)setupRemoteCanvas:(nullable NERtcVideoCanvas *)canvas;
 
- (int)enableLocalVideo:(BOOL)enable;
 
- (int)muteLocalVideo:(BOOL)muted;
 
- (int)muteLocalAudio:(BOOL)muted;
 
- (void)setCallRecordProvider:(nullable id<NERecordProvider>)provider;
 
- (void)switchCamera;
 
- (void)setSpeakerphoneOn:(BOOL)enable;
 
- (BOOL)isSpeakerphoneOn;
 
- (void)setCallConfig:(NECallConfig *)config;
 
- (void)addCallDelegate:(id<NECallEngineDelegate>)delegate;
 
- (void)removeCallDelegate:(id<NECallEngineDelegate>)delegate;
 
// 设置AI降噪模式
- (void)setAINSMode:(NERtcAudioAINSMode)mode;
 
// 开启实时字幕。
- (int)startASRCaption:(NERtcASRCaptionConfig *)config;
 
// 关闭实时字幕。
- (int)stopASRCaption;
 
#pragma mark - 状态信息获取
 
- (nullable NECallInfo *)getCallInfo;
 
- (NSArray<NECallMemberInfo *> *)currentMembers;
 
- (BOOL)isInMultiCall;
 
- (BOOL)canInviteMembers;
 
- (NECallConfig *)getCallConfig;
 
- (nullable NEUserInfo *)getUserWithRtcUid:(uint64_t)rtcUid;
 
+ (NSString *)getVersion;
 
#pragma mark - 弹出系统来电提示
 
 
- (void)reportIncomingCallWithParam:(NECallSystemIncomingCallParam *)param
                   acceptCompletion:
                       (nullable void (^)(NSError *_Nullable error,
                                          NECallInfo *_Nullable callInfo))acceptCompletion
                   hangupCompletion:(nullable void (^)(NSError *_Nullable error))hangupCompletion
                     muteCompletion:
                         (nullable void (^)(NSError *_Nullable error, BOOL mute))muteCompletion
    API_AVAILABLE(ios(17.4));
 
 
- (void)dismissIncomingCall API_AVAILABLE(ios(17.4));
 
@end
 
NS_ASSUME_NONNULL_END