JMRTCClient Class Reference

Inherits from NSObject
Declared in JMRTCClient.h

+ initializeEngine:

初始化音视频引擎。

+ (void)initializeEngine:(JMRTCCompletionHandler _Nullable)handler

Parameters

handler

初始话回调,error = nil 表示初始化成功

Discussion

在使用其他接口之前,必须先调用此接口初始化引擎。

Declared In

JMRTCClient.h

+ releaseEngine

释放音视频引擎

+ (void)releaseEngine

Discussion

挂断后建议释放引擎,释放之后如果需要再次使用音视频服务,需要重新调用初始化接口来重新初始化音视频引擎。

Declared In

JMRTCClient.h

+ addDelegate:

添加音视频监听

+ (void)addDelegate:(id<JMRTCDelegate> _Nonnull)delegate

Parameters

delegate

需要监听的 Delegate Protocol

Discussion

建议在 didFinishLaunchingWithOptions 方法中添加全局监听,避免遗漏监听

Declared In

JMRTCClient.h

+ startCallUsers:mediaType:handler:

发起一个通话

+ (void)startCallUsers:(NSArray<__kindofJMSGUser*> *_Nonnull)users mediaType:(JMRTCMediaType)type handler:(JMRTCCompletionHandler _Nullable)handler

Parameters

users

邀请的用户列表

type

发起的通话媒体类型

handler

回调,error = nil 表示成功,result 为 JMRTCSession 对象

Discussion

在此接口成功之后,可以设置会话中用户展示视图、摄像头等属性; 如果被邀请人中包含未登录用户只会向已登录用户发起邀请。

Declared In

JMRTCClient.h

+ setVideoProfile:

设置视频输出的编码属性

+ (void)setVideoProfile:(JMRTCVideoProfile)profile

Parameters

profile

视频编码属性,默认是 JMRTC_VIDEO_PROFILE_360P

建议在发起通话之前,调用此接口设置,避免在通话过程中调用此接口

Discussion

注意:多人视频通话期间设置此接口可能会失效

Declared In

JMRTCClient.h

+ getVideoProfile

获取当前设置的视频编码属性

+ (JMRTCVideoProfile)getVideoProfile

Declared In

JMRTCClient.h

+ currentCallSession

当前的通话会话实体

+ (JMRTCSession *_Nullable)currentCallSession

Declared In

JMRTCClient.h