mirror of https://github.com/axmolengine/axmol.git
199 lines
7.7 KiB
Lua
199 lines
7.7 KiB
Lua
|
|
--------------------------------
|
|
-- @module AudioEngine
|
|
-- @parent_module ccexp
|
|
|
|
--------------------------------
|
|
--
|
|
-- @function [parent=#AudioEngine] lazyInit
|
|
-- @param self
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Sets the current playback position of an audio instance.<br>
|
|
-- param audioID An audioID returned by the play2d function.<br>
|
|
-- return
|
|
-- @function [parent=#AudioEngine] setCurrentTime
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @param #float time
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Gets the volume value of an audio instance.<br>
|
|
-- param audioID An audioID returned by the play2d function.<br>
|
|
-- return Volume value (range from 0.0 to 1.0).
|
|
-- @function [parent=#AudioEngine] getVolume
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Uncache the audio data from internal buffer.<br>
|
|
-- AudioEngine cache audio data on ios,mac, and win32 platform.<br>
|
|
-- warning This can lead to stop related audio first.<br>
|
|
-- param filePath Audio file path.
|
|
-- @function [parent=#AudioEngine] uncache
|
|
-- @param self
|
|
-- @param #string filePath
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Resume all suspended audio instances.
|
|
-- @function [parent=#AudioEngine] resumeAll
|
|
-- @param self
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Stop all audio instances.
|
|
-- @function [parent=#AudioEngine] stopAll
|
|
-- @param self
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Pause an audio instance.<br>
|
|
-- param audioID An audioID returned by the play2d function.
|
|
-- @function [parent=#AudioEngine] pause
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Release objects relating to AudioEngine.<br>
|
|
-- warning It must be called before the application exit.
|
|
-- @function [parent=#AudioEngine] end
|
|
-- @param self
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Gets the maximum number of simultaneous audio instance of AudioEngine.
|
|
-- @function [parent=#AudioEngine] getMaxAudioInstance
|
|
-- @param self
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Gets the current playback position of an audio instance.<br>
|
|
-- param audioID An audioID returned by the play2d function.<br>
|
|
-- return The current playback position of an audio instance.
|
|
-- @function [parent=#AudioEngine] getCurrentTime
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Sets the maximum number of simultaneous audio instance for AudioEngine.<br>
|
|
-- param maxInstances The maximum number of simultaneous audio instance.
|
|
-- @function [parent=#AudioEngine] setMaxAudioInstance
|
|
-- @param self
|
|
-- @param #int maxInstances
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Checks whether an audio instance is loop.<br>
|
|
-- param audioID An audioID returned by the play2d function.<br>
|
|
-- return Whether or not an audio instance is loop.
|
|
-- @function [parent=#AudioEngine] isLoop
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @return bool#bool ret (return value: bool)
|
|
|
|
--------------------------------
|
|
-- Pause all playing audio instances.
|
|
-- @function [parent=#AudioEngine] pauseAll
|
|
-- @param self
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Uncache all audio data from internal buffer.<br>
|
|
-- warning All audio will be stopped first.
|
|
-- @function [parent=#AudioEngine] uncacheAll
|
|
-- @param self
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Sets volume for an audio instance.<br>
|
|
-- param audioID An audioID returned by the play2d function.<br>
|
|
-- param volume Volume value (range from 0.0 to 1.0).
|
|
-- @function [parent=#AudioEngine] setVolume
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @param #float volume
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Play 2d sound.<br>
|
|
-- param filePath The path of an audio file.<br>
|
|
-- param loop Whether audio instance loop or not.<br>
|
|
-- param volume Volume value (range from 0.0 to 1.0).<br>
|
|
-- param profile A profile for audio instance. When profile is not specified, default profile will be used.<br>
|
|
-- return An audio ID. It allows you to dynamically change the behavior of an audio instance on the fly.<br>
|
|
-- see `AudioProfile`
|
|
-- @function [parent=#AudioEngine] play2d
|
|
-- @param self
|
|
-- @param #string filePath
|
|
-- @param #bool loop
|
|
-- @param #float volume
|
|
-- @param #cc.experimental::AudioProfile profile
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Returns the state of an audio instance.<br>
|
|
-- param audioID An audioID returned by the play2d function.<br>
|
|
-- return The status of an audio instance.
|
|
-- @function [parent=#AudioEngine] getState
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @return int#int ret (return value: int)
|
|
|
|
--------------------------------
|
|
-- Resume an audio instance.<br>
|
|
-- param audioID An audioID returned by the play2d function.
|
|
-- @function [parent=#AudioEngine] resume
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Stop an audio instance.<br>
|
|
-- param audioID An audioID returned by the play2d function.
|
|
-- @function [parent=#AudioEngine] stop
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Gets the duration of an audio instance.<br>
|
|
-- param audioID An audioID returned by the play2d function.<br>
|
|
-- return The duration of an audio instance.
|
|
-- @function [parent=#AudioEngine] getDuration
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @return float#float ret (return value: float)
|
|
|
|
--------------------------------
|
|
-- Sets whether an audio instance loop or not.<br>
|
|
-- param audioID An audioID returned by the play2d function.<br>
|
|
-- param loop Whether audio instance loop or not.
|
|
-- @function [parent=#AudioEngine] setLoop
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @param #bool loop
|
|
-- @return experimental::AudioEngine#experimental::AudioEngine self (return value: cc.experimental::AudioEngine)
|
|
|
|
--------------------------------
|
|
-- Gets the default profile of audio instances.<br>
|
|
-- return The default profile of audio instances.
|
|
-- @function [parent=#AudioEngine] getDefaultProfile
|
|
-- @param self
|
|
-- @return experimental::AudioProfile#experimental::AudioProfile ret (return value: cc.experimental::AudioProfile)
|
|
|
|
--------------------------------
|
|
-- @overload self, string
|
|
-- @overload self, int
|
|
-- @function [parent=#AudioEngine] getProfile
|
|
-- @param self
|
|
-- @param #int audioID
|
|
-- @return experimental::AudioProfile#experimental::AudioProfile ret (return value: cc.experimental::AudioProfile)
|
|
|
|
return nil
|