YY开放平台 JavaScript SDK 1.19 参考手册

---

Classes

• IYY
• IYYAudio
• IYYChannel
• IYYChannelAppMsg
• IYYChannelChat
• IYYChannelMicList
• IYYChannelTabPage
• IYYChannelUserController
• IYYChannelUserListPopMenu
• IYYCloud
• IYYCommon
• IYYFinance
• IYYIM
• IYYInteraction
• IYYNet
• IYYReceptionChannel
• IYYSecurity
• IYYTempAudioSession
• IYYUser
• IYYVideo
• YYCloudFilter

---

Class IYYChannelMicList

Extends IYYCommon.
麦序接口，提供麦序的信息和相关事件。
Defined in: yyapi.js.

Class Summary

Constructor Attributes	Constructor Name and Description
	IYYChannelMicList() IYYChannelMicList 构造函数。

Field Summary

Field Attributes	Field Name and Description
<static>	IYYChannelMicList.CLEAR 麦序用户清除事件。麦序用户全部被清除的时候会触发。
<static>	IYYChannelMicList.CONTROLLED 控麦事件。管理员控麦的时候触发。
<static>	IYYChannelMicList.DISABLE_JOIN 禁麦事件。管理员禁麦的时候触发。
<static>	IYYChannelMicList.ENABLE_JOIN 开麦事件。管理员开麦的时候触发。
<static>	IYYChannelMicList.MODE_CHANGED 频道模式变化事件。当频道模式发生变化的时候触发。
<static>	IYYChannelMicList.NOTIFICATION 收到麦序提醒事件。当处在麦序第二位的时候才能收到此事件。
<static>	IYYChannelMicList.RELEASED 放麦事件。管理员放麦的时候触发。
<static>	IYYChannelMicList.SPEAKING_STATE_CHANGED 用户说话状态变化事件。用户开始说话和停止说话时会触发，同频道界面用户名前的绿点变化一致。
<static>	IYYChannelMicList.TIME_CHANGED 麦首麦序时间变化事件。管理员修改麦首麦序时间的时候触发。
<static>	IYYChannelMicList.USER_JOIN 麦序用户增加事件。当有用户加入到麦序时会触发。
<static>	IYYChannelMicList.USER_LEAVE 麦序用户离开事件。当有用户离开麦序时会触发。
<static>	IYYChannelMicList.USER_LINKED 用户加入连麦列表事件。当有新的用户连麦的时候触发。
<static>	IYYChannelMicList.USER_MOVE 麦序用户移动事件。麦序用户发生位置调整的时候会触发。
<static>	IYYChannelMicList.USER_UNLINKED 用户移出连麦列表事件。当有用户移出连麦的时候触发。

Method Summary

Method Attributes	Method Name and Description
	clearMicList() 清空麦序。需要的权限跟YY客户端一致。
	controlMicList() 控麦，即禁止麦首用户说话，麦序时间暂停，管理员除外。需要有管理员及以上权限，规则和权限同YY客户端一致。
	disableJoinMicList() 禁麦，即禁止用户加入麦序。需要有管理员及以上权限，规则和权限同YY客户端一致。
	doubleFirstMicSeconds() 麦首麦序时间加倍。需要有管理员及以上权限，规则和权限同YY客户端一致。
	enableJoinMicList() 开麦，即允许用户加入麦序。需要有管理员及以上权限，规则和权限同YY客户端一致。
	getFirstMicSeconds() 获取麦首的麦序时间，返回为秒数。
	getLinkedMicList() 获取连麦用户列表。
	getMicList() 获取麦序用户列表。
	getMicListMode() 获得频道模式。
	isJoinMicListEnabled() 查询当前是否是开麦状态。
	isMicListControlled() 查询当前是否是控麦状态。
	joinMicList() 加入麦序。
	kickMicListUser(uid) 踢人下麦。需要的权限跟YY客户端一致。
	leaveMicList() 离开麦序。
	linkMicToTheQueueHead(uid) 将用户加入到连麦列表。需要在麦序模式才有效，需要有频道管理员及以上权限才能调用成功。
	moveDownOnePosition(uid) 将麦序上指定的用户下移一位。麦序模式下有效，需要有管理员及以上权限，规则和权限同YY客户端一致。
	moveUpOnePosition(uid) 将麦序上指定的用户上移一位。麦序模式下有效，需要有管理员及以上权限，规则和权限同YY客户端一致。
	moveUserToTop(uid) 将用户调整到2号麦序。需要的权限跟YY客户端一致。
	pullUserToMicList(uid) 拉人上麦。需要的权限跟YY客户端一致。
	releaseMicList() 放麦，即允许麦首用户说话，麦序时间继续。需要有管理员及以上权限，规则和权限同YY客户端一致。
	removeFromLinkedMicList(uid) 将用户移出连麦列表。需要在麦序模式才有效，需要有频道管理员及以上权限才能调用成功。
	sendMicListNotification() 发送麦序提醒给2号麦用户，上麦后只能向用户发送一次。需要有管理员及以上权限，规则和权限同YY客户端一致。
	setMicListMode(mode) 设置频道模式。需要有管理员及以上权限，两次调用需要有一定的时间间隔。

