-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathaudiosample.hpp
More file actions
38 lines (36 loc) · 1.09 KB
/
audiosample.hpp
File metadata and controls
38 lines (36 loc) · 1.09 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#pragma once
#include <fea/config.hpp>
#include <memory>
#include <fea/audio/audiobuffer.hpp>
namespace fea
{
class AudioFile;
class FEA_API AudioSample
{
public:
void loadSampleData(const AudioFile& audioFile);
const AudioBuffer& getBuffer() const;
private:
std::unique_ptr<AudioBuffer> mBuffer;
};
/** @addtogroup Audio
*@{
* @class AudioSample
*@}
***
* @class AudioSample
* @brief A sample is a container for audio data.
*
* The data is used by Audio instances. AudioSample instances that are being used must be kept in a valid scope whilst in use.
***
* @fn void AudioSample::loadSampleData(const AudioFile& audioFile)
* @brief Load audio samples from an audio file.
*
* The data will be stored internally and the AudioFile can be discarded afterwards.
* @param audioFile File to load samples from.
***
* @fn const AudioBuffer& AudioSample::getBuffer() const
* @brief Get the internal AudioBuffer.
* @return Audio buffer.
***/
}