MOAIFmodExSound Class Reference

Inherits MOAILuaObject.

List of all members.

Function List
	load
	loadBGM
	loadSFX
	release

---

Function Documentation

load

Loads the specified sound from file, or from a MOAIDataBuffer.

---

function load ( MOAIFmodExSound self, string filename, boolean streaming, boolean async )

Parameters:

self	( MOAIFmodExSound )
filename	( string ) The path to the sound to load from file.
streaming	( boolean ) Whether the sound should be streamed from the data source, rather than preloaded.
async	( boolean ) Whether the sound file should be loaded asynchronously.

Returns:

nil

Note:

---

function load ( MOAIFmodExSound self, MOAIDataBuffer data, boolean streaming )

Parameters:

self	( MOAIFmodExSound )
data	( MOAIDataBuffer ) The MOAIDataBuffer that is storing sound data. You must either provide a string or MOAIDataBuffer, but not both.
streaming	( boolean ) Whether the sound should be streamed from the data source, rather than preloaded.

Returns:

nil

Note:

loadBGM

Loads the specified BGM sound from file, or from a MOAIDataBuffer.

---

function loadBGM ( MOAIFmodExSound self, string filename )

Parameters:

self	( MOAIFmodExSound )
filename	( string ) The path to the sound to load from file.

Returns:

nil

Note:

---

function loadBGM ( MOAIFmodExSound self, MOAIDataBuffer data )

Parameters:

self	( MOAIFmodExSound )
data	( MOAIDataBuffer ) The MOAIDataBuffer that is storing sound data.

Returns:

nil

Note:

loadSFX

Loads the specified SFX sound from file, or from a MOAIDataBuffer.

---

function loadSFX ( MOAIFmodExSound self, string filename )

Parameters:

self	( MOAIFmodExSound )
filename	( string ) The path to the sound to load from file.

Returns:

nil

Note:

---

function loadSFX ( MOAIFmodExSound self, MOAIDataBuffer data )

Parameters:

self	( MOAIFmodExSound )
data	( MOAIDataBuffer ) The MOAIDataBuffer that is storing sound data.

Returns:

nil

Note:

release

Releases the sound data from memory.

---

function release ( MOAIFmodExSound self )

Parameters:

self	( MOAIFmodExSound )

Returns:

nil