MOAIFmodExChannel Class Reference

Inheritance diagram for MOAIFmodExChannel:

List of all members.

Function List
	getVolume
	isPlaying
	moveVolume
	play
	seekVolume
	setPaused
	setVolume
	setLooping
	stop

---

Function Documentation

getVolume

Returns the current volume of the channel.

---

function getVolume ( MOAIFmodExChannel self )

Parameters:

self	( MOAIFmodExChannel )

Returns:

volume ( number )

isPlaying

Returns true if channel is playing.

---

function isPlaying ( MOAIFmodExChannel self )

Parameters:

self	( MOAIFmodExChannel )

Returns:

boolean

moveVolume

Creates a new MOAIAction that will move the volume from it's current value to the value specified.

---

function moveVolume ( MOAIFmodExChannel self, number target, number delay, number mode )

Parameters:

self	( MOAIFmodExChannel )
target	( number ) The target volume.
delay	( number ) The delay until the action starts.
mode	( number ) The interpolation mode for the action.

Returns:

action ( MOAIAction )

play

Plays the specified sound, looping it if desired.

---

function play ( MOAIFmodExChannel self, MOAIFmodExSound sound, number loopCount )

Parameters:

self	( MOAIFmodExChannel )
sound	( MOAIFmodExSound ) The sound to play.
loopCount	( number ) Number of loops.

Returns:

nil

seekVolume

Creates a new MOAIAction that will move the volume from it's current value to the value specified.

---

function seekVolume ( MOAIFmodExChannel self, number target, number delay, number mode )

Parameters:

self	( MOAIFmodExChannel )
target	( number ) The target volume.
delay	( number ) The delay until the action starts.
mode	( number ) The interpolation mode for the action.

Returns:

action ( MOAIAction )

setLooping

Immediately sets looping for this channel.

---

function setLooping ( MOAIFmodExChannel self, boolean looping )

Parameters:

self	( MOAIFmodExChannel )
looping	( boolean ) True if channel should loop.

Returns:

nil

setPaused

Sets whether this channel is paused and hence does not play any sounds.

---

function setPaused ( MOAIFmodExChannel self, boolean paused )

Parameters:

self	( MOAIFmodExChannel )
paused	( boolean ) Whether this channel is paused.

Returns:

nil

setVolume

Immediately sets the volume of this channel.

---

function setVolume ( MOAIFmodExChannel self, number volume )

Parameters:

self	( MOAIFmodExChannel )
volume	( number ) The volume of this channel.

Returns:

nil

stop

Stops playing the sound on this channel.

---

function stop ( MOAIFmodExChannel self )

Parameters:

self	( MOAIFmodExChannel )

Returns:

nil