Methods borrowed from class IYYCommon:

addEventListener, removeEventListener

侦听函数格式: function(){    }

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.CLEAR,onUserClear);

function onUserClear()
{
    document.getElementById("txtLog").innerHTML="麦序用户被清除";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.adminUid: Number类型 执行控麦操作的管理员的uid。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.CONTROLLED,onMicControlled);

function onMicControlled(eventData)
{
    document.getElementById("txtLog").innerHTML="管理员"+eventData.adminUid+"执行了控麦操作";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.adminUid: Number类型 执行禁麦操作的管理员的uid。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.DISABLE_JOIN,onMicDisableJoin);

function onMicDisableJoin(eventData)
{
    document.getElementById("txtLog").innerHTML="管理员"+eventData.adminUid+"执行了禁麦操作";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.adminUid: Number类型 执行开麦操作的管理员的uid。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.ENABLE_JOIN,onMicEnableJoin);

function onMicEnableJoin(eventData)
{
    document.getElementById("txtLog").innerHTML="管理员"+eventData.adminUid+"执行了开麦操作";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.mode: Number类型 当前的频道模式 0=自由模式，1=主席模式，2=麦序模式。

使用示例： 
yy.channel.micList.addEventListener(IYYChannelMicList.MODE_CHANGED,onModeChanged);

function onModeChanged(eventData)
{
    document.getElementById("txtLog").innerHTML="当前频道模式="+eventData.mode;
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.adminUid: Number类型 发送提醒的管理员的uid。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.NOTIFICATION,onRecvNotification);

function onRecvNotification(eventData)
{
    document.getElementById("txtLog").innerHTML="收到来自"+eventData.adminUid+"的麦序提醒";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.adminUid: Number类型 执行放麦操作的管理员的uid。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.RELEASED,onMicReleased);

function onMicReleased(eventData)
{
    document.getElementById("txtLog").innerHTML="管理员"+eventData.adminUid+"执行了放麦操作";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.uid: Number类型 说话的用户uid。
eventData.speaking: Boolean类型 true=开始说话，false=停止说话

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.SPEAKING_STATE_CHANGED,onSpeakingStateChanged);

function onSpeakingStateChanged(eventData)
{
    document.getElementById("txtLog").innerHTML="用户"+eventData.uid+"说话状态:"+eventData.speaking;
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.adminUid: Number类型 执行麦序时间加倍操作的管理员的uid。
eventData.uid: Number类型 麦首的用户uid。
eventData.seconds: Number类型 变化后的麦序时间，单位为秒。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.TIME_CHANGED,onMicTimeChanged);

function onMicTimeChanged(eventData)
{
    document.getElementById("txtLog").innerHTML="管理员"+eventData.adminUid+"修改麦首"+eventData.uid+"的麦序时间为"+eventData.seconds+"秒";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.uid: Number类型 加入的用户uid。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.USER_JOIN,onUserJoin);

function onUserJoin(eventData)
{
    document.getElementById("txtLog").innerHTML="用户"+eventData.uid+"加入到了麦序中";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.uid: Number类型 离开的用户uid。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.USER_LEAVE,onUserLeave);

function onUserLeave(eventData)
{
    document.getElementById("txtLog").innerHTML="用户"+eventData.uid+"离开麦序了";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.uid: Number类型 新加入连麦的用户uid。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.USER_LINKED,onUserLinked);

function onUserLinked(eventData)
{
    document.getElementById("txtLog").innerHTML="用户"+eventData.uid+"加入连麦";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.moveId: Number类型 麦序中发生移动的用户uid。
eventData.toAfterId: Number类型 移动到哪个用户后面，用户无法移动到第一个。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.USER_MOVE,onUserMove);

function onUserMove(eventData)
{
    document.getElementById("txtLog").innerHTML="用户"+eventData.uid+"移动到"+eventData.toAfterId+"后面";
}

---

侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.uid: Number类型 被移出连麦的用户uid。

使用示例：
yy.channel.micList.addEventListener(IYYChannelMicList.USER_UNLINKED,onUserUnlinked);

function onUserUnlinked(eventData)
{
    document.getElementById("txtLog").innerHTML="用户"+eventData.uid+"移出连麦";
}

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

使用示例:
var result = yy.channel.micList.getFirstMicSeconds();
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML = "麦首麦序时间剩余：" + result.seconds;
}
  
