BRL.AudioSample: Types Functions Source  


The BlitzMax audiosample module contains commands to create and load audio samples for use with the BlitzMax BRL.Audio module.

Types

TAudioSampleAudio sample type
TAudioSampleLoaderAudio sample loader type

Functions

CreateAudioSampleCreate an audio sample
CreateStaticAudioSampleCreate an audio sample with existing data
LoadAudioSampleLoad an audio sample

Function reference

Function CreateAudioSample:TAudioSample( length,hertz,format )
ReturnsAn audio sample object
DescriptionCreate an audio sample
Information length is the number of samples to allocate for the sample. hertz is the frequency in samples per second (hz) the audio sample will be played. format should be one of:

FormatDescription

&SF_MONO8Mono unsigned 8 bit

&SF_MONO16LEMono signed 16 bit little endian

&SF_MONO16BEMono signed 16 bit big endian

&SF_STEREO8Stereo unsigned 8 bit

&SF_STEREO16LEStereo signed 16 bit little endian

&SF_STEREO16BEStereo signed 16 bit big endian

Example
' createaudiosample.bmx

Local sample:TAudioSample=CreateAudioSample( 32,11025,SF_MONO8 )

For Local k=0 Until 32
        sample.samples[k]=Sin(k*360/32)*127.5+127.5
Next

Local sound:TSound=LoadSound( sample,True )

PlaySound(sound)

Input

Function CreateStaticAudioSample:TAudioSample( samples:Byte Ptr,length,hertz,format )
ReturnsAn audio sample object that references an existing block of memory
DescriptionCreate an audio sample with existing data
Information The memory referenced by a static audio sample is not released when the audio sample is deleted.

See CreateAudioSample for possile format values.

Function LoadAudioSample:TAudioSample( url:Object )
ReturnsAn audio sample object
DescriptionLoad an audio sample