MOAIFmodEventInstance Class Reference

Inheritance diagram for MOAIFmodEventInstance:

List of all members.

Function List
	isValid
	stop
	pause
	mute
	getVolume
	setVolume
	getPitch
	setPitch
	getParameter
	setParameter
	keyOff
	unloadOnSilence
	getName
	getNumChannels
	getTime
	getDominantFrequency
	getTempo
	getBeatFraction
	getMeasureFraction

---

Function Documentation

getBeatFraction

Returns the beat fraction of this Event Instance (useful for music)

---

function getBeatFraction ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

beatFraction ( number )

getDominantFrequency

Returns the fundamental frequency of this Event Instance.

---

function getDominantFrequency ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

frequency ( number )

getMeasureFraction

Returns the measure fraction of this Event Instance (useful for music)

---

function getMeasureFraction ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

measureFraction ( number )

getName

Get the name of the Event.

---

function getName ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

name ( string )

getNumChannels

Get the number of Channels in this Event's Channel Group.

---

function getNumChannels ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

channels ( number )

getParameter

Gets the value (a number) of an Event parameter.

---

function getParameter ( MOAIFmodEventInstance self, string parameterName )

Parameters:

self	( MOAIFmodEventInstance )
parameterName	( string ) The name of the Event Parameter

Returns:

paramValue ( number )

getPitch

Gets the pitch of the Event Instance.

---

function getPitch ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

pitch ( number )

getTempo

Returns the tempo of this Event Instance (useful for music)

---

function getTempo ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

tempo ( number )

getTime

Returns time within the Event, or if useSubsoundTime, will return the time within the *the first subsound only*.

---

function getTime ( MOAIFmodEventInstance self [, boolean useSubsoundTime ] )

Parameters:

self	( MOAIFmodEventInstance )
useSubsoundTime	( boolean ) Optional. If true, will return the time within the first subsound only (Default: false)

Returns:

time ( number )

getVolume

Gets the volume of the Event Instance.

---

function getVolume ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

volume ( number )

isValid

Checks to see if the instance is valid (i.e., currently playing)

---

function isValid ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

valid ( boolean )

keyOff

Sets the Event Instance to key off based on the passed in Event Parameter.

---

function keyOff ( MOAIFmodEventInstance self, string parameterName )

Parameters:

self	( MOAIFmodEventInstance )
parameterName	( string ) The name of the Event Parameter

Returns:

nil

mute

Mutes the Event Instance currently playing.

---

function mute ( MOAIFmodEventInstance self [, boolean setting ] )

Parameters:

self	( MOAIFmodEventInstance )
setting	( boolean ) Optional. Whether to mute or unmute. Defaults to true (mute).

Returns:

nil

pause

Pauses the Event Instance currently playing.

---

function pause ( MOAIFmodEventInstance self [, boolean setting ] )

Parameters:

self	( MOAIFmodEventInstance )
setting	( boolean ) Optional. Whether to pause or unpause. Defaults to true (pause).

Returns:

nil

setParameter

Sets the value (a number) of an Event parameter.

---

function setParameter ( MOAIFmodEventInstance self, string parameterName, number paramValue )

Parameters:

self	( MOAIFmodEventInstance )
parameterName	( string ) The name of the Event Parameter
paramValue	( number ) New value of the Event Parameter

Returns:

nil

setPitch

Sets the pitch of the Event Instance.

---

function setPitch ( MOAIFmodEventInstance self, number pitch )

Parameters:

self	( MOAIFmodEventInstance )
pitch	( number ) A pitch level, from 0.0 to 10.0 inclusive. 0.5 = half pitch, 2.0 = double pitch. Default = 1.0

Returns:

nil

setVolume

Sets the volume of the Event Instance.

---

function setVolume ( MOAIFmodEventInstance self, number volume )

Parameters:

self	( MOAIFmodEventInstance )
volume	( number ) Volume is a number between 0 and 1 (where 1 is at full volume).

Returns:

nil

stop

Stops the Event Instance from playing.

---

function stop ( MOAIFmodEventInstance self )

Parameters:

self	( MOAIFmodEventInstance )

Returns:

nil

unloadOnSilence

For streaming sounds -- unloads the Event from memory on silence. (A good guideline to use is: for sounds that don't repeat often)

---

function unloadOnSilence ( MOAIFmodEventInstance self [, boolean setting ] )

Parameters:

self	( MOAIFmodEventInstance )
setting	( boolean ) Optional. Whether to unload on silence or not (Default: true)

Returns:

nil