class_samplelibrary

SampleLibrary

Inherits: Resource\n\n

Brief Description

Library that contains a collection of Samples.

Member Functions

• void ** add_sample ** ( String name, Sample sample )
• Sample ** get_sample ** ( String name ) const
• bool ** has_sample ** ( String name ) const
• void ** remove_sample ** ( String name )
• void ** sample_set_volume_db ** ( String name, real db )
• real ** sample_get_volume_db ** ( String name ) const
• void ** sample_set_pitch_scale ** ( String name, real pitch )
• real ** sample_get_pitch_scale ** ( String name ) const

Description

Library that contains a collection of Samples, each identified by an text id. This is used as a data containeer for the majority of the SamplePlayer classes and derivatives.

Member Function Description

add_sample

• void ** add_sample ** ( String name, Sample sample ) \ Add a sample to the library, with a given text id;

get_sample

• Sample ** get_sample ** ( String name ) const \ Return a sample from the library, from a given text-id. Return null if the sample is not found.

has_sample

• bool ** has_sample ** ( String name ) const \ Return true if the sample text id exists in the library.

remove_sample

• void ** remove_sample ** ( String name ) \ Remove a sample given a specific text id.