NERtcCallKit.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 <UIKit/UIKit.h>
#import "NECallEngine.h"
#import "NECallEngineConsts.h"
#import "NEGroupCallKit.h"
#import "NERtcCallKitConsts.h"
#import "NERtcCallKitContext.h"
#import "NERtcCallKitJoinChannelEvent.h"
#import "NERtcCallKitPushConfig.h"
#import "NERtcCallOptions.h"
// #import "NERtcCallKitDelegate.h"
 
// FOUNDATION_EXPORT double NERtcCallKitVersionNumber;
 
// FOUNDATION_EXPORT const unsigned char NERtcCallKitVersionString[];
 
// In this header, you should import all the public headers of your framework using statements like
// #import <NERtcCallKit/PublicHeader.h>
 
NS_ASSUME_NONNULL_BEGIN
 
typedef void (^NERtcCallKitRecordMessageHander)(V2NIMMessage *message);
 
@protocol NERtcCallKitDelegate <NSObject>
 
@optional
 
- (void)onInvited:(NSString *)invitor
          userIDs:(NSArray<NSString *> *)userIDs
      isFromGroup:(BOOL)isFromGroup
          groupID:(nullable NSString *)groupID
             type:(NERtcCallType)type
    NERtcCallKitDeprecate("use -onInvited:userIDs:isFromGroup:groupID:type:attachment: instead");
 
- (void)onInvited:(NSString *)invitor
          userIDs:(NSArray<NSString *> *)userIDs
      isFromGroup:(BOOL)isFromGroup
          groupID:(nullable NSString *)groupID
             type:(NERtcCallType)type
       attachment:(nullable NSString *)attachment;
 
- (void)onUserEnter:(NSString *)userID;
 
- (void)onUserReject:(NSString *)userID;
 
- (void)onUserCancel:(NSString *)userID;
 
- (void)onUserLeave:(NSString *)userID;
 
- (void)onUserDisconnect:(NSString *)userID;
 
- (void)onUserAccept:(NSString *)userID;
 
- (void)onUserBusy:(NSString *)userID;
 
- (void)onCallTypeChange:(NERtcCallType)callType withState:(NERtcSwitchState)state;
 
- (void)onCallTypeChange:(NERtcCallType)callType
    NERtcCallKitDeprecate("use -onCallTypeChange:withState: instead");
 
- (void)onCallEnd;
 
- (void)onCallingTimeOut;
 
- (void)onDisconnect:(NSError *)reason;
 
- (void)onError:(NSError *)error;
 
- (void)onCameraAvailable:(BOOL)available userID:(NSString *)userID;
 
- (void)onAudioAvailable:(BOOL)available userID:(NSString *)userID;
 
- (void)onVideoMuted:(BOOL)muted userID:(NSString *)userID;
 
- (void)onAudioMuted:(BOOL)muted userID:(NSString *)userID;
 
- (void)onJoinChannel:(NERtcCallKitJoinChannelEvent *)event;
 
- (void)onFirstVideoFrameDecoded:(NSString *)userID width:(uint32_t)width height:(uint32_t)height;
 
- (void)onUserNetworkQuality:(NSDictionary<NSString *, NERtcNetworkQualityStats *> *)stats;
 
- (void)onOtherClientAccept;
 
- (void)onOtherClientReject;
 
- (void)onNERtcEngineUser:(uint64_t)userID videoMuted:(BOOL)muted;
 
- (void)onNERtcEngineUserVideoDidStartWithUserID:(uint64_t)userID
                                    videoProfile:(NERtcVideoProfileType)profile;
 
- (void)onRtcInitEnd;
 
@end
 
@interface NERtcCallKit : NSObject
 
@property(nonatomic, assign, readonly) NERtcCallStatus callStatus;
 
@property(nonatomic, assign) NSTimeInterval timeOutSeconds;
 
@property(nonatomic, copy, nullable) NERtcCallKitTokenHandler tokenHandler;
 
@property(nonatomic, copy, nullable) NERtcCallKitPushConfigHandler pushConfigHandler;
 
@property(nonatomic, copy, nullable) NERtcCallKitRecordMessageHander recordHandler;
 
@property(nonatomic, weak) id<NERtcEngineDelegateEx> engineDelegate;
 
@property(nonatomic, weak) id<NERtcEngineMediaStatsObserver> observer;
 
+ (instancetype)sharedInstance;
 
- (void)setupAppKey:(NSString *)appKey options:(nullable NERtcCallOptions *)options;
 
- (void)setupAppKey:(NSString *)appKey
         withRtcUid:(uint64_t)rtcUid
            options:(nullable NERtcCallOptions *)options;
 
- (void)setupAppKey:(NSString *)appKey
            options:(nullable NERtcCallOptions *)options
        withContext:(nonnull NERtcEngineContext *)context;
 
- (void)login:(NSString *)userID
         token:(NSString *)token
    completion:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)updateApnsToken:(NSData *)deviceToken;
 
- (void)updatePushKitToken:(NSData *)pushkitToken;
 
- (void)logout:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)call:(NSString *)userID
          type:(NERtcCallType)type
    completion:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)call:(NSString *)userID
          type:(NERtcCallType)type
    attachment:(nullable NSString *)attachment
    completion:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)call:(NSString *)userID
           type:(NERtcCallType)type
     attachment:(nullable NSString *)attachment
    globalExtra:(nullable NSString *)extra
     completion:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)call:(NSString *)userID
           type:(NERtcCallType)type
     attachment:(nullable NSString *)attachment
    globalExtra:(nullable NSString *)extra
      withToken:(nullable NSString *)token
    channelName:(nullable NSString *)channelName
     completion:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)cancel:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)accept:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)acceptWithToken:(nullable NSString *)token
         withCompletion:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)reject:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)rejectWithReason:(NSInteger)reason
          withCompletion:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)hangup:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)setupLocalView:(nullable UIView *)localView;
 
- (void)setupRemoteView:(nullable UIView *)remoteView forUser:(nullable NSString *)userID;
 
- (int)enableLocalVideo:(BOOL)enable;
 
- (int)muteLocalVideo:(BOOL)muted;
 
- (int)switchCamera;
 
- (int)muteLocalAudio:(BOOL)mute;
 
- (void)switchCallType:(NERtcCallType)type
             withState:(NERtcSwitchState)state
            completion:(nullable void (^)(NSError *_Nullable error))completion;
 
- (void)setLoudSpeakerMode:(BOOL)speaker error:(NSError *_Nonnull *_Nonnull)error;
 
- (void)setAudioMute:(BOOL)mute forUser:(NSString *)userID error:(NSError *_Nonnull *_Nonnull)error;
 
- (void)memberOfUid:(uint64_t)uid
         completion:(nullable void (^)(NIMSignalingMemberInfo *_Nullable info))completion;
 
- (void)memberOfAccid:(NSString *)accid
           completion:(nullable void (^)(NIMSignalingMemberInfo *_Nullable info))completion;
 
- (void)addDelegate:(id<NERtcCallKitDelegate>)delegate;
 
- (void)removeDelegate:(id<NERtcCallKitDelegate>)delegate;
 
- (void)enableSwitchCallTypeConfirmVideo:(BOOL)video audio:(BOOL)audio;
 
+ (NSString *)versionCode;
 
@end
 
NS_ASSUME_NONNULL_END