YYClientSDK  beta 1.15
 全部 类 函数 枚举 枚举值
Public 成员函数 | 所有成员列表
yy::IChannelMicList结构体 参考abstract

[interface] 麦序接口 获取麦序列表，注册麦序变化事件相关。注意，此接口只能在麦序模式下使用 更多...

#include <yy-api-client.h>

Public 成员函数

virtual const IMicListItem * GetMicList ()=0
 获取麦序列表
 
virtual int RegisterMicListEvent (IMicListEvent *e)=0
 注册频道麦序事件
 
virtual int UnRegisterMicListEvent (IMicListEvent *e)=0
 反注册频道麦序事件
 
virtual int JoinMicList ()=0
 加入麦序
 
virtual int LeaveMicList ()=0
 离开麦序
 
virtual int MoveUserToTop (unsigned int uid)=0
 移动用户到麦序顶端
 
virtual int PullUserToMicList (unsigned int uid)=0
 拉人上麦序
 
virtual int KickMicListUser (unsigned int uid)=0
 踢麦序上的人
 
virtual int ClearMicList ()=0
 清空麦序
 
virtual int GetLinkedMicList (const IMicListItem **h)=0
 获取连麦列表
 
virtual int LinkMicToTheQueueHead (unsigned int uid)=0
 设置某人跟 首号麦连麦，不在麦序上的 人不能设置连麦
 
virtual int RemoveFromLinkedMicList (unsigned int uid)=0
 将某人从连麦列表里去除
 
virtual int GetMicListMode (YYEnums::EMicListMode &mode)=0
 获取麦序模式
 
virtual int SetMicListMode (YYEnums::EMicListMode m)=0
 设置麦序模式
 
virtual int RegisterMicListEvent2 (IMicListEvent2 *e)=0
 注册频道麦序事件 扩展1
 
virtual int UnRegisterMicListEvent2 (IMicListEvent2 *e)=0
 反注册频道麦序事件 扩展1
 
virtual int MoveUpOnePosition (unsigned int uid)=0
 将麦序上的某个人的位置往上提升一位，首麦和第二买不能上移
 
virtual int MoveDownOnePosition (unsigned int uid)=0
 将麦序上的某个人的位置往上下移一位，最后一位不能下移
 
virtual int GetFirstMicSeconds (unsigned int &seconds)=0
 获取首位麦序秒数时长
 
virtual int DoubleFirstMicSeconds ()=0
 双倍首麦时长秒数
 
virtual int EnableJoinMicList ()=0
 开麦
 
virtual int DisableJoinMicList ()=0
 禁麦
 
virtual int IsJoinMicListEnabled (bool &enabled)=0
 是否开麦
 
virtual int ControlMic ()=0
 控麦
 
virtual int ReleaseMic ()=0
 放麦
 
virtual int IsMicListControlled (bool &controlled)=0
 是否控麦状态
 
virtual int SendMicListNotification ()=0
 发送给二号麦麦序提醒
 
virtual int RegisterMicListMgrEvent (IMicListMgrEvent *e)=0
 注册麦序管理事件
 
virtual int UnRegisterMicListMgrEvent (IMicListMgrEvent *e)=0
 反注册麦序事件3
 

详细描述

[interface] 麦序接口 获取麦序列表，注册麦序变化事件相关。注意，此接口只能在麦序模式下使用

成员函数说明

virtual int yy::IChannelMicList::ClearMicList ( )
pure virtual

清空麦序

返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::ControlMic ( )
pure virtual

控麦

返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::DisableJoinMicList ( )
pure virtual

禁麦

返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::DoubleFirstMicSeconds ( )
pure virtual

双倍首麦时长秒数

返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::EnableJoinMicList ( )
pure virtual

开麦

返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::GetFirstMicSeconds ( unsigned int &  seconds)
pure virtual

获取首位麦序秒数时长

