跳到主要内容

Audio

描述:

  音频播放管理单例类。

soundSpeed

类型: 成员变量。

描述:

  声音速度。

签名:

soundSpeed: number

globalVolume

类型: 成员变量。

描述:

  全局音量。

签名:

globalVolume: number

listener

类型: 成员变量。

描述:

  3D 声源的聆听者节点。

签名:

listener: Node

play

类型: 函数。

描述:

  播放音效并返回音频句柄。

签名:

play: function(
self: Audio,
filename: string,
loop?: boolean --[[false]]
): integer

参数:

参数名类型描述
filenamestring音效文件的路径(必须为 WAV 文件)。
loopboolean[可选] 是否循环播放音效(默认为 false)。

返回值:

返回类型描述
integer音频句柄,可用于停止音效。

stop

类型: 函数。

描述:

  停止当前正在播放的音效。

签名:

stop: function(self: Audio, handler: integer)

参数:

参数名类型描述
handlerintegerAudio:play() 函数返回的音频句柄。

playStream

类型: 函数。

描述:

  以流媒体方式播放音频文件。

签名:

playStream: function(
self: Audio,
filename: string,
loop?: boolean --[[false]],
crossFadeTime?: number --[[0.0]]
)

参数:

参数名类型描述
filenamestring流媒体音频文件的路径(可以是 OGG、WAV、MP3 或 FLAC格式)。
loopboolean[可选] 是否循环播放流媒体音频(默认为 false)。
crossFadeTimenumber[可选] 在上一个流媒体音频和新的流媒体音频之间交叉淡入淡出的时间(默认为 0.0)。

stopStream

类型: 函数。

描述:

  停止当前正在播放的流媒体音频文件。

签名:

stopStream: function(
self: Audio,
fadeTime?: number --[[0.0]]
)

参数:

参数名类型描述
fadeTimenumber[可选] 淡出流媒体音频的时间(默认为 0.0)。

setPauseAllCurrent

类型: 函数。

描述:

  暂停所有当前正在播放的音频。

签名:

setPauseAllCurrent: function(self: Audio, pause: boolean)

参数:

参数名类型描述
pauseboolean暂停状态。

setListenerAt

类型: 函数。

描述:

  设置聆听者的位置。

签名:

setListenerAt: function(self: Audio, atX: number, atY: number, atZ: number)

参数:

参数名类型描述
atXnumberx 轴位置。
atYnumbery 轴位置。
atZnumberz 轴位置。

setListenerUp

类型: 函数。

描述:

  设置聆听者的上方向。

签名:

setListenerUp: function(self: Audio, upX: number, upY: number, upZ: number)

参数:

参数名类型描述
upXnumberx 轴上方向。
upYnumbery 轴上方向。
upZnumberz 轴上方向。

setListenerVelocity

类型: 函数。

描述:

  设置聆听者的速度。

签名:

setListenerVelocity: function(self: Audio, velocityX: number, velocityY: number, velocityZ: number)

参数:

参数名类型描述
velocityXnumberx 轴速度。
velocityYnumbery 轴速度。
velocityZnumberz 轴速度。