Moai SDK  2.0
MOAIUntzSampleBuffer Class Reference

Inherits MOAILuaObject.

Function List

getData
 
getInfo
 
load
 
prepareBuffer
 
setData
 
setRawData
 

Function Documentation

getData

Retrieve every sample data in buffer.


function getData ( MOAIUntzSampleBuffer self )

Parameters
MOAIUntzSampleBufferself
Returns
table data
getInfo

Returns attributes of sample buffer.


function getInfo ( MOAIUntzSampleBuffer self )

Parameters
MOAIUntzSampleBufferself
Returns
number bps, number channels, number frames, number sampleRate, number length
load

Loads a sound from disk.


function load ( MOAIUntzSampleBuffer self, string filename )

Parameters
MOAIUntzSampleBufferself
stringfilename
Returns
nil
prepareBuffer

Allocate internal memory for sample buffer.


function prepareBuffer ( MOAIUntzSampleBuffer self, number channels, number frames, number sampleRate )

Parameters
MOAIUntzSampleBufferself
numberchannels number of channels (mono=1, stereo=2)
numberframes number of total frames of sample
numbersampleRate sample rate in Hz (44100 or else)
Returns
nil
setData

Write sample data into buffer.


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

Parameters
MOAIUntzSampleBufferself
tabledata array of sample data number ( -1 ~ 1 as sample level )
numberstartIndex index of 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 setRawData ( MOAIUntzSampleBuffer self, string raw, number of, number index )

Parameters
MOAIUntzSampleBufferself
stringraw binary data that contains array of network byte ordered 16bit short value
numberof bytes to read
numberindex of sample buffer start copying from (1 for the first sample)
Returns
nil