开发者中心 - 小鱼易连

XYMeetingHandle

描述: 会议处理类，负责会议的核心功能管理
版本支持: 3.10+

属性

delegate

版本支持: 3.10+
接口概述: 会议处理代理对象
接口定义:

@property(nonatomic,weak) id delegate;

属性参数: 无

返回值:

返回值名	类型	描述
delegate	id<XYMeetingHandleDelegate>	会议处理代理对象

shareInstance

版本支持: 3.10+
接口概述: 获取单例对象
接口定义:

+ (instancetype)shareInstance;

接口参数: 无

返回值:

返回值名	类型	描述
result	instancetype	单例对象

setupMeetingKit

版本支持: 3.10+
接口概述: 初始化会议套件
接口定义:

+ (void)setupMeetingKit;

接口参数: 无

返回值: 无

updateMeetingKitConfig

版本支持: 3.10+
接口概述: 更新配置
接口定义:

+ (void)updateMeetingKitConfig:(void (^)(XYMKConfig * config))configBlock;

接口参数:

参数名	类型	是否必填	描述
configBlock	void (^)(XYMKConfig * config)	是	配置block

返回值: 无

joinMeeting (基础版本)

版本支持: 3.10+
接口概述: 加入会议
接口定义:

+ (void)joinMeeting:(NSString *)number password:(NSString *)password;

接口参数:

参数名	类型	是否必填	描述
number	NSString *	否	会议号
password	NSString *	否	会议密码

返回值: 无

joinMeeting (带配置)

版本支持: 3.10+
接口概述: 加入会议（带配置）
接口定义:

+ (void)joinMeeting:(NSString *)number
           password:(NSString *)password
             config:(XYCallConfigBlock)configBlock;

接口参数:

参数名	类型	是否必填	描述
number	NSString *	否	会议号
password	NSString *	否	会议密码
configBlock	XYCallConfigBlock	否	会议配置

返回值: 无

joinMeeting (完整版本)

版本支持: 3.10+
接口概述: 加入会议（带配置和状态回调）
接口定义:

+ (void)joinMeeting:(NSString *)number
           password:(NSString *)password
             config:(XYCallConfigBlock)configBlock
       meetingState:(MeetingStateInfoChangedBlock)meetingStateChangedBlock;

接口参数:

参数名	类型	是否必填	描述
number	NSString *	否	会议号
password	NSString *	否	会议密码
configBlock	XYCallConfigBlock	否	会议配置
meetingStateChangedBlock	MeetingStateInfoChangedBlock	否	会议状态改变回调

返回值: 无

leaveMeeting

版本支持: 3.10+
接口概述: 离开会议
接口定义:

+ (void)leaveMeeting;

接口参数: 无

返回值: 无

isMeeting

版本支持: 3.10+
接口概述: 是否在会中
接口定义:

+ (BOOL)isMeeting;

接口参数: 无

返回值:

返回值名	类型	描述
result	BOOL	是否在会中

getPresentingViewController

版本支持: 3.10+
接口概述: 获取负责弹出会议页面的Viewcontroller
接口定义:

+ (UIViewController *)getPresentingViewController;

接口参数: 无

返回值:

返回值名	类型	描述
result	UIViewController *	负责弹出会议页面的Viewcontroller

getNativeFeedBackController

版本支持: 3.10+
接口概述: 获取快速反馈的Viewcontroller
接口定义:

+ (UIViewController *)getNativeFeedBackController:(BOOL)isPresentViewController;

接口参数:

参数名	类型	是否必填	描述
isPresentViewController	BOOL	是	是否为展示控制器

返回值:

返回值名	类型	描述
result	UIViewController *	快速反馈的Viewcontroller

meetingKitHandleOrientationApplication

版本支持: 3.10+
接口概述: 处理meetingKit横竖屏旋转
接口定义:

+ (UIInterfaceOrientationMask)meetingKitHandleOrientationApplication:(UIApplication *)application
                             supportedInterfaceOrientationsForWindow:(UIWindow *)window;

接口参数:

参数名	类型	是否必填	描述
application	UIApplication *	是	应用程序对象
window	UIWindow *	是	窗口对象

返回值:

返回值名	类型	描述
result	UIInterfaceOrientationMask	支持的界面方向

showInvitedCallView

版本支持: 3.10+
接口概述: 显示来电邀请通知
接口定义:

+ (void)showInvitedCallView;

接口参数: 无

返回值: 无

updateScreenCaptureStateWhenLogout

版本支持: 3.10+
接口概述: 退出登录时刷新禁止录屏黑色背景
接口定义:

+ (void)updateScreenCaptureStateWhenLogout;

接口参数: 无

返回值: 无

实例方法

updateMeetingKitConfig (实例方法)

版本支持: 3.10+
接口概述: 更新配置
接口定义:

- (void)updateMeetingKitConfig:(void (^)(XYMKConfig * config))configBlock;

接口参数:

参数名	类型	是否必填	描述
configBlock	void (^)(XYMKConfig * config)	是	配置block

返回值: 无

getPresentingViewController (实例方法)

版本支持: 3.10+
接口概述: 获取负责弹出会议页面的Viewcontroller
接口定义:

- (UIViewController *)getPresentingViewController;

接口参数: 无

返回值:

返回值名	类型	描述
result	UIViewController *	负责弹出会议页面的Viewcontroller

showInvitedCallView (实例方法)

版本支持: 3.10+
接口概述: 显示来电邀请通知
接口定义:

- (void)showInvitedCallView;

接口参数: 无

返回值: 无

updateScreenCaptureStateWhenLogout (实例方法)

版本支持: 3.10+
接口概述: 退出登录时刷新禁止录屏黑色背景
接口定义:

- (void)updateScreenCaptureStateWhenLogout;

接口参数: 无

返回值: 无

回调类型定义

XYCallConfigBlock

版本支持: 3.10+
接口概述: 呼叫配置回调
接口定义:

typedef void (^XYCallConfigBlock)(XYCallConfig *config);

接口参数:

参数名	类型	是否必填	描述
config	XYCallConfig *	是	呼叫配置对象

返回值: 无

MeetingStateInfoChangedBlock

版本支持: 3.10+
接口概述: 会议状态改变回调
接口定义:

typedef void(^MeetingStateInfoChangedBlock)(XYMeetingStateInfo *_Nullable info);

接口参数:

参数名	类型	是否必填	描述
info	XYMeetingStateInfo *	是	会议状态信息

返回值: 无

XYExtraUserInfoCallback

版本支持: 3.10+
接口概述: 额外用户信息回调
接口定义:

typedef void(^XYExtraUserInfoCallback)(NSString *extUserId, NSDictionary*extraUserInfo);

接口参数:

参数名	类型	是否必填	描述
extUserId	NSString *	是	三方用户ID
extraUserInfo	NSDictionary*	是	额外用户信息，格式：@{@"userPicture":"头像", @"userDisplay":"工号"}

返回值: 无

使用示例

基本使用

// 获取单例
XYMeetingHandle *meetingHandle = [XYMeetingHandle shareInstance];

// 设置代理
meetingHandle.delegate = self;

// 初始化
[XYMeetingHandle setupMeetingKit];

// 加入会议
[XYMeetingHandle joinMeeting:@"123456" password:@"password"];

// 检查是否在会中
BOOL isInMeeting = [XYMeetingHandle isMeeting];

// 离开会议
[XYMeetingHandle leaveMeeting];

带配置的会议加入

[XYMeetingHandle joinMeeting:@"123456" 
                    password:@"password" 
                      config:^(XYCallConfig *config) {
    // 配置会议参数
    config.enableVideo = YES;
    config.enableAudio = YES;
}];

更新配置

[[XYMeetingHandle shareInstance] updateMeetingKitConfig:^(XYMKConfig *config) {
    config.enableVideo = YES;
    config.enableAudio = YES;
    config.enableFaceRecognize = YES;
    config.showMeetingFeedback = YES;
    config.enableVirtualBgAndBeauty = YES;
}];

2025-07-31 11:34:59

导出PDF文档