FBSound API

Install FBSound.

Explanation about the type of parameters in this document.

Function Summary: init/start/stop/exit FBSound.

fbs_Init([nRate],[nChannels],[nBuffers],[nFrames],[nPluginIndex],[nDeviceIndex]) as boolean      Setup any available playback devices. (internal: fbs_Start() will be called too)

fbs_Start() as boolean      (optional) Start the sound threads.

fbs_Stop() as boolean      (optional) Stop all running threads.

fbs_Exit() as boolean      (optional) Remove fbsound (internal: fbs_Stop() will be called if any threads are running)

Function Summary: get/set plugin values.

fbs_Set_PlugPath(sPath) as boolean      (optional) Set the folder where fbs_Init() should load dynamic plugins from (default = exepath).

fbs_Get_PlugPath() as string      Get the folder where fbs_Init() load dynamic plugins from.

fbs_Get_PlugOuts() as integer      Get the number of available playback plugins.

fbs_Get_PlugName() as string      Get the name of the current pluin.

fbs_Get_PlugDevice() as string      Get the name of the current playback device.

fbs_Get_PlugError() as string      Get the error description if fbs_Init() returns False.

fbs_Get_PlugRate() as integer      Get the current playback rate in Hz.

fbs_Get_PlugBits() as integer      Get the number of bits per sample. (16 bit)

fbs_Get_PlugChannels() as integer      Get the current number of playback channels (1 = mono, 2 = stereo).

fbs_Get_PlugBuffers() as integer      Get the current number of playback buffers. (3 = default).

fbs_Get_PlugFrames() as integer      Get the current number of frames per buffer. (2048 = default).

fbs_Get_PlugChannels() as integer      Get the current buffersize in bytes. (default: 2048 * 16bits * 2Channels) \ 8bits = 8192 bytes)

fbs_Get_PlugFramesize() as integer      Get the current framesize in bytes. (default: (16bits * 2Channels) \ 8bits = 4 bytes)

fbs_Get_PlugRunning() as boolean      Get the current state of the playback device True/False. See: fbs_Start() / fbs_Stop() (default: True after calling fbs_Init())

Function Summary: get/set properties of FBSound.

fbs_Get_PlayingSounds() as integer      Get the number of current playing sounds. See: fbs_Play_Wave() / fbs_Play_Sound().

fbs_Get_PlayingStreams() as integer      Get the number of current playing Streams. See: fbs_Play_MP3Stream().

fbs_Get_PlayedBytes() as integer      Get the number of played bytes since fbs_Init() was called.

fbs_Get_PlayedSamples() as integer      Get the number of played samples since fbs_Init() was called.

fbs_Get_PlayTime() as double      Get the high resolution play time in seconds since fbs_Init() was called.

fbs_Get_MasterVolume(@fVolume) as boolean      Get the current main volume (default = 1.0) after fbs_Init() was called.

fbs_Set_MasterVolume(fVolume) as boolean      Set the main volume.

fbs_Get_MaxChannels(@nChannels) as boolean      Get the current number of playable sounds/channels in parallel. (default = 128).

fbs_Set_MaxChannels(nChannels) as boolean      Set the number of playable sounds in parallel. (max = 512)

fbs_Set_MasterFilter(nFilterIndex, fHZ, fDB,[fOctave],[bEnabled]) as boolean      Set parameters of 10 posible master band EQ's. (nFilterIndex 0..9)

fbs_Enable_MasterFilter(nFilterIndex) as boolean      Enable one of 10 posible master band EQ's. (nFilterIndex 0..9)

fbs_Disable_MasterFilter(nFilter) as boolean      Disable one of 10 posible master band EQ's. (nFilterIndex 0..9)

fbs_Volume_2_dB(fVolume) as single      Tanslate volume in dB.

fbs_dB_2_Volume(fdB) as single      Tanslate dB in volume.

Function Summary: load/create/remove wave objects in memory.

fbs_Load_WAVFile(strFilename, @hWave) as boolean      Load none compressed *.wav file in memory (must be in 8 or 16bit mono or stereo).

fbs_Load_MP3File(strFilename, @hWave [,sTmpFile as string]) as boolean      Load any *.mp3 *.mp2 *.mp file in memory

fbs_Load_OGGFile(strFilename, @hWave [,sTmpFile as string]) as boolean      Load any *.ogg file in memory

fbs_Load_MODFile(strFilename, @hWave [,sTmpFile as string]) as boolean      Load any *.mod *.xm *.ts *.s3m file in memory

fbs_Create_Wave(nSamples,@hWave, @pSamples) as boolean      Create a new wave with nSamples samples in memory.

fbs_Create_Sound(hWave, @hSound) as boolean      Create a playable sound hSound from the loaded wave hWave.

fbs_Destroy_Sound(@hSound) as boolean      Remove hSound object from memory.

fbs_Destroy_Wave(@hWave) as boolean      Remove hWave object from memory.

Function Summary: create/remove a stream object.

fbs_Create_MP3Stream(sFilename) as boolean      Prepare a Stream for real-time decoding.

fbs_End_MP3Stream() as boolean      Stop and remove an MP3Stream and its real-time decoder