参数
unsignedint &seconds, [in] 首麦秒数时长
返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::GetLinkedMicList ( const IMicListItem **  h)
pure virtual

获取连麦列表

参数
IMicListItem** , 麦序列表头
返回
int, 0 success,其他值 error，查看错误代码表
virtual const IMicListItem* yy::IChannelMicList::GetMicList ( )
pure virtual

获取麦序列表

返回
IMicListItem * ,有效指针 success，error返回NULL
virtual int yy::IChannelMicList::GetMicListMode ( YYEnums::EMicListMode &  mode)
pure virtual

获取麦序模式

参数
EMicListModule&m, 麦序模式引用，
返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::IsJoinMicListEnabled ( bool &  enabled)
pure virtual

是否开麦

返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::IsMicListControlled ( bool &  controlled)
pure virtual

是否控麦状态

返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::JoinMicList ( )
pure virtual

加入麦序

返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::KickMicListUser ( unsigned int  uid)
pure virtual

踢麦序上的人

参数
unsignedint uid 用户id
返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::LeaveMicList ( )
pure virtual

离开麦序

返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::LinkMicToTheQueueHead ( unsigned int  uid)
pure virtual

设置某人跟 首号麦连麦，不在麦序上的 人不能设置连麦

参数
unsignedint uid, 麦序列表中的 用户 uid，
返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::MoveDownOnePosition ( unsigned int  uid)
pure virtual

将麦序上的某个人的位置往上下移一位，最后一位不能下移

参数
unsignedint uid, [in] 麦上用户 uid
返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::MoveUpOnePosition ( unsigned int  uid)
pure virtual

将麦序上的某个人的位置往上提升一位，首麦和第二买不能上移

参数
unsignedint uid, [in] 麦上用户 uid
返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::MoveUserToTop ( unsigned int  uid)
pure virtual

移动用户到麦序顶端

参数
unsignedint uid 用户id
返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::PullUserToMicList ( unsigned int  uid)
pure virtual

拉人上麦序

参数
unsignedint uid 用户id
返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::RegisterMicListEvent ( IMicListEvent *  e)
pure virtual

注册频道麦序事件

参数
[in]IMicListEvent*e,有效的右键菜单事件指针
返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::RegisterMicListEvent2 ( IMicListEvent2 *  e)
pure virtual

注册频道麦序事件 扩展1

参数
[in]IMicListEvent2*e,有效的麦序事件指针
返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::RegisterMicListMgrEvent ( IMicListMgrEvent *  e)
pure virtual

注册麦序管理事件

返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::ReleaseMic ( )
pure virtual

放麦

返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::RemoveFromLinkedMicList ( unsigned int  uid)
pure virtual

将某人从连麦列表里去除

参数
unsignedint uid, 连麦列表中的 用户 uid，
返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::SendMicListNotification ( )
pure virtual

发送给二号麦麦序提醒

返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::SetMicListMode ( YYEnums::EMicListMode  m)
pure virtual

设置麦序模式

参数
EMicListModulem, 麦序模式
返回
int, 0 success,其他值 error，查看错误代码表
virtual int yy::IChannelMicList::UnRegisterMicListEvent ( IMicListEvent *  e)
pure virtual

反注册频道麦序事件

参数
[in]IMicListEvent*e,有效的右键菜单事件指针
返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::UnRegisterMicListEvent2 ( IMicListEvent2 *  e)
pure virtual

反注册频道麦序事件 扩展1

参数
[in]IMicListEvent2*e,有效的麦序事件指针
返回
int, 0 success ,其他值 error,参考错误代码表
virtual int yy::IChannelMicList::UnRegisterMicListMgrEvent ( IMicListMgrEvent *  e)
pure virtual

反注册麦序事件3

返回
int, 0 success ,其他值 error,参考错误代码表
生成于 2013年 七月 4日 星期四 18:46:36 , 为 YYClientSDK使用   doxygen 1.8.2