参会成员

方法总览

方法名称	行为	含义描述
OnUnJoinedMemberUpdate	通知	未入会用户列表更新
OnMemberCountChanged	通知	用户数量变化
OnInteractiveUserAdd	通知	互动方用户增加
OnInteractiveUserDelete	通知	互动方用户减少
OnBroadcastUserAdd	通知	广播方用户增加
OnBroadcastUserDelete	通知	广播方用户减少
GetUnJoinedMemberInfoList	调用	获取未入会成员列表
CallUnJoinedMember	调用	重新邀请成员
RemoveUnJoinedMember	调用	移除未入会成员
GetMyRoleInfo	调用	获取自身信息
GetParticipantList	调用	获取参会成员id列表
GetParticipantRoleInfo	调用	获取指定参会成员信息;nUserId: 需要获取信息的成员id，为会议中的userid
ChangeMyName	调用	修改自身在会中的名称
ChangeUserName	调用	修改用户在会中的名称;nUserId: 需要改名的成员id，为会议中的userid
SetUserAudioMute	调用	修改用户音频开关状态;nUserId: 需要改名的成员id，为会议中的userid;bMute是否关闭
SetUserVideoMute	调用	修改用户视频开关状态;nUserId: 需要改名的成员id，为会议中的userid;bMute是否关闭
ExpelUser	调用	将用户移出会议;nUserId: 需要移除的成员id，为会议中的userid
MuteAllOther	调用	除自己以外，将会中所有人静音
UnmuteAllOther	调用	除自己以外，将会中所有人解除静音
SetUserRole	调用	设置用户角色;nUserId: 需要修改身份的成员id，为会议中的userid;eRole: 需要修改的身份
GetIsHost	调用	获取自己是不是主持人

OnUnJoinedMemberUpdate

通知描述

未入会用户列表更新

通知定义

void OnUnJoinedMemberUpdate();

参数描述

无参数。

返回值描述

无返回值。

OnMemberCountChanged

通知描述

用户数量变化

通知定义

void OnMemberCountChanged(int nTotalCount);

参数描述

参数	类型	含义
nTotalCount	int	无

返回值描述

无返回值。

OnInteractiveUserAdd

通知描述

互动方用户增加

通知定义

void OnInteractiveUserAdd(MeetingMemberInfoList memberInfoList);

参数描述

参数	类型	含义
memberInfoList	MeetingMemberInfoList	无

人员信息列表

struct MeetingMemberInfoList {
    std::vector<MeetingMemberInfo> vecMemberInfoList;/** < 人员信息列表 */
}

返回值描述

无返回值。

OnInteractiveUserDelete

通知描述

互动方用户减少

通知定义

void OnInteractiveUserDelete(MeetingMemberInfoList memberInfoList);

参数描述

参数	类型	含义
memberInfoList	MeetingMemberInfoList	无

人员信息列表

struct MeetingMemberInfoList {
    std::vector<MeetingMemberInfo> vecMemberInfoList;/** < 人员信息列表 */
}

返回值描述

无返回值。

OnBroadcastUserAdd

通知描述

广播方用户增加

通知定义

void OnBroadcastUserAdd(MeetingMemberInfoList memberInfoList);

参数描述

参数	类型	含义
memberInfoList	MeetingMemberInfoList	无

人员信息列表

struct MeetingMemberInfoList {
    std::vector<MeetingMemberInfo> vecMemberInfoList;/** < 人员信息列表 */
}

返回值描述

无返回值。

OnBroadcastUserDelete

通知描述

广播方用户减少

通知定义

void OnBroadcastUserDelete(MeetingMemberInfoList memberInfoList);

参数描述

参数	类型	含义
memberInfoList	MeetingMemberInfoList	无

人员信息列表

struct MeetingMemberInfoList {
    std::vector<MeetingMemberInfo> vecMemberInfoList;/** < 人员信息列表 */
}

返回值描述

无返回值。

GetUnJoinedMemberInfoList

接口描述

获取未入会成员列表

接口定义

UnJoinedMemberInfoList GetUnJoinedMemberInfoList();

参数描述

无参数。

返回值描述

类型	含义
UnJoinedMemberInfoList	未入会人员信息列表

UnJoinedMemberInfoList 未入会人员信息列表

struct UnJoinedMemberInfoList {
    std::vector<UnJoinedMemberInfo> unJoinedMemberList;/**  */
}

CallUnJoinedMember

接口描述

重新邀请成员

接口定义

YLSDKERR CallUnJoinedMember(UnJoinedMemberInfo unJoinedMemberInfo);

参数描述

参数	类型	含义
unJoinedMemberInfo	UnJoinedMemberInfo	无

UnJoinedMemberInfo 未入会人员信息

struct UnJoinedMemberInfo {
    std::string displayName;/** < 名称 */
    std::string strInviteTransId;/** < 邀请事务id */
    std::string strAccount;/** < 账号 */
    std::string strSubjectId;/** < subjectId */
    std::string strContact;/** < 被邀请者信息 */
    InviteStatus inviteStatus;/** < 邀请状态 */
    InviteType inviteType;/** < 邀请类型 */
}

