audio

播放音乐、音效

Functions
audio.getMusicVolume()
返回音乐的音量值
audio.setMusicVolume(volume)
设置音乐的音量
audio.getSoundsVolume()
返回音效的音量值
audio.setSoundsVolume(volume)
设置音效的音量
audio.preloadMusic(filename)
预载入一个音乐文件
audio.playMusic(filename, isLoop)
播放音乐
audio.stopMusic(isReleaseData)
停止播放音乐
audio.pauseMusic()
暂停音乐的播放
audio.resumeMusic()
恢复暂停的音乐
audio.rewindMusic()
从头开始重新播放当前音乐
audio.willPlayMusic()
检查是否可以开始播放音乐
audio.isMusicPlaying()
检查当前是否正在播放音乐
audio.playSound(filename, isLoop)
播放音效,并返回音效句柄
audio.pauseSound(handle)
暂停指定的音效
audio.pauseAllSounds()
暂停所有音效
audio.resumeSound(handle)
恢复暂停的音效
audio.resumeAllSounds()
恢复所有的音效
audio.stopSound(handle)
停止指定的音效
audio.stopAllSounds()
停止所有音效
audio.preloadSound(filename)
预载入一个音效文件
audio.unloadSound(filename)
从内存卸载一个音效

Functions

audio.getMusicVolume()

audio.getMusicVolume()

返回音乐的音量值

Returns

  • number 返回值在 0.0 到 1.0 之间,0.0 表示完全静音,1.0 表示 100% 音量

audio.setMusicVolume()

audio.setMusicVolume(volume)

设置音乐的音量

Parameters

  • number volume 音量在 0.0 到 1.0 之间, 0.0 表示完全静音,1.0 表示 100% 音量

audio.getSoundsVolume()

audio.getSoundsVolume()

返回音效的音量值

Returns

  • number 返回值在 0.0 到 1.0 之间, 0.0 表示完全静音,1.0 表示 100% 音量

audio.setSoundsVolume()

audio.setSoundsVolume(volume)

设置音效的音量

Parameters

  • number volume 音量在 0.0 到 1.0 之间, 0.0 表示完全静音,1.0 表示 100% 音量

audio.preloadMusic()

audio.preloadMusic(filename)

预载入一个音乐文件

在播放音乐前预先载入,可以在需要播放音乐时无延迟立即播放。 不过限于硬件设备和操作系统的限制,通常只能预载入一个音乐文件。

Parameters

  • string filename 音乐文件名

audio.playMusic()

audio.playMusic(filename, isLoop)

播放音乐

如果音乐文件尚未载入,则会首先载入音乐文件,然后开始播放。

注意:即便音乐音量为 0.0,audio.playMusic() 仍然会进行播放操作。 如果希望停止音乐来降低 CPU 占用,应该使用 audio.stopMusic() 接口完全停止音乐播放。

Parameters

  • string filename 音乐文件名
  • boolean isLoop 是否循环播放,默认为 true

audio.stopMusic()

audio.stopMusic(isReleaseData)

停止播放音乐

Parameters

  • boolean isReleaseData 是否释放音乐数据,默认为 true

audio.pauseMusic()

audio.pauseMusic()

暂停音乐的播放

audio.resumeMusic()

audio.resumeMusic()

恢复暂停的音乐

audio.rewindMusic()

audio.rewindMusic()

从头开始重新播放当前音乐

audio.willPlayMusic()

audio.willPlayMusic()

检查是否可以开始播放音乐

如果可以则返回 true。

如果尚未载入音乐,或者载入的音乐格式不被设备所支持,该方法将返回 false。

Returns

  • boolean

audio.isMusicPlaying()

audio.isMusicPlaying()

检查当前是否正在播放音乐

如果有音乐正在播放则返回 true,否则返回 false

Returns

  • boolean

audio.playSound()

audio.playSound(filename, isLoop)

播放音效,并返回音效句柄

如果音效尚未载入,则会载入后开始播放。

该方法返回的音效句柄用于 audio.stopSound()、audio.pauseSound() 等方法。

Parameters

  • string filename 音效文件名
  • boolean isLoop 是否重复播放,默认为 false

Returns

  • integer 音效句柄

audio.pauseSound()

audio.pauseSound(handle)

暂停指定的音效

Parameters

  • integer 音效句柄

audio.pauseAllSounds()

audio.pauseAllSounds()

暂停所有音效

audio.resumeSound()

audio.resumeSound(handle)

恢复暂停的音效

Parameters

  • integer 音效句柄

audio.resumeAllSounds()

audio.resumeAllSounds()

恢复所有的音效

audio.stopSound()

audio.stopSound(handle)

停止指定的音效

Parameters

  • integer 音效句柄

audio.stopAllSounds()

audio.stopAllSounds()

停止所有音效

audio.preloadSound()

audio.preloadSound(filename)

预载入一个音效文件

可以在进入场景前,载入该场景需要的所有音效。这样就不会因为首次播放某个未载入的音效,而导致游戏暂停执行。

Parameters

  • string 音效文件名

audio.unloadSound()

audio.unloadSound(filename)

从内存卸载一个音效

退出场景时,可以卸载掉只有该场景使用的音效,从而节约内存。

Parameters

  • string 音效文件名
update: 2014-09-19 16:07:27, generated by luadocx 1.3