Class IYYTempAudioSession

Extends IYYCommon.
临时语音接口。提供创建房间、加入房间、离开房间以及在房间语音聊天的功能.通过此接口可以跟其他用户建立临时语音聊天通道。注意：用户同一时刻只能在一个房间进行语音聊天 所以在同一个YY上面，同一时刻，最多只有一个应用在使用临时语音。
Defined in: yyapi.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	IYYTempAudioSession() IYYTempAudioSession 构造函数。

Field Summary
Field Attributes	Field Name and Description
<static>	IYYTempAudioSession.SPEAKER_CHANGED 说话人数变化事件。当临时语音房间的说话人数发生变化时触发，即当有人调用startSpeak或stopSpeak成功时会触发。
<static>	IYYTempAudioSession.USER_ENTER_ROOM 用户进入房间事件。
<static>	IYYTempAudioSession.USER_LEAVE_ROOM 用户离开房间事件。

Method Summary
Method Attributes	Method Name and Description
	createRoom() 创建一个临时语音房间。创建后用户自动进入该房间。在应用的生命周期内，同一个用户只能创建一个房间,第二次调用此函数会返回已经创建的房间的rid。房间中能够发言的人数有限，先要先得，目前暂定为5人。
	enterRoom(rid) 进入一个房间。刚进入时，能听到其他人的语音，但自己暂时不能发言。如果已经在某个房间中，需要调用leaveRoom退出这个房间调用,才能进入另外一个房间。
	getOwner() 正在使用临时语音的应用的AppId，可以用来查询临时语音的占用情况。一个YY上同时只能有一个应用在使用临时语音。
	getVolume() 获取临时语音房间音量。
	leaveRoom() 离开房间。如果房间人数为0，服务器过一段时间后会销毁这个房间。
	setVolume(vol) 设置临时语音房间音量。
	startSpeak() 开始语音聊天。调用成功后，自己可以在房间中发言。
	stopSpeak() 禁止语音聊天。调用成功后，自己不能在房间中发言。

Methods borrowed from class IYYCommon:: addEventListener, removeEventListener

Class Detail

IYYTempAudioSession()

IYYTempAudioSession 构造函数。

Field Detail

<static> IYYTempAudioSession.SPEAKER_CHANGED

说话人数变化事件。当临时语音房间的说话人数发生变化时触发，即当有人调用startSpeak或stopSpeak成功时会触发。

侦听函数格式: function(eventData){    } 
eventData.speakerList: Array类型  当前房间可以说话的人的uid。

使用示例：
yy.tempAudioSession.addEventListener(IYYTempAudioSession.SPEAKER_CHANGED,onSpeakerChanged);

function onSpeakerChanged(eventData)
{
    document.getElementById("txtSpeakerEventLog").innerHTML += "说话人数变化:["+eventData.speakerList.toString()+"]
";
}

<static> IYYTempAudioSession.USER_ENTER_ROOM

用户进入房间事件。

侦听函数格式: function(eventData){    } 
eventData.rid: Number类型  进入的房间的rid。
eventData.uid: Number类型  进入房间的用户的uid。

使用示例：
yy.tempAudioSession.addEventListener(IYYTempAudioSession.USER_ENTER_ROOM,onUserEnterRoom);

function onUserEnterRoom(eventData)
{
    document.getElementById("txtLog").innerHTML="用户"+eventData.uid+"进入了房间"+eventData.rid;
}

<static> IYYTempAudioSession.USER_LEAVE_ROOM

用户离开房间事件。

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

使用示例：
yy.tempAudioSession.addEventListener(IYYTempAudioSession.USER_LEAVE_ROOM,onUserLeaveRoom);

function onUserLeaveRoom(eventData)
{
    document.getElementById("txtLog").innerHTML="用户"+eventData.uid+"离开了房间"+eventData.rid;
}

Method Detail

{Object} createRoom()

创建一个临时语音房间。创建后用户自动进入该房间。在应用的生命周期内，同一个用户只能创建一个房间,第二次调用此函数会返回已经创建的房间的rid。房间中能够发言的人数有限，先要先得，目前暂定为5人。

使用示例:
var result = yy.tempAudioSession.createRoom();
if (result.ret == 0) {
  document.getElementById("txtLog").innerHTML = "创建房间成功 rid="+result.rid;
}
else
{
  document.getElementById("txtLog").innerHTML ="创建房间失败,错误码ret="+result.ret;
}
成功的返回值示例:{ ret:0,rid:3445566}
失败的返回值示例:{ ret:984832}

Returns:: 返回创建的房间的rid，是一个Object对象，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。
rid: Number类型创建的房间的id

{Object} enterRoom(rid)

进入一个房间。刚进入时，能听到其他人的语音，但自己暂时不能发言。如果已经在某个房间中，需要调用leaveRoom退出这个房间调用,才能进入另外一个房间。

Parameters:
{Number} rid: 要进入的房间的rid。

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

See:: #leaveRoom

{Object} getOwner()

正在使用临时语音的应用的AppId，可以用来查询临时语音的占用情况。一个YY上同时只能有一个应用在使用临时语音。

使用示例:
var result = yy.tempAudioSession.getOwner();
if (result.ret == 0) {
  document.getElementById("txtLog").innerHTML =(result.ownerAppId==0)?"没有应用在使用": "正在使用临时语音的应用AppId= "+result.ownerAppId;
}
成功的返回值示例:{ ret:0,ownerAppId:100901}
失败的返回值示例:{ ret:984832}

Returns:: 返回占用临时语音的应用的AppId信息，是一个Object对象，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。
ownerAppId: Number类型占用临时语音的应用的AppId。如果值为0表示没有应用在占用。

{Object} getVolume()

获取临时语音房间音量。

使用示例:
var result = yy.tempAudioSession.getVolume();
if (result.ret == 0) {
  document.getElementById("txtLog").innerHTML = "当前房间的音量 volume="+result.volume;
}
else
{
  document.getElementById("txtLog").innerHTML ="无法获取音量,错误码ret="+result.ret;
}
成功的返回值示例:{ ret:0,volume:100}
失败的返回值示例:{ ret:36866}

Returns:: 返回临时语音房间音量，是一个Object对象，具体属性如下。
ret: Number类型返回码 0=成功，非0值失败，具体请参考错误代码。
volume: Number类型返回[0,100]的整数，房间创建后，初始音量是100。

{Object} leaveRoom()

离开房间。如果房间人数为0，服务器过一段时间后会销毁这个房间。

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

{Object} setVolume(vol)

设置临时语音房间音量。

Parameters:
{Number} vol: 0至100的整数，0为静音。房间创建后，初始音量是100。

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

{Object} startSpeak()

开始语音聊天。调用成功后，自己可以在房间中发言。

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

{Object} stopSpeak()

禁止语音聊天。调用成功后，自己不能在房间中发言。

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

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

Classes

Class IYYTempAudioSession