CLAM::SampleMetadata Class Reference

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

#include <SampleMetadata.hxx>

List of all members.

Public Member Functions
	SampleMetadata ()
	SampleMetadata (const SampleMetadata &prototype, const bool shareData=false, const bool deep=true)
	__COMMON_DYNAMIC_TYPE (SampleMetadata, 6)
	__COMMON_DYN_ATTRIBUTE (0, public, CLAM::Filename, Filename) protected
bool	LoadFilename (CLAM::Storage &s)
	__COMMON_DYN_ATTRIBUTE (SAMPLE_METADATA_PITCH_INDEX, public, double, Pitch) protected
bool	LoadPitch (CLAM::Storage &s)
	__COMMON_DYN_ATTRIBUTE (SAMPLE_METADATA_AMPLITUDE_INDEX, public, double, Amplitude) protected
bool	LoadAmplitude (CLAM::Storage &s)
	__COMMON_DYN_ATTRIBUTE (3, public, int, SortIndex) protected
bool	LoadSortIndex (CLAM::Storage &s)
	__COMMON_DYN_ATTRIBUTE (4, public, int, StartSteadyState) protected
bool	LoadStartSteadyState (CLAM::Storage &s)
	__COMMON_DYN_ATTRIBUTE (5, public, std::vector< SimpleLoopMetadata >, ListOfLoops) protected
bool	LoadListOfLoops (CLAM::Storage &s)
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

---

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.

---

Constructor & Destructor Documentation

CLAM::SampleMetadata::SampleMetadata

(

)

[inline]

Definition at line 32 of file SampleMetadata.hxx.

CLAM::SampleMetadata::SampleMetadata	(	const SampleMetadata &	prototype,
		const bool	shareData = false,
		const bool	deep = true
	)			[inline]

Definition at line 32 of file SampleMetadata.hxx.

---

Member Function Documentation

CLAM::SampleMetadata::__COMMON_DYN_ATTRIBUTE	(	5	,
		public	,
		std::vector< SimpleLoopMetadata >	,
		ListOfLoops
	)			[inline]

Definition at line 38 of file SampleMetadata.hxx.

CLAM::SampleMetadata::__COMMON_DYN_ATTRIBUTE	(	4	,
		public	,
		int	,
		StartSteadyState
	)			[inline]

Definition at line 37 of file SampleMetadata.hxx.

CLAM::SampleMetadata::__COMMON_DYN_ATTRIBUTE	(	3	,
		public	,
		int	,
		SortIndex
	)			[inline]

Definition at line 36 of file SampleMetadata.hxx.

CLAM::SampleMetadata::__COMMON_DYN_ATTRIBUTE	(	SAMPLE_METADATA_AMPLITUDE_INDEX	,
		public	,
		double	,
		Amplitude
	)			[inline]

Definition at line 35 of file SampleMetadata.hxx.

CLAM::SampleMetadata::__COMMON_DYN_ATTRIBUTE	(	SAMPLE_METADATA_PITCH_INDEX	,
		public	,
		double	,
		Pitch
	)			[inline]

Definition at line 34 of file SampleMetadata.hxx.

CLAM::SampleMetadata::__COMMON_DYN_ATTRIBUTE	(	0	,
		public	,
		CLAM::Filename	,
		Filename
	)			[inline]

Definition at line 33 of file SampleMetadata.hxx.

CLAM::SampleMetadata::__COMMON_DYNAMIC_TYPE	(	SampleMetadata	,
		6
	)

void CLAM::SampleMetadata::ConfigureAfterRestore

(

)

Definition at line 14 of file SampleMetadata.cxx.

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().

See also:

CopyInit()

Reimplemented from CLAM::DynamicType.

Definition at line 4 of file SampleMetadata.cxx.

References CLAM::DynamicType::UpdateData().

bool CLAM::SampleMetadata::LoadAmplitude

(

CLAM::Storage &

s

)

[inline]

Definition at line 35 of file SampleMetadata.hxx.

bool CLAM::SampleMetadata::LoadFilename

(

CLAM::Storage &

s

)

[inline]

Definition at line 33 of file SampleMetadata.hxx.

bool CLAM::SampleMetadata::LoadListOfLoops

(

CLAM::Storage &

s

)

[inline]

Definition at line 38 of file SampleMetadata.hxx.

bool CLAM::SampleMetadata::LoadPitch

(

CLAM::Storage &

s

)

[inline]

Definition at line 34 of file SampleMetadata.hxx.

bool CLAM::SampleMetadata::LoadSortIndex

(

CLAM::Storage &

s

)

[inline]

Definition at line 36 of file SampleMetadata.hxx.

bool CLAM::SampleMetadata::LoadStartSteadyState

(

CLAM::Storage &

s

)

[inline]

Definition at line 37 of file SampleMetadata.hxx.

bool CLAM::SampleMetadata::operator<

(

const SampleMetadata &

argSampleMetadata

)

const

Definition at line 20 of file SampleMetadata.cxx.

bool CLAM::SampleMetadata::operator==

(

const SampleMetadata &

argSampleMetadata

)

const

Definition at line 59 of file SampleMetadata.cxx.

bool CLAM::SampleMetadata::operator>

(

const SampleMetadata &

argSampleMetadata

)

const

Definition at line 40 of file SampleMetadata.cxx.

---

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

• SampleMetadata.hxx
• SampleMetadata.cxx