Class Index | File Index

Classes

Class IYYAudio


Extends IYYCommon.
语音控制接口，提供处理YY的音频信息，比如录音的控制等。
Defined in: yyapi.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
IYYAudio()
IYYAudio 构造函数。
Field Summary
Field Attributes Field Name and Description
<static>  
IYYAudio.RECORD_ERR
音频录音出错事件。录音出错的时候会触发。
<static>  
IYYAudio.RECORD_FINISHED
音频录音完成事件。录音完成的时候会触发。
Method Summary
Method Attributes Method Name and Description
 
closeKaraoke()
关闭卡拉ok效果,,即停止伴奏。权限规则和openKaraoke方法相同。
 
disableAudioMixing()
关闭混响效果。
 
enableAudioMixing()
开启混响效果。
 
openKaraoke()
打开卡拉ok效果,即播放伴奏。
权限规则如下：
OW,VP，MA 在当前的频道内，在任何模式下都可以开启和关闭卡拉OK功能。 CA,CA2 在当前频道内拥有管理权限的子频道内可以开启和关闭卡拉OK功能。 VIP，G，R，U必须在自由模式下或者麦序模式下到首位麦序的时候可以开启和关闭卡拉OK功能。 字母代表的意义如下：
游客(U),临时嘉宾(G),嘉宾(VIP),会员(R),二级子频道管理员(CA2),子频道管理员(CA),全频道管理员(MA),频道总管理(VP),频道所有者(OW)
 
resetKaraokePlayerPath(filePathName, mixEnable)
恢复伴奏播放器路径。如果上一次设置的时候保存了原始的播放器路径等信息，可以调用此方法恢复。
 
setKaraokePlayerPath(filePathName)
设置伴奏播放器路径。
 
startRecord(fileName)
开始录音
 
stopRecord()
停止录音
Methods borrowed from class IYYCommon:
addEventListener, removeEventListener
Class Detail
IYYAudio()
IYYAudio 构造函数。
Field Detail
<static> IYYAudio.RECORD_ERR
音频录音出错事件。录音出错的时候会触发。 
侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.errCode: Number类型，整数，录音出错代码。
使用示例：
yy.audio.addEventListener(IYYAudio.RECORD_ERR,onRecordError);

function onRecordError(eventData)
{
   document.getElementById("txtLog").innerHTML=eventData.errCode;
}
<static> IYYAudio.RECORD_FINISHED
音频录音完成事件。录音完成的时候会触发。 
侦听函数格式: function(eventData){    } 
侦听函数参数说明: 
eventData.result: Number类型，表示录音结果的整数。 0=录音正确，非0值表示录音过程中有错误。
eventData.fileName: String类型 录音文件的路径和文件名 。
使用示例：
yy.audio.addEventListener(IYYAudio.RECORD_FINISHED,onRecordFinish);

function onRecordFinish(eventData)
{
   if(eventData.result==0)
   {
      document.getElementById("txtLog").innerHTML="录好的文件在："+eventData.fileName;
   }
}
Method Detail
{Object} closeKaraoke()
关闭卡拉ok效果,,即停止伴奏。权限规则和openKaraoke方法相同。
Returns:
返回调用是否成功,是一个Object对象，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
See:
#openKaraoke
{Object} disableAudioMixing()
关闭混响效果。
Returns:
返回调用是否成功,是一个Object对象，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
{Object} enableAudioMixing()
开启混响效果。
Returns:
返回调用是否成功,是一个Object对象，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
{Object} openKaraoke()
打开卡拉ok效果,即播放伴奏。
权限规则如下：
OW,VP，MA 在当前的频道内，在任何模式下都可以开启和关闭卡拉OK功能。 CA,CA2 在当前频道内拥有管理权限的子频道内可以开启和关闭卡拉OK功能。 VIP，G，R，U必须在自由模式下或者麦序模式下到首位麦序的时候可以开启和关闭卡拉OK功能。 字母代表的意义如下：
游客(U),临时嘉宾(G),嘉宾(VIP),会员(R),二级子频道管理员(CA2),子频道管理员(CA),全频道管理员(MA),频道总管理(VP),频道所有者(OW)
Returns:
返回调用是否成功,是一个Object对象，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
{Object} resetKaraokePlayerPath(filePathName, mixEnable)
恢复伴奏播放器路径。如果上一次设置的时候保存了原始的播放器路径等信息，可以调用此方法恢复。
Parameters:
{String} filePathName
原来的播放器的路径和文件名。
{Boolean} mixEnable
原来是否使用软件卡拉ok混音。
Returns:
返回调用是否成功,是一个Object对象，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
{Object} setKaraokePlayerPath(filePathName)
设置伴奏播放器路径。 
使用示例:
var result=yy.audio.setKaraokePlayerPath("c:\aaa\bb.exe");
if(result.ret==0)
{
    document.getElementById("txtLog").innerHTML="设置完成,原来路径="+result.originPlayerPath+" 原来混音状态="+result.originSoftwareMixEnable;
}
else
{
    document.getElementById("txtLog").innerHTML="设置出错，错误码ret="+result.ret;
}
成功的返回值示例:{ ret:0,originPlayerPath:"C:\\Program Files\\StormII\\Storm.exe",originSoftwareMixEnable:false}
失败的返回值示例:{ ret:984832}
Parameters:
{String} filePathName
指定播放器的路径和文件名。
Returns:
返回操作结果，是Object对象格式，具体属性如下：
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
originPlayerPath: String类型 为原来的播放器路径。
originSoftwareMixEnable: Boolean类型 为原来是否使用软件卡拉ok混音。
{Object} startRecord(fileName)
开始录音 
使用示例：
var result=yy.audio.starRecord();
成功的返回值示例:{ ret:0}
失败的返回值示例:{ ret:984832}
Parameters:
{String} fileName
指定录音文件的文件名，不需要路径。 格式为MP3，会录制到固定的路径中，如果两次录音指定了同一个文件，第二次的会被覆盖。不指定文件名的话系统会使用默认名称。
Returns:
返回调用是否成功，是一个Object对象，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
{Object} stopRecord()
停止录音
Returns:
返回调用是否成功,是一个Object对象，具体属性如下。
ret: Number类型 返回码 0=成功，非0值失败，具体请参考错误代码。
Documentation generated by JsDoc Toolkit 2.4.0