Packageyy
Interfacepublic interface IAudio extends flash.events.IEventDispatcher

语音控制接口,提供处理YY的音频信息,比如录音的控制等。



Public Methods
 MethodDefined By
  
closeKaraoke():Object
关闭卡拉OK效果,停止播放伴奏。权限规则和openKaraoke方法相同。
IAudio
  
关闭混响效果。
IAudio
  
开启混响效果。
IAudio
  
openKaraoke():Object
打开卡拉OK效果,即播放伴奏。 权限规则如下: OW,VP,MA 在当前的频道内,在任何模式下都可以开启和关闭卡拉OK功能。 CA,CA2 在当前频道内拥有管理权限的子频道内可以开启和关闭卡拉OK功能。 VIP,G,R,U必须在自由模式下或者麦序模式下到首位麦序的时候可以开启和关闭卡拉OK功能。 字母代表的意义如下: 游客(U),临时嘉宾(G),嘉宾(VIP),会员(R),二级子频道管理员(CA2),子频道管理员(CA),全频道管理员(MA),频道总管理(VP),频道所有者(OW)
IAudio
  
resetKaraokePlayerPath(filePathName:String, mixEnable:Boolean):Object
恢复伴奏播放器路径。如果上一次设置的时候保存了原始的播放器路径等信息,可以调用此方法恢复。
IAudio
  
setKaraokePlayerPath(filePathName:String):Object
设置伴奏播放器路径。
IAudio
  
startRecord(fileName:String):Object
开始录音
IAudio
  
stopRecord():Object
停止录音
IAudio
Events
 Event Summary Defined By
   音频录音出错事件。录音出错的时候会触发。 事件信息格式说明: eventData.errCode: int类型 录音出错代码。 IAudio
   音频录音完成事件。录音完成的时候会触发。 事件信息格式说明: eventData.result: int类型 录音结果。 0=录音正确,非0值表示录音过程中有错误。 eventData.fileName: String类型 录音文件的路径和文件名 。 IAudio
Method Detail
closeKaraoke()method
public function closeKaraoke():Object

关闭卡拉OK效果,停止播放伴奏。权限规则和openKaraoke方法相同。

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

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

See also

disableAudioMixing()method 
public function disableAudioMixing():Object

关闭混响效果。

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

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

See also

enableAudioMixing()method 
public function enableAudioMixing():Object

开启混响效果。

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

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

See also

openKaraoke()method 
public function openKaraoke():Object

打开卡拉OK效果,即播放伴奏。

权限规则如下:

OW,VP,MA 在当前的频道内,在任何模式下都可以开启和关闭卡拉OK功能。

CA,CA2 在当前频道内拥有管理权限的子频道内可以开启和关闭卡拉OK功能。

VIP,G,R,U必须在自由模式下或者麦序模式下到首位麦序的时候可以开启和关闭卡拉OK功能。

字母代表的意义如下:

游客(U),临时嘉宾(G),嘉宾(VIP),会员(R),二级子频道管理员(CA2),子频道管理员(CA),全频道管理员(MA),频道总管理(VP),频道所有者(OW)

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

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

resetKaraokePlayerPath()method 
public function resetKaraokePlayerPath(filePathName:String, mixEnable:Boolean):Object

恢复伴奏播放器路径。如果上一次设置的时候保存了原始的播放器路径等信息,可以调用此方法恢复。

Parameters

filePathName:String — 原来的播放器的路径和文件名。
 
mixEnable:Boolean — 原来是否使用卡拉ok混音。

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

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

setKaraokePlayerPath()method 
public function setKaraokePlayerPath(filePathName:String):Object

设置伴奏播放器路径。

Parameters

filePathName:String — 指定播放器的路径和文件名。

Returns
Object — 返回操作结果,是Object对象格式,具体属性如下:

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

originPlayerPath: String类型 为原来的播放器路径。

originSoftwareMixEnable: Boolean类型 为原来是否使用软件卡拉ok混音。


Example
         使用示例:
        var result:Object=YY.instance.audio.setKaraokePlayerPath("c:\aaa\bb.exe");
        if(result.ret==0)
        {
            trace("设置完成,原来路径="+result.originPlayerPath+" 原来混音状态="+result.originSoftwareMixEnable);
        }
        else
        {
            trace("设置出错,错误码ret="+result.ret);
        }
        成功的返回值示例:{ ret:0,originPlayerPath:"C:\\Program Files\\StormII\\Storm.exe",originSoftwareMixEnable:false}
        失败的返回值示例:{ ret:984832}
        
startRecord()method 
public function startRecord(fileName:String):Object

开始录音

Parameters

fileName:String — 指定录音文件的文件名,不需要路径,格式为MP3,会录制到固定的路径中,如果两次录音指定了同一个文件,第二次的会被覆盖。不指定文件名的话系统会使用默认名称。

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

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

stopRecord()method 
public function stopRecord():Object

停止录音

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

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

Event Detail
RECORD_ERR Event
Event Object Type: yy.events.AudioEvent
AudioEvent.type property = yy.events.AudioEvent.RECORD_ERR

音频录音出错事件。录音出错的时候会触发。

事件信息格式说明:

eventData.errCode: int类型 录音出错代码。

RECORD_FINISHED Event  
Event Object Type: yy.events.AudioEvent
AudioEvent.type property = yy.events.AudioEvent.RECORD_FINISHED

音频录音完成事件。录音完成的时候会触发。

事件信息格式说明:

eventData.result: int类型 录音结果。 0=录音正确,非0值表示录音过程中有错误。

eventData.fileName: String类型 录音文件的路径和文件名 。