成功的返回值示例:{ ret:0,seconds:248}
失败的返回值示例:{ ret:984832}

Returns:

返回麦首的麦序时间，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
seconds: Number类型 返回麦首的麦序剩余时间，单位为秒

---

使用示例:
var result=yy.channel.micList.linkedMicList();
if(result.ret==0)
{
  document.getElementById("txtLog").innerHTML="在连麦中的用户为："+result.linkedMicList;
}
成功的返回值示例:{ ret:0,linkedMicList:[1234444,2234455,3311344]}
失败的返回值示例:{ ret:984832}

Returns:

返回连麦中的所有用户的uid。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
linkedMicList: Array类型 uid保存在一个数组中。无人连麦时返回空数组。

---

使用示例:
var result=yy.channel.micList.getMicList();
if(result.ret==0)
{
  document.getElementById("txtLog").innerHTML="在麦序中的用户为："+result.micList;
}
成功的返回值示例:{ ret:0,micList:[1234444,2234455,3311344]}
失败的返回值示例:{ ret:984832}

Returns:

返回麦序中所有用户的uid。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
micList: Array类型 返回麦序中所有用户的uid，uid保存在一个数组中。

---

使用示例:
var result = yy.channel.micList.getMicListMode();
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML = "当前频道模式：" + result.mode;
}
  
成功的返回值示例:{ ret:0,mode:2}
失败的返回值示例:{ ret:984832}

Returns:

返回当前频道模式，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
cid: Number类型 返回频道模式 ，0=自由模式，1=主席模式，2=麦序模式

---

使用示例:
var result = yy.channel.micList.isJoinMicListEnabled();
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML = "麦首麦序时间剩余：" + result.enabled;
}
  
成功的返回值示例:{ ret:0,enabled:true}
失败的返回值示例:{ ret:984832}

Returns:

返回开麦状态，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
enabled: Boolean类型 是否开麦，true=开麦，false=禁麦。

---

使用示例:
var result = yy.channel.micList.isMicListControlled();
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML = "麦首麦序时间剩余：" + result.controlled;
}
  
成功的返回值示例:{ ret:0,controlled:true}
失败的返回值示例:{ ret:984832}

Returns:

返回控麦状态，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
controlled: Boolean类型 当前是否控麦，true=控麦，false=放麦。

---

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Parameters:

{Number} uid

被踢用户的uid。

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Parameters:

{Number} uid

被连麦用户的uid。

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Parameters:

{Number} uid

被下移的用户uid。

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Parameters:

{Number} uid

被上移的用户uid。

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Parameters:

{Number} uid

被移动用户的uid。

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Parameters:

{Number} uid

被拉用户的uid。

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Parameters:

{Number} uid

移出连麦的用户的uid。

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---

Parameters:

{Number} mode

频道模式，0=自由模式，1=主席模式，2=麦序模式，其它值无效。

Returns:

返回调用是否成功，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。

---