Function Summary: play waves/sounds/streams.

fbs_Play_Wave(hWave,[nLoops=1],[fSpeed=1.0], [fVolume=1.0], [fPan=0.0], [@hSound]) as boolean      Play a loaded hWave object and create an optional hSound object from it.

fbs_Play_Sound(hSound, [nLoops=1]) as boolean      Play a created hSound object.

fbs_Play_MP3Stream() as boolean      Play a prepared stream object.

Function Summary: get properties of an wave object.

fbs_Get_WavePointers(hWave, [@pStart],[@pEnd], @nChannels]) as boolean      Get current pointers, channels, and samples from playing sound.

fbs_Get_WaveLength(hWave,@ms) as boolean      Get length of sound in milli seconds ms/1000 = seconds.

Function Summary: get/set properties of an sound object.

fbs_Get_SoundLoops(hSound, @nLoops) as boolean      Get the current number of sound loops.

fbs_Set_SoundLoops(hSound, nLoops) as boolean      Set the new number of sound loops.

fbs_Get_SoundSpeed(hSound, @fSpeed) as boolean      Get the passed sound's playback speed.

fbs_Set_SoundSpeed(hSound, fSpeed) as boolean      Set the passed sound's playback speed.

fbs_Get_SoundVolume(hSound ,@fVolume) as boolean      Get the passed sound's volume.

fbs_Set_SoundVolume(hSound,fVolume) as boolean      Set the passed sound's volume.

fbs_Get_SoundPan(hSound, @fPan) as boolean      Get the passed sound's panning position.

fbs_Set_SoundPan(hSound, fPan) as boolean      Set the passed sound's panning position.

fbs_Get_SoundMuted(hSound, @bMuted) as boolean      Get the passed sound's muted state.

fbs_Set_SoundMuted(hSound, bMuted) as boolean      Set the passed sound's muted state.

fbs_Get_SoundPaused(hSound, @bPaused) as boolean      Get the passed sound's pause state.

fbs_Set_SoundPaused(hSound, bPaused) as boolean      Set the passed sound's pause state.

fbs_Get_SoundPointers(hSound, [@pStart], [@pPlay], [@pEnd]) as boolean      Get pointers from sound object.

fbs_Set_SoundPointers(hSound, [lpStart], [pPlay] ,[pEnd]) as boolean      Set pointers from sound object.

fbs_Get_SoundPosition(hSound, @fPosition) as boolean      Get current playback position (0.0-1.0) from sound object.

Function Summary: get/set properties of a stream.

fbs_Get_StreamVolume(@fVolume) as boolean      Get the passed stream's volume.

fbs_Set_StreamVolume(fVolume) as boolean      Set the passed stream's volume.

fbs_Get_StreamPan(@fPan) as boolean      Get the passed stream's panning position.

fbs_Set_StreamPan(fPan) as boolean      Set the passed stream's panning position.

fbs_Get_StreamBuffer(@pBuffer, @nChannels, @nSamples) as boolean      Get the current stream's sample buffer.

Function Summary: set/enable/disable user defined buffer callbacks.

fbs_Set_MasterCallback(@Callback as BUFFERCALLBACK) as boolean      Set a buffer callback sub for the master channel. (samples are processed after the mixer pipeline)

fbs_Enable_MasterCallback() as boolean      Enable the master buffer callback.

fbs_Disable_MasterCallback() as boolean      Disable the master buffer callback.

fbs_Set_SoundCallback(hSound, @Callback as BUFFERCALLBACK) as boolean      Set a buffer callback sub for any sound. (samples are processed before the mixer pipeline)

fbs_Enable_SoundCallback(hSound) as boolean      Enable sound buffer callback.

fbs_Disable_SoundCallback(hSound) as boolean      Disable sound buffer callback.

fbs_Set_StreamCallback(@Callback as BUFFERCALLBACK) as boolean      Set a buffer callback sub for a stream. (samples are processed before the mixer pipeline)

fbs_Enable_StreamCallback() as boolean      Enable stream buffer callback.

fbs_Disable_StreamCallback() as boolean      Disable stream buffer callback.

Function Summary: set/enable/disable user defined load callback.

fbs_Set_LoadCallback(@Callback as LOADCALLBACK) as boolean      Set a load callback sub for file loading.

fbs_Enable_LoadCallback() as boolean      Enable the load callback.

fbs_Disable_LoadCallback() as boolean      Disable the load callback.

The FBSound API in more details:

fbs_Init([nRate],[nChannesl],[nBuffers],[nFrames],[nPluinIndex],[nDevceIndex]) as boolean

There is normally no need to use these functions manually.
fbs_Start() will be called internally from fbs_Init(). If any FreeBASIC program ends, fbs_Stop() and fbs_Exit() will be called internally too.

There is one reason to use these functions manually:
If you want to change the FBSound setup via fbs_Init() first call fbs_Stop() then fbs_Exit(). all playing waves/sounds/streams are stopped and removed from memory. Now use fbs_Init() with any new setup and reload/create waves/sounds/streams. (The old will be invalid)

fbs_Set_PlugPath(sNewPath)