Packageyy
Interfacepublic interface IChannelMicList extends flash.events.IEventDispatcher

麦序接口,提供麦序的信息和相关事件。



Public Methods
 MethodDefined By
  
clearMicList():Object
清空麦序。需要的权限跟YY客户端一致。
IChannelMicList
  
控麦,即禁止麦首用户说话,麦序时间暂停,管理员除外。需要有管理员及以上权限,规则和权限同YY客户端一致。
IChannelMicList
  
禁麦,即禁止用户加入麦序。需要有管理员及以上权限,规则和权限同YY客户端一致。
IChannelMicList
  
麦首麦序时间加倍。需要有管理员及以上权限,规则和权限同YY客户端一致。
IChannelMicList
  
开麦,即允许用户加入麦序。需要有管理员及以上权限,规则和权限同YY客户端一致。
IChannelMicList
  
获取麦首的麦序时间,返回为秒数。
IChannelMicList
  
获取连麦用户列表。
IChannelMicList
  
getMicList():Object
获取麦序列表。
IChannelMicList
  
获得频道模式。
IChannelMicList
  
查询当前是否是开麦状态。
IChannelMicList
  
查询当前是否是控麦状态。
IChannelMicList
  
joinMicList():Object
加入麦序。
IChannelMicList
  
kickMicListUser(uid:uint):Object
踢人下麦。需要的权限跟YY客户端一致。
IChannelMicList
  
leaveMicList():Object
离开麦序。
IChannelMicList
  
linkMicToTheQueueHead(uid:uint):Object
将用户加入到连麦列表。需要在麦序模式才有效,需要有频道管理员及以上权限才能调用成功。
IChannelMicList
  
moveDownOnePosition(uid:int):Object
将麦序上指定的用户下移一位。麦序模式下有效,需要有管理员及以上权限,规则和权限同YY客户端一致。
IChannelMicList
  
moveUpOnePosition(uid:int):Object
将麦序上指定的用户上移一位。麦序模式下有效,需要有管理员及以上权限,规则和权限同YY客户端一致。
IChannelMicList
  
moveUserToTop(uid:uint):Object
将用户调整到2号麦序。需要的权限跟YY客户端一致。
IChannelMicList
  
pullUserToMicList(uid:uint):Object
拉人上麦。需要的权限跟YY客户端一致。
IChannelMicList
  
放麦,即允许麦首用户说话,麦序时间继续。需要有管理员及以上权限,规则和权限同YY客户端一致。
IChannelMicList
  
removeFromLinkedMicList(uid:uint):Object
将用户移出连麦列表。需要在麦序模式才有效,需要有频道管理员及以上权限才能调用成功。
IChannelMicList
  
发送麦序提醒给2号麦用户,上麦后只能向用户发送一次。需要有管理员及以上权限,规则和权限同YY客户端一致。
IChannelMicList
  
