NECallEngine类 参考

#include <NECallEngine.h>

类 NECallEngine 继承关系图:

实例方法
(void)	- destroy
	销毁
(void)	- setup:
	初始化
(void)	- call:completion:
	开始呼叫
(void)	- accept:
	接受呼叫
(void)	- hangup:completion:
	挂断(内部会自动根据状态机状态做取消呼叫 拒绝接听 挂断动作)
(void)	- switchCallType:completion:
	切换通话类型
(void)	- setTimeout:
	设置超时时间
(int)	- setupLocalView:
	设置自己画面
(int)	- setupRemoteView:
	设置其他用户画面
(int)	- enableLocalVideo:
	启动或关闭摄像头
(int)	- muteLocalVideo:
	启动或关闭视频流发送
(int)	- muteLocalAudio:
	启动或关闭声音采集
(void)	- setCallRecordProvider:
	设置发送话单回调(如果实现会截断内部话单流程，请在此实现中自己处理话单发送相关功能)
(void)	- switchCamera
	摄像头前后切换
(void)	- setCallConfig:
	设置呼叫时的配置参数，切换音视频是否需要切换，信令消息是否支持离线等
(void)	- addCallDelegate:
	添加代理
(void)	- removeCallDelegate:
	移除代码
(nullable NECallInfo *)	- getCallInfo
	获取当前通话信息
(NECallConfig *)	- getCallConfig
	获取当前通话配置

类方法
(instancetype)	+ sharedInstance
	单例
(NSString *)	+ getVersion
	版本号

属性
NERtcCallStatus	callStatus
	通话状态
NSTimeInterval	timeOutSeconds
	单位:秒,IM服务器邀请2分钟后无响应为超时,最大值不超过2分钟。
id< NERtcEngineDelegateEx >	engineDelegate
	NERtcEngine 的回调接口，由用户提供
id< NERtcEngineMediaStatsObserver >	observer
	中转NERtcEngine统计回调
NESetupConfig *	config
	初始化设置

成员函数文档

accept:

- (void) accept:

(nullable void(^)(NSError *_Nullable error, NECallInfo *_Nullable callInfo))

completion

接受呼叫

参数

completion

回调

addCallDelegate:

- (void) addCallDelegate:

(id< NECallEngineDelegate >)

delegate

添加代理

call:completion:

- (void) call:		(NECallParam *)	param
completion:		(nullable void(^)(NSError *_Nullable error, NECallInfo *_Nullable callInfo))	completion

开始呼叫

参数

param	呼叫参数
completion	完成回调

destroy

- (void) destroy

销毁

enableLocalVideo:

- (int) enableLocalVideo:

(BOOL)

enable

启动或关闭摄像头

参数

enable

YES:启动，NO:关闭

返回

操作返回值，成功则返回 0

getCallConfig

- (NECallConfig *) getCallConfig

获取当前通话配置

返回

config 通话配置

getCallInfo

- (NECallInfo *) getCallInfo

获取当前通话信息

返回

info 通话信息

getVersion

+ (NSString *) getVersion

版本号

hangup:completion:

- (void) hangup:		(NEHangupParam *)	param
completion:		(nullable void(^)(NSError *_Nullable error))	completion

挂断(内部会自动根据状态机状态做取消呼叫 拒绝接听 挂断动作)

参数

param	挂断参数
completion	结束回调

muteLocalAudio:

- (int) muteLocalAudio:

(BOOL)

muted

启动或关闭声音采集

参数

muted

YES 开启 NO 关闭

返回

操作返回值，成功则返回 0

muteLocalVideo:

- (int) muteLocalVideo:

(BOOL)

muted

启动或关闭视频流发送

参数

muted

YES 开启 NO 关闭

返回

操作返回值，成功则返回 0

removeCallDelegate:

- (void) removeCallDelegate:

(id< NECallEngineDelegate >)

delegate

移除代码

setCallConfig:

- (void) setCallConfig:

(NECallConfig *)

config

设置呼叫时的配置参数，切换音视频是否需要切换，信令消息是否支持离线等

参数

config

呼叫配置

setCallRecordProvider:

- (void) setCallRecordProvider:

(id<NERecordProvider>)

provider

设置发送话单回调(如果实现会截断内部话单流程，请在此实现中自己处理话单发送相关功能)

参数

provider

话单实现接口

setTimeout:

- (void) setTimeout:

(int)

time

设置超时时间

参数

time	超时时间，单位秒，不超过120s，超过内部会用120s处理

setup:

- (void) setup:

(NESetupConfig *)

config

初始化

参数

config

初始化参数

setupLocalView:

- (int) setupLocalView:

(nullable UIView *)

view

设置自己画面

参数

view	渲染自己画面的View @discussion view上不建议有任何subview

返回

0 操作成功

setupRemoteView:

- (int) setupRemoteView:

(nullable UIView *)

view

设置其他用户画面

参数

view	渲染其他画面的View @discussion view上不建议有任何subview

返回

0 正常, -1 没有查询到 uid

sharedInstance

+ (instancetype) sharedInstance

单例

switchCallType:completion:

- (void) switchCallType:		(NESwitchParam *)	param
completion:		(nullable void(^)(NSError *_Nullable))	completion

切换通话类型

参数

param

切换参数

switchCamera

- (void) switchCamera

摄像头前后切换

属性说明

callStatus

- (NERtcCallStatus) callStatus

readnonatomicassign

通话状态

config

- (NESetupConfig*) config

readnonatomicstrong

初始化设置

engineDelegate

- (id<NERtcEngineDelegateEx>) engineDelegate

readwritenonatomicweak

NERtcEngine 的回调接口，由用户提供

observer

- (id<NERtcEngineMediaStatsObserver>) observer

readwritenonatomicweak

中转NERtcEngine统计回调

timeOutSeconds

- (NSTimeInterval) timeOutSeconds

readwritenonatomicassign

单位:秒,IM服务器邀请2分钟后无响应为超时,最大值不超过2分钟。

---

该类的文档由以下文件生成:

• NECallEngine.h
• NECallEngine.m