SynthLab SDK
Public Member Functions | List of all members
SynthLab::IPCMSampleDatabase Class Referenceabstract
SynthInterfaces

Interface for PCM sample databases. More...

#include <synthbase.h>

Inheritance diagram for SynthLab::IPCMSampleDatabase:
SynthLab::PCMSampleDatabase

Public Member Functions

virtual IPCMSampleSource * getSampleSource (const char *uniqueSampleSetName)=0
 get a PCM sample source based on its unique name string More...
 
virtual bool addSampleSource (const char *uniqueSampleSetName, IPCMSampleSource *sampleSource)=0
 adds a PCM sample to the database More...
 
virtual bool removeSampleSource (const char *uniqueSampleSetName)=0
 remove a PCM sample set from the database More...
 
virtual bool clearSampleSources ()=0
 clear all the sample sources More...
 

Detailed Description

Interface for PCM sample databases.

  • A PCM sample database stores a set of PCM sample sources and allows the calling object access to these sources; for example a PCM oscillator would request a PCM sample source pointer for the "303Snare" PCM sample set
  • The database interface functions allow:
  1. get a PCM sample source interface pointer
  2. add/remove PCM sample sources to/from the database
  3. clear all the table sources (for destruction time)
Author
Will Pirkle http://www.willpirkle.com
Remarks
This object is included and described in further detail in Designing Software Synthesizer Plugins in C++ 2nd Ed. by Will Pirkle
Version
Revision : 1.0
Date
Date : 2021 / 04 / 26

Member Function Documentation

◆ addSampleSource()

virtual bool SynthLab::IPCMSampleDatabase::addSampleSource ( const char *  uniqueSampleSetName,
IPCMSampleSource *  sampleSource 
)
pure virtual

adds a PCM sample to the database

Parameters
uniqueSampleSetNamethe name of the PCM sample set
sampleSourcethe IPCMSampleSource interface pointer to the object
Returns
true if sucessful, false otherwise

Implemented in SynthLab::PCMSampleDatabase.

◆ clearSampleSources()

virtual bool SynthLab::IPCMSampleDatabase::clearSampleSources ( )
pure virtual

clear all the sample sources

Returns
true if sucessful, false otherwise

Implemented in SynthLab::PCMSampleDatabase.

◆ getSampleSource()

virtual IPCMSampleSource* SynthLab::IPCMSampleDatabase::getSampleSource ( const char *  uniqueSampleSetName)
pure virtual

get a PCM sample source based on its unique name string

Parameters
uniqueSampleSetNamethe name of the PCM samples (usually the name of a folder that contains the samples as WAV files)
Returns
an IPCMSampleSource pointer to the source

Implemented in SynthLab::PCMSampleDatabase.

◆ removeSampleSource()

virtual bool SynthLab::IPCMSampleDatabase::removeSampleSource ( const char *  uniqueSampleSetName)
pure virtual

remove a PCM sample set from the database

Parameters
uniqueSampleSetNamethe name of the sample set
Returns
true if sucessful, false otherwise

Implemented in SynthLab::PCMSampleDatabase.

The documentation for this class was generated from the following file: