sfzero::Sound Class Reference

#include <SFZSound.h>

Inheritance diagram for sfzero::Sound:

Classes
struct	LoadingIdleCallback

Public Types
typedef water::ReferenceCountedObjectPtr< Sound >	Ptr
Public Types inherited from water::SynthesiserSound
typedef ReferenceCountedObjectPtr< SynthesiserSound >	Ptr

Public Member Functions
	Sound (const water::File &file)
virtual	~Sound ()
bool	appliesToNote (int midiNoteNumber) override
bool	appliesToChannel (int midiChannel) override
void	addRegion (Region *region)
Sample *	addSample (water::String path, water::String defaultPath=water::String())
void	addError (const water::String &message)
void	addUnsupportedOpcode (const water::String &opcode)
virtual void	loadRegions ()
virtual void	loadSamples (const LoadingIdleCallback &cb)
Region *	getRegionFor (int note, int velocity, Region::Trigger trigger=Region::attack)
int	getNumRegions ()
Region *	regionAt (int index)
const water::StringArray &	getErrors ()
const water::StringArray &	getWarnings ()
water::String	dump ()
void	dumpToConsole ()
water::Array< Region * > &	getRegions ()
water::File &	getFile ()
Public Member Functions inherited from water::SynthesiserSound
virtual	~SynthesiserSound ()
Public Member Functions inherited from water::ReferenceCountedObject
void	incReferenceCount () noexcept
void	decReferenceCount () noexcept
bool	decReferenceCountWithoutDeleting () noexcept
int	getReferenceCount () const noexcept

Private Attributes
water::File	file_
water::Array< Region * >	regions_
water::HashMap< water::String, Sample * >	samples_
water::StringArray	errors_
water::StringArray	warnings_
water::HashMap< water::String, water::String >	unsupportedOpcodes_

Additional Inherited Members
Protected Member Functions inherited from water::SynthesiserSound
	SynthesiserSound ()
Protected Member Functions inherited from water::ReferenceCountedObject
	ReferenceCountedObject ()
virtual	~ReferenceCountedObject ()
void	resetReferenceCount () noexcept

Member Typedef Documentation

Ptr

typedef water::ReferenceCountedObjectPtr<Sound> sfzero::Sound::Ptr

Constructor & Destructor Documentation

Sound()

sfzero::Sound::Sound ( const water::File & file )

explicit

~Sound()

sfzero::Sound::~Sound ( )

virtual

Member Function Documentation

addError()

void sfzero::Sound::addError

(

const water::String &

message

)

addRegion()

void sfzero::Sound::addRegion

(

Region *

region

)

addSample()

Sample * sfzero::Sound::addSample	(	water::String	path,
		water::String	defaultPath = water::String() )

addUnsupportedOpcode()

void sfzero::Sound::addUnsupportedOpcode

(

const water::String &

opcode

)

appliesToChannel()

bool sfzero::Sound::appliesToChannel ( int midiChannel )

overridevirtual

Returns true if the sound should be triggered by midi events on a given channel.

The Synthesiser will use this information when deciding which sounds to trigger for a given note.

Implements water::SynthesiserSound.

appliesToNote()

bool sfzero::Sound::appliesToNote ( int midiNoteNumber )

overridevirtual

Returns true if this sound should be played when a given midi note is pressed.

The Synthesiser will use this information when deciding which sounds to trigger for a given note.

Implements water::SynthesiserSound.

dump()

water::String sfzero::Sound::dump

(

)

dumpToConsole()

void sfzero::Sound::dumpToConsole

(

)

getErrors()

const water::StringArray & sfzero::Sound::getErrors ( )

inline

getFile()

water::File & sfzero::Sound::getFile ( )

inline

getNumRegions()

int sfzero::Sound::getNumRegions

(

)

getRegionFor()

Region * sfzero::Sound::getRegionFor	(	int	note,
		int	velocity,
		Region::Trigger	trigger = Region::attack )

getRegions()

water::Array< Region * > & sfzero::Sound::getRegions ( )

inline

getWarnings()

const water::StringArray & sfzero::Sound::getWarnings ( )

inline

loadRegions()

void sfzero::Sound::loadRegions ( )

virtual

loadSamples()

void sfzero::Sound::loadSamples ( const LoadingIdleCallback & cb )

virtual

regionAt()

Region * sfzero::Sound::regionAt

(

int

index

)

Member Data Documentation

errors_

water::StringArray sfzero::Sound::errors_

private

file_

water::File sfzero::Sound::file_

private

regions_

water::Array<Region *> sfzero::Sound::regions_

private

samples_

water::HashMap<water::String, Sample *> sfzero::Sound::samples_

private

unsupportedOpcodes_

water::HashMap<water::String, water::String> sfzero::Sound::unsupportedOpcodes_

private

warnings_

water::StringArray sfzero::Sound::warnings_

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/sfzero/sfzero/SFZSound.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/sfzero/sfzero/SFZSound.cpp