setMicListMode(mode:int):Object
设置频道模式。两次调用需要有一定的时间间隔。
IChannelMicList
Events
 Event Summary Defined By
   麦序用户清除事件。麦序用户全部被清除的时候会触发。 IChannelMicList
   控麦事件。管理员控麦的时候触发。 事件信息格式说明: eventData.adminUid: uint类型 执行控麦操作的管理员的uid。 IChannelMicList
   禁麦事件。管理员禁麦的时候触发。 事件信息格式说明: eventData.adminUid: uint类型 执行禁麦操作的管理员的uid。 IChannelMicList
   开麦事件。管理员开麦的时候触发。 事件信息格式说明: eventData.adminUid: uint类型 执行开麦操作的管理员的uid。 IChannelMicList
   频道模式变化事件。当频道模式发生变化的时候触发。 事件信息格式说明: eventData.mode: int类型 当前的频道模式 0=自由模式,1=主席模式,2=麦序模式。 IChannelMicList
   收到麦序提醒事件。当处在麦序第二位的时候才能收到此事件。。 事件信息格式说明: eventData.adminUid: uint类型 发送提醒的管理员的uid。 IChannelMicList
   放麦事件。管理员放麦的时候触发。 事件信息格式说明: eventData.adminUid: uint类型 执行放麦操作的管理员的uid。 IChannelMicList
   用户说话状态变化事件。用户开始说话和停止说话时会触发,同频道界面用户名前的绿点变化一致。 事件信息格式说明: eventData.uid: uint类型 说话的用户uid。 eventData.speaking: Boolean类型 true=开始说话,false=停止说话。 IChannelMicList
   麦首麦序时间变化事件。管理员修改麦首麦序时间的时候触发。 事件信息格式说明: eventData.adminUid: uint类型 执行麦序时间加倍操作的管理员的uid。 eventData.uid: uint类型 麦首的用户uid。 eventData.seconds: uint类型 变化后的麦序时间,单位为秒。 IChannelMicList
   麦序用户增加事件。当有用户加入到麦序时会触发。 事件信息格式说明: eventData.uid: int类型 加入的用户uid。 IChannelMicList
   麦序用户离开事件。当有用户离开麦序时会触发。 事件信息格式说明: eventData.uid: int类型 离开的用户uid。 IChannelMicList
   用户加入连麦列表事件。当有新的用户连麦的时候触发。 事件信息格式说明: eventData.uid: uint类型 新加入连麦的用户uid。 IChannelMicList
   麦序用户移动事件。麦序用户发生位置调整的时候会触发。 事件信息格式说明: eventData.moveId: int类型 麦序中发生移动的用户uid。 eventData.toAfterId: int类型 移动到哪个用户后面,用户无法移动到第一个。 IChannelMicList
   用户移出连麦列表事件。当有用户移出连麦的时候触发。 事件信息格式说明: eventData.uid: uint类型 被移出连麦的用户uid。 IChannelMicList
Method Detail
clearMicList()method
public function clearMicList():Object

清空麦序。需要的权限跟YY客户端一致。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

controlMicList()method 
public function controlMicList():Object

控麦,即禁止麦首用户说话,麦序时间暂停,管理员除外。需要有管理员及以上权限,规则和权限同YY客户端一致。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

disableJoinMicList()method 
public function disableJoinMicList():Object

禁麦,即禁止用户加入麦序。需要有管理员及以上权限,规则和权限同YY客户端一致。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

doubleFirstMicSeconds()method 
public function doubleFirstMicSeconds():Object

麦首麦序时间加倍。需要有管理员及以上权限,规则和权限同YY客户端一致。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

enableJoinMicList()method 
public function enableJoinMicList():Object

开麦,即允许用户加入麦序。需要有管理员及以上权限,规则和权限同YY客户端一致。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

getFirstMicSeconds()method 
public function getFirstMicSeconds():Object

获取麦首的麦序时间,返回为秒数。

Returns
Object — 返回麦首的麦序时间,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

seconds: Number类型 返回麦首的麦序剩余时间,单位为秒


Example
        使用示例:
        var result:Object = YY.instance.channel.micList.getFirstMicSeconds();
        if(result.ret==0)
        {
            trace("麦首麦序时间剩余:" + result.seconds);
        }
        
        成功的返回值示例:{ ret:0,seconds:248}
        失败的返回值示例:{ ret:984832}
        
getLinkedMicList()method 
public function getLinkedMicList():Object

获取连麦用户列表。

Returns
Object — 返回连麦中的所有用户的uid。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

linkedMicList: Array类型 uid保存在一个数组中。无人连麦时返回空数组。


Example
        使用示例:
        var result:Object=YY.instance.channel.micList.linkedMicList();
        if(result.ret==0)
        {
          trace("在连麦中的用户为:"+result.linkedMicList);
        }
        成功的返回值示例:{ ret:0,linkedMicList:[1234444,2234455,3311344]}
        失败的返回值示例:{ ret:984832}
         
getMicList()method 
public function getMicList():Object

获取麦序列表。

Returns
Object — 返回麦序中所有用户的uid。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

micList: Array类型 返回麦序中所有用户的uid,uid保存在一个数组中。

getMicListMode()method 
public function getMicListMode():Object

获得频道模式。

Returns
Object — 返回当前频道模式,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

cid: Number类型 返回频道模式 ,0=自由模式,1=主席模式,2=麦序模式


Example
        使用示例:
        var result:Object = YY.instance.channel.micList.getMicListMode();
        if(result.ret==0)
        {
            trace("当前频道模式:" + result.mode);
        }
        
        成功的返回值示例:{ ret:0,mode:2}
        失败的返回值示例:{ ret:984832}
         
isJoinMicListEnabled()method 
public function isJoinMicListEnabled():Object

查询当前是否是开麦状态。

Returns
Object — 返回开麦状态,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

enabled: Boolean类型 是否开麦,true=开麦,false=禁麦。


Example
        使用示例:
        var result:Object = YY.instance.channel.micList.isJoinMicListEnabled();
        if(result.ret==0)
        {
            trace("麦首麦序时间剩余:" + result.enabled);
        }
        
        成功的返回值示例:{ ret:0,enabled:true}
        失败的返回值示例:{ ret:984832}
        
isMicListControlled()method 
public function isMicListControlled():Object

查询当前是否是控麦状态。

Returns
Object — 返回控麦状态,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

controlled: Boolean类型 当前是否控麦,true=控麦,false=放麦。


Example
        使用示例:
        var result:Object = YY.instance.channel.micList.isMicListControlled();
        if(result.ret==0)
        {
            trace("麦首麦序时间剩余:" + result.controlled);
        }
        
        成功的返回值示例:{ ret:0,controlled:true}
        失败的返回值示例:{ ret:984832}
        
joinMicList()method 
public function joinMicList():Object

加入麦序。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

kickMicListUser()method 
public function kickMicListUser(uid:uint):Object

踢人下麦。需要的权限跟YY客户端一致。

Parameters

uid:uint — 被踢用户的uid。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

leaveMicList()method 
public function leaveMicList():Object

离开麦序。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

linkMicToTheQueueHead()method 
public function linkMicToTheQueueHead(uid:uint):Object

将用户加入到连麦列表。需要在麦序模式才有效,需要有频道管理员及以上权限才能调用成功。

Parameters

uid:uint — 被连麦用户的uid。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

moveDownOnePosition()method 
public function moveDownOnePosition(uid:int):Object

将麦序上指定的用户下移一位。麦序模式下有效,需要有管理员及以上权限,规则和权限同YY客户端一致。

Parameters

uid:int — 被下移的用户uid。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

moveUpOnePosition()method 
public function moveUpOnePosition(uid:int):Object

将麦序上指定的用户上移一位。麦序模式下有效,需要有管理员及以上权限,规则和权限同YY客户端一致。

Parameters

uid:int — 被上移的用户uid。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

moveUserToTop()method 
public function moveUserToTop(uid:uint):Object

将用户调整到2号麦序。需要的权限跟YY客户端一致。

Parameters

uid:uint — 被移动的用户的uid。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

pullUserToMicList()method 
public function pullUserToMicList(uid:uint):Object

拉人上麦。需要的权限跟YY客户端一致。

Parameters

uid:uint — 被拉用户的uid。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

releaseMicList()method 
public function releaseMicList():Object

放麦,即允许麦首用户说话,麦序时间继续。需要有管理员及以上权限,规则和权限同YY客户端一致。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

removeFromLinkedMicList()method 
public function removeFromLinkedMicList(uid:uint):Object

将用户移出连麦列表。需要在麦序模式才有效,需要有频道管理员及以上权限才能调用成功。

Parameters

uid:uint — 移出连麦的用户的uid。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

sendMicListNotification()method 
public function sendMicListNotification():Object

发送麦序提醒给2号麦用户,上麦后只能向用户发送一次。需要有管理员及以上权限,规则和权限同YY客户端一致。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

setMicListMode()method 
public function setMicListMode(mode:int):Object

设置频道模式。两次调用需要有一定的时间间隔。

Parameters

mode:int — 频道模式,0=自由模式,1=主席模式,2=麦序模式,其它值无效。

Returns
Object — 返回调用是否成功,是一个Object对象,具体属性如下。

ret: int类型 返回码 0=成功,非0值失败,具体请参考错误代码。

Event Detail
CLEAR Event
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.CLEAR

麦序用户清除事件。麦序用户全部被清除的时候会触发。
CONTROLLED Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.CONTROLLED

控麦事件。管理员控麦的时候触发。

事件信息格式说明:

eventData.adminUid: uint类型 执行控麦操作的管理员的uid。

DISABLE_JOIN Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.DISABLE_JOIN

禁麦事件。管理员禁麦的时候触发。

事件信息格式说明:

eventData.adminUid: uint类型 执行禁麦操作的管理员的uid。

ENABLE_JOIN Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.ENABLE_JOIN

开麦事件。管理员开麦的时候触发。

事件信息格式说明:

eventData.adminUid: uint类型 执行开麦操作的管理员的uid。

MODE_CHANGED Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.MODE_CHANGED

频道模式变化事件。当频道模式发生变化的时候触发。

事件信息格式说明:

eventData.mode: int类型 当前的频道模式 0=自由模式,1=主席模式,2=麦序模式。

NOTIFICATION Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.NOTIFICATION

收到麦序提醒事件。当处在麦序第二位的时候才能收到此事件。。

事件信息格式说明:

eventData.adminUid: uint类型 发送提醒的管理员的uid。

RELEASED Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.RELEASED

放麦事件。管理员放麦的时候触发。

事件信息格式说明:

eventData.adminUid: uint类型 执行放麦操作的管理员的uid。

SPEAKING_STATE_CHANGED Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.SPEAKING_STATE_CHANGED

用户说话状态变化事件。用户开始说话和停止说话时会触发,同频道界面用户名前的绿点变化一致。

事件信息格式说明:

eventData.uid: uint类型 说话的用户uid。

eventData.speaking: Boolean类型 true=开始说话,false=停止说话。

TIME_CHANGED Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.TIME_CHANGED

麦首麦序时间变化事件。管理员修改麦首麦序时间的时候触发。

事件信息格式说明:

eventData.adminUid: uint类型 执行麦序时间加倍操作的管理员的uid。

eventData.uid: uint类型 麦首的用户uid。

eventData.seconds: uint类型 变化后的麦序时间,单位为秒。

USER_JOIN Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.USER_JOIN

麦序用户增加事件。当有用户加入到麦序时会触发。

事件信息格式说明:

eventData.uid: int类型 加入的用户uid。

USER_LEAVE Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.USER_LEAVE

麦序用户离开事件。当有用户离开麦序时会触发。

事件信息格式说明:

eventData.uid: int类型 离开的用户uid。

USER_LINKED Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.USER_LINKED

用户加入连麦列表事件。当有新的用户连麦的时候触发。

事件信息格式说明:

eventData.uid: uint类型 新加入连麦的用户uid。

USER_MOVE Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.USER_MOVE

麦序用户移动事件。麦序用户发生位置调整的时候会触发。

事件信息格式说明:

eventData.moveId: int类型 麦序中发生移动的用户uid。

eventData.toAfterId: int类型 移动到哪个用户后面,用户无法移动到第一个。

USER_UNLINKED Event  
Event Object Type: yy.events.ChannelMicListEvent
ChannelMicListEvent.type property = yy.events.ChannelMicListEvent.USER_UNLINKED

用户移出连麦列表事件。当有用户移出连麦的时候触发。

事件信息格式说明:

eventData.uid: uint类型 被移出连麦的用户uid。