返回值描述

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

RemoveUnJoinedMember

接口描述

移除未入会成员

接口定义

YLSDKERR RemoveUnJoinedMember(UnJoinedMemberInfo unJoinedMemberInfo);

参数描述

参数	类型	含义
unJoinedMemberInfo	UnJoinedMemberInfo	无

UnJoinedMemberInfo 未入会人员信息

struct UnJoinedMemberInfo {
    std::string displayName;/** < 名称 */
    std::string strInviteTransId;/** < 邀请事务id */
    std::string strAccount;/** < 账号 */
    std::string strSubjectId;/** < subjectId */
    std::string strContact;/** < 被邀请者信息 */
    InviteStatus inviteStatus;/** < 邀请状态 */
    InviteType inviteType;/** < 邀请类型 */
}

返回值描述

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

GetMyRoleInfo

接口描述

获取自身信息

接口定义

MeetingMemberInfo GetMyRoleInfo();

参数描述

无参数。

返回值描述

类型	含义
MeetingMemberInfo	会议人员信息

MeetingMemberInfo 会议人员信息

struct MeetingMemberInfo {
    std::string strName;/** < 人员名字 */
    MEMBER_ROLE eMemberRole;/** < 角色类型 */
    int nUserId;/** < 成员id */
}

GetParticipantList

接口描述

获取参会成员id列表

接口定义

ParticipantList GetParticipantList();

参数描述

无参数。

返回值描述

类型	含义
ParticipantList	参会人列表

ParticipantList 参会人列表

struct ParticipantList {
    std::vector<int> vecParticipantList;/** < 参会人id列表 */
}

GetParticipantRoleInfo

接口描述

获取指定参会成员信息

接口定义

MeetingMemberInfo GetParticipantRoleInfo(int nUserId);

参数描述

参数	类型	含义
nUserId	int	需要获取信息的成员id，为会议中的userid

返回值描述

类型	含义
MeetingMemberInfo	会议人员信息

MeetingMemberInfo 会议人员信息

struct MeetingMemberInfo {
    std::string strName;/** < 人员名字 */
    MEMBER_ROLE eMemberRole;/** < 角色类型 */
    int nUserId;/** < 成员id */
}

ChangeMyName

接口描述

修改自身在会中的名称

接口定义

YLSDKERR ChangeMyName(string strName);

参数描述

参数	类型	含义
strName	string	无

返回值描述

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

ChangeUserName

接口描述

修改用户在会中的名称

接口定义

YLSDKERR ChangeUserName(int nUserId, string strName);

参数描述

参数	类型	含义
nUserId	int	需要改名的成员id，为会议中的userid
strName	string	无

返回值描述

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

SetUserAudioMute

接口描述

修改用户音频开关状态

接口定义

YLSDKERR SetUserAudioMute(int nUserId, bool bMute);

参数描述

参数	类型	含义
nUserId	int	需要改名的成员id，为会议中的userid
bMute	bool	无

返回值描述

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

SetUserVideoMute

接口描述

修改用户视频开关状态

接口定义

YLSDKERR SetUserVideoMute(int nUserId, bool bMute);

参数描述

参数	类型	含义
nUserId	int	需要改名的成员id，为会议中的userid
bMute	bool	无

返回值描述

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

ExpelUser

接口描述

将用户移出会议

接口定义

YLSDKERR ExpelUser(int nUserId);

参数描述

参数	类型	含义
nUserId	int	需要移除的成员id，为会议中的userid

返回值描述

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

MuteAllOther

接口描述

除自己以外，将会中所有人静音

接口定义

YLSDKERR MuteAllOther();

参数描述

无参数。

返回值描述

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

UnmuteAllOther

接口描述

除自己以外，将会中所有人解除静音

接口定义

YLSDKERR UnmuteAllOther();

参数描述

无参数。

返回值描述

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

SetUserRole

接口描述

设置用户角色

接口定义

YLSDKERR SetUserRole(int nUserId, MEMBER_ROLE eRole);

参数描述

参数	类型	含义
nUserId	int	需要修改身份的成员id，为会议中的userid
eRole	MEMBER_ROLE	需要修改的身份

MEMBER_ROLE 会议成员角色类型

enum MEMBER_ROLE {
    MEMBER_ROLE_HOST = 0,/** < 主持人 */
    MEMBER_ROLE_COHOST = 1,/** < 联席主持人 */
    MEMBER_ROLE_ATTENDEE = 2,/** < 参会者 */
    MEMBER_ROLE_AUDIENCE = 3,/** < 观众 */
    MEMBER_ROLE_INVALID = 4,/** < 异常 */
}

返回值描述

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

GetIsHost

接口描述

获取自己是不是主持人

接口定义

bool GetIsHost();

参数描述

无参数。

返回值描述

类型	含义
bool	无