MOAIUntzSampleBuffer Class Reference

Inherits MOAILuaObject.

List of all members.

Function List
	load
	getInfo
	getData
	setData
	setRawData
	prepareBuffer

---

Function Documentation

getData

Retrieve every sample data in buffer.

---

function getData ( MOAIUntzSampleBuffer self )

Parameters:

self	( MOAIUntzSampleBuffer )

Returns:

data ( table )

getInfo

Returns attributes of sample buffer.

---

function getInfo ( MOAIUntzSampleBuffer self )

Parameters:

self	( MOAIUntzSampleBuffer )

Returns:

bitsPerSample ( number ), channelCount ( number ), frameCount ( number ), sampleRate ( number ), length ( number )

load

Loads a sound from disk.

---

function load ( MOAIUntzSampleBuffer self, string filename )

Parameters:

self	( MOAIUntzSampleBuffer )
filename	( string )

Returns:

nil

prepareBuffer

Allocate internal memory for sample buffer.

---

function prepareBuffer ( MOAIUntzSampleBuffer self, number channelCount, number frameCount, number sampleRate )

Parameters:

self	( MOAIUntzSampleBuffer )
channelCount	( number ) number of channels (mono=1, stereo=2)
frameCount	( number ) number of total frames of sample
sampleRate	( number ) sample rate in Hz (44100 or else)

Returns:

nil

setData

Write sample data into buffer.

---

function setData ( MOAIUntzSampleBuffer self, table data, number index )

Parameters:

self	( MOAIUntzSampleBuffer )
data	( table ) Array of sample data numbers ( -1 ~ 1 as sample level )
index	( number ) Index within sample buffer to start copying from (1 for the first sample)

Returns:

nil

setRawData

Write raw sample data (array of 16bit short value) into buffer.

---

function ( MOAIUntzSampleBuffer self, string raw, number of, number index )

Parameters:

self	( MOAIUntzSampleBuffer )
raw	( string ) binary data that contains array of network byte ordered 16bit short value
of	( number ) bytes to read
index	( number ) of sample buffer start copying from (1 for the first sample)

Returns:

nil