CLAM::SampleMetadata Class Reference

#include <SampleMetadata.hxx>

Inheritance diagram for CLAM::SampleMetadata:

Detailed Description

This class should be used to hold meta information about a sound sample.

This meta information includes both content-based audio descriptors such as the pitch and amplitude of a sample as well as information about the properties of the sound generation process. Finally, this class also holds information about the possible loop points to be used by a sample.

Author:: greg kellum [gkellum@iua.upf.edu] 6/15/2007

Since:: CLAM v1.1.

Definition at line 29 of file SampleMetadata.hxx.


Public Member Functions
	DYNAMIC_TYPE (SampleMetadata, 6)
	DYN_ATTRIBUTE (0, public, CLAM::Filename, Filename)
	DYN_ATTRIBUTE (SAMPLE_METADATA_PITCH_INDEX, public, double, Pitch)
	DYN_ATTRIBUTE (SAMPLE_METADATA_AMPLITUDE_INDEX, public, double, Amplitude)
	DYN_ATTRIBUTE (3, public, int, SortIndex)
	DYN_ATTRIBUTE (4, public, int, StartSteadyState)
	DYN_CONTAINER_ATTRIBUTE (5, public, std::vector< SimpleLoopMetadata >, ListOfLoops, Loop)
void	DefaultInit ()
	The concrete dynamic type constructor calls DefaultInit().
void	ConfigureAfterRestore ()
bool	operator< (const SampleMetadata &argSampleMetadata) const
bool	operator> (const SampleMetadata &argSampleMetadata) const
bool	operator== (const SampleMetadata &argSampleMetadata) const

Member Function Documentation

CLAM::SampleMetadata::DYNAMIC_TYPE	(	SampleMetadata	,
		6
	)

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	0	,
		public	,
		CLAM::Filename	,
		Filename
	)

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	SAMPLE_METADATA_PITCH_INDEX	,
		public	,
		double	,
		Pitch
	)

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	SAMPLE_METADATA_AMPLITUDE_INDEX	,
		public	,
		double	,
		Amplitude
	)

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	3	,
		public	,
		int	,
		SortIndex
	)

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	4	,
		public	,
		int	,
		StartSteadyState
	)

CLAM::SampleMetadata::DYN_CONTAINER_ATTRIBUTE	(	5	,
		public	,
		std::vector< SimpleLoopMetadata >	,
		ListOfLoops	,
		Loop
	)

void CLAM::SampleMetadata::DefaultInit ( void )

The concrete dynamic type constructor calls DefaultInit().

This allows user to initialize his/her object. But we define DefaultInit() here because we don't want to force writting one DefaultInit() function for each concrete dynamic type. If a dynamic type concrete class defines some (not-default) constructors, this should also call the DefaultInit().