文档帮助平台
首页客户端SDK参考 Mac-QT SDK 完整接口介绍 会议
会议
更新时间：2025-04-05 13:20:47

会议

方法总览

方法名称 行为 含义描述
OnMeetingStatusChanged 通知 会议状态变化时的通知;eMeetingState: 变更后的会议状态
OnMeetingFinishReason 通知 会议结束的通知;eMeetingFinishReason: 会议结束的原因码;nCode: 当原因码为其他错误时，根据nCode查询更详细的会议结束原因
OnMeetingKeyOperation 通知 会议中键盘按键被按下;暂未支持;nKeyType: 按下的按键类型
OnMeetingJoinWithoutLoginResult 通知 未登录加入会议的结果通知;eResult: 加入会议的结果;nCode: 对应的错误码
OnJoinMeetingResult 通知 登录加入会议的结果通知;eResult: 加入会议的结果;nCode: 对应的错误码
OnJoinPreviewCloseReason 通知 预览窗口被关闭的原因;eReason: 被关闭的原因
OnEndMeetingFeedBack 通知 结束会议意见反馈通知
StartMeeting 调用 创建一个会议;strMeetingName: 会议的名称，不能为空;listInviteMembers: 会议默认邀请的成员id，多个成员可用,隔开;eMediaType: 会议媒体类型，是否需要使用视频
JoinMeeting 调用 加入会议;dataParam: 入会参数;strMeetingId: 会议id，不能为空: 要加入的会议id;strPassword: 对应的会议密码;eMediaType: 会议媒体类型，是否需要使用视频
LeaveMeeting 调用 离开会议;eCmd: 离开会议时的操作，详见LEAVE_MEETING_CMD的定义
JoinMeetingWithoutLogin 调用 未登录入会;dataParam: 入会信息
JoinThirdPartyMeeting 调用 加入第三方会议;joinParam: 入会信息
GetMeetingStatus 调用 获取当前会议状态
GetMeetingInfo 调用 获取当前会议信息
SetShowEndMeetingFeedback 调用 设置结束会议弹窗是否展示意见反馈按钮
IsShowEndMeetingFeedback 调用 获取结束会议弹窗是否展示意见反馈按钮

OnMeetingStatusChanged

通知描述

会议状态变化时的通知

通知定义

void OnMeetingStatusChanged(MEETING_STATE eMeetingState);

参数描述

参数 类型 含义
eMeetingState MEETING_STATE 变更后的会议状态

表示会议状态的枚举

enum MEETING_STATE {
    MEETING_STATE_IDLE = 0,/** < 空闲状态 */
    MEETING_STATE_AUTHERING = 1,/** < 鉴权中 */
    MEETING_STATE_CONNECTING = 2,/** < 正在加入会议 */
    MEETING_STATE_IN_MEETING = 3,/** < 已经在会议中 */
}

返回值描述

无返回值。

OnMeetingFinishReason

通知描述

会议结束的通知

通知定义

void OnMeetingFinishReason(MEETING_FINISH_REASON eMeetingFinishReason, int nCode);

参数描述

参数 类型 含义
eMeetingFinishReason MEETING_FINISH_REASON 会议结束的原因码
nCode int 当原因码为其他错误时，根据nCode查询更详细的会议结束原因

会议结束原因

enum MEETING_FINISH_REASON {
    MEETING_FINISH_REASON_LEAVE = 0,/** < 自己离开会议 */
    MEETING_FINISH_REASON_BY_HOST_END = 1,/** < 主持人结束了会议 */
    MEETING_FINISH_REASON_MEETING_CONFLICT = 2,/** < 会议资源冲突 */
    MEETING_FINISH_REASON_MEETING_NOT_EXIST = 3,/** < 会议不存在 */
    MEETING_FINISH_REASON_MEETING_EXPIRED = 4,/** < 保活超时 */
    MEETING_FINISH_REASON_MEETING_MEDIA_BROKEN = 5,/** < 媒体通道异常 */
    MEETING_FINISH_REASON_OTHER = 6,/** < 其他错误，详见错误码 */
}

返回值描述

无返回值。

OnMeetingKeyOperation

通知描述

会议中键盘按键被按下;暂未支持

通知定义

void OnMeetingKeyOperation(int nKeyType);

参数描述

参数 类型 含义
nKeyType int 按下的按键类型

返回值描述

无返回值。

OnMeetingJoinWithoutLoginResult

通知描述

未登录加入会议的结果通知

通知定义

void OnMeetingJoinWithoutLoginResult(JOIN_MEETING_RESULT eResult, int nCode);

参数描述

参数 类型 含义
eResult JOIN_MEETING_RESULT 加入会议的结果
nCode int 对应的错误码

加入会议的结果

enum JOIN_MEETING_RESULT {
    JOIN_MEETING_RESULT_SUCCESS = 0,/** < 加入会议的结果 */
    JOIN_MEETING_RESULT_PASSWORD_ERROR = 1,/** < 加入会议密码错误 */
    JOIN_MEETING_RESULT_OTHER = 2,/** < 其他原因 */
}

返回值描述

无返回值。

OnJoinMeetingResult

通知描述

登录加入会议的结果通知

通知定义

void OnJoinMeetingResult(JOIN_MEETING_RESULT eResult, int nCode);

参数描述

参数 类型 含义
eResult JOIN_MEETING_RESULT 加入会议的结果
nCode int 对应的错误码

加入会议的结果

enum JOIN_MEETING_RESULT {
    JOIN_MEETING_RESULT_SUCCESS = 0,/** < 加入会议的结果 */
    JOIN_MEETING_RESULT_PASSWORD_ERROR = 1,/** < 加入会议密码错误 */
    JOIN_MEETING_RESULT_OTHER = 2,/** < 其他原因 */
}

返回值描述

无返回值。

OnJoinPreviewCloseReason

通知描述

预览窗口被关闭的原因

通知定义

void OnJoinPreviewCloseReason(JOIN_MEETING_PREVIEW_CLOSE_REASEON eReason);

参数描述

参数 类型 含义
eReason JOIN_MEETING_PREVIEW_CLOSE_REASEON 被关闭的原因

预览窗口关闭原因

enum JOIN_MEETING_PREVIEW_CLOSE_REASEON {
    JOIN_MEETING_PREVIEW_CLOSE_REASEON_JOIN_MEETING = 0,/** < 加入会议被关闭 */
    JOIN_MEETING_PREVIEW_CLOSE_REASEON_CANCEL_MEETING = 1,/** < 取消会议被关闭 */
    JOIN_MEETING_PREVIEW_CLOSE_REASEON_CANCEL_OTHER = 2,/** < 其他原因 */
}

返回值描述

无返回值。

OnEndMeetingFeedBack

通知描述

结束会议意见反馈通知

通知定义

void OnEndMeetingFeedBack();

参数描述

无参数。

返回值描述

无返回值。

StartMeeting

接口描述

创建一个会议

接口定义

YLSDKERR StartMeeting(string strMeetingName, list<string> listInviteMembers, bool bOpenMic, bool bOpenCamera);

参数描述

参数 类型 含义
strMeetingName string 会议的名称，不能为空
listInviteMembers list 会议默认邀请的成员id，多个成员可用,隔开
bOpenMic bool 无
bOpenCamera bool 无

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

JoinMeeting

接口描述

加入会议

接口定义

YLSDKERR JoinMeeting(JoinMeetingParam dataParam);

参数描述

参数 类型 含义
dataParam JoinMeetingParam 入会参数

JoinMeetingParam 入会信息（正常登录入会用）

struct JoinMeetingParam {
    std::string strMeetingId;/** < 会议id */
    std::string strPassword;/** < 会议密码 */
    bool bOpenMic;/** < 是否开启麦克风 */
    bool bOpenCamera;/** < 是否开启摄像头 */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

LeaveMeeting

接口描述

离开会议

接口定义

YLSDKERR LeaveMeeting(LEAVE_MEETING_CMD eCmd);

参数描述

参数 类型 含义
eCmd LEAVE_MEETING_CMD 离开会议时的操作，详见LEAVE_MEETING_CMD的定义

LEAVE_MEETING_CMD 离开会议的类型

enum LEAVE_MEETING_CMD {
    LEAVE_MEETING_CMD_LEAVE = 0,/** < 仅自己离开会议 */
    LEAVE_MEETING_CMD_END = 1,/** < 结束会议(仅自己是主持人时才生效) */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

JoinMeetingWithoutLogin

接口描述

未登录入会

接口定义

YLSDKERR JoinMeetingWithoutLogin(JoinMeetingWithoutLoginParam dataParam);

参数描述

参数 类型 含义
dataParam JoinMeetingWithoutLoginParam 入会信息

JoinMeetingWithoutLoginParam 未登录入会的入会信息（作未登录入会用）

struct JoinMeetingWithoutLoginParam {
    std::string strUserName;/** < 用户名 */
    std::string strMeetingId;/** < 会议id */
    std::string strPassword;/** < 会议密码 */
    bool bOpenMic;/** < 是否开启麦克风 */
    bool bOpenCamera;/** < 是否开启摄像头 */
    std::string strServer;/** < 服务器地址 */
    std::string strPort;/** < 端口 */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

JoinThirdPartyMeeting

接口描述

加入第三方会议

接口定义

YLSDKERR JoinThirdPartyMeeting(JoinThirdPartyMeetingParam joinParam);

参数描述

参数 类型 含义
joinParam JoinThirdPartyMeetingParam 入会信息

JoinThirdPartyMeetingParam 加入第三方会议的信息

struct JoinThirdPartyMeetingParam {
    std::string strMeetingNumberOrURI;/** < 会议号或uri */
    std::string strPassword;/** < 会议密码 */
    bool bOpenMic;/** < 是否开启麦克风 */
    bool bOpenCamera;/** < 是否开启摄像头 */
    Join3rdMeetingProtocolType eProtocolType;/** < 呼叫协议 */
}

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

GetMeetingStatus

接口描述

获取当前会议状态

接口定义

MEETING_STATE GetMeetingStatus();

参数描述

无参数。

返回值描述

类型 含义
MEETING_STATE 表示会议状态的枚举

MEETING_STATE 表示会议状态的枚举

enum MEETING_STATE {
    MEETING_STATE_IDLE = 0,/** < 空闲状态 */
    MEETING_STATE_AUTHERING = 1,/** < 鉴权中 */
    MEETING_STATE_CONNECTING = 2,/** < 正在加入会议 */
    MEETING_STATE_IN_MEETING = 3,/** < 已经在会议中 */
}

GetMeetingInfo

接口描述

获取当前会议信息

接口定义

MeetingInfo GetMeetingInfo();

参数描述

无参数。

返回值描述

类型 含义
MeetingInfo 会议信息

MeetingInfo 会议信息

struct MeetingInfo {
    std::string strMeetingId;/** < 会议id */
    std::string strMeetingNumber;/** < 会议号码 */
    std::string strPassword;/** < 会议密码 */
    std::string strDisplayName;/** < 会议主题 */
    std::string strJoinUrl;/** < 入会url */
    std::string strIntranetJoinUrl;/** < 内网入会url */
    int64_t tCreateDataTime;/** < 通话创建UTC时间，单位秒 */
}

SetShowEndMeetingFeedback

接口描述

设置结束会议弹窗是否展示意见反馈按钮

接口定义

YLSDKERR SetShowEndMeetingFeedback(bool bShowFeedBack);

参数描述

参数 类型 含义
bShowFeedBack bool 无

返回值描述

类型 含义
YLSDKERR 错误码,详情见错误码 YLSDKERR 的定义

IsShowEndMeetingFeedback

接口描述

获取结束会议弹窗是否展示意见反馈按钮

接口定义

bool IsShowEndMeetingFeedback();

参数描述

无参数。

返回值描述

类型 含义
bool 无
本页目录