CLAM::LoopingSDIFFileReader Class Reference
#include <LoopingSDIFFileReader.hxx>
Detailed Description
This class extends the length of an SDIFFile indefinitely by looping between its frames.It supports looping between multiple loop points with crossfading.
- Since:
- CLAM v1.1
Definition at line 23 of file LoopingSDIFFileReader.hxx.
Public Member Functions | |
| LoopingSDIFFileReader (const SDIFInConfig &argSDIFInConfig) | |
| You MUST give the instance the filename of the SDIF file to read. | |
| ~LoopingSDIFFileReader () | |
| bool | Configure (const SDIFInConfig &c) |
| You MUST to give the instance the filename of the SDIF file to read. | |
| virtual Frame * | ReadFrame () |
| This method returns the next frame from the internal buffer. | |
| bool | isLooping () |
| This returns true if and only if this class has been given some loop points. | |
| void | AddLoop (SimpleLoopMetadata &aSimpleLoop) |
| Adds a single loop point for a sample. | |
| void | SetListOfLoops (std::vector< SimpleLoopMetadata > &theLoopList) |
| Adds a list of loop points for a sample. | |
| void | ClearLoops () |
| Clears all of the loop points previously set. | |
| std::vector< SimpleLoopMetadata > & | GetListOfLoops () |
| Returns all of the loop points previously set. | |
| void | Reset () |
| Resets the SDIFFileReader to read the very first frame from the file again thereby restarting the attack stage of the sample. | |
Constructor & Destructor Documentation
| CLAM::LoopingSDIFFileReader::LoopingSDIFFileReader | ( | const SDIFInConfig & | argSDIFInConfig | ) |
You MUST give the instance the filename of the SDIF file to read.
in the SDIFInConfig object.
Definition at line 9 of file LoopingSDIFFileReader.cxx.
References Configure(), and CLAM::DynamicType::UpdateData().
| CLAM::LoopingSDIFFileReader::~LoopingSDIFFileReader | ( | ) |
Definition at line 24 of file LoopingSDIFFileReader.cxx.
Member Function Documentation
| bool CLAM::LoopingSDIFFileReader::Configure | ( | const SDIFInConfig & | c | ) |
You MUST to give the instance the filename of the SDIF file to read.
in the SDIFInConfig object. You can further specify which kinds of objects to read from the SDIFFile. See the doc for SDIFInConfig.
Reimplemented from CLAM::BufferedSDIFFileReader.
Definition at line 29 of file LoopingSDIFFileReader.cxx.
References NULL.
Referenced by LoopingSDIFFileReader().
| Frame * CLAM::LoopingSDIFFileReader::ReadFrame | ( | ) | [virtual] |
This method returns the next frame from the internal buffer.
Reimplemented from CLAM::BufferedSDIFFileReader.
Definition at line 71 of file LoopingSDIFFileReader.cxx.
References CLAM::DataUtil::CopyFrameMembers(), CLAM::BufferedSDIFFileReader::GetFrame(), CLAM::BufferedSDIFFileReader::GetFrameBufferPosition(), CLAM::BufferedSDIFFileReader::ReadFrame(), and CLAM::BufferedSDIFFileReader::SetFrameBufferPosition().
| bool CLAM::LoopingSDIFFileReader::isLooping | ( | ) |
This returns true if and only if this class has been given some loop points.
Definition at line 37 of file LoopingSDIFFileReader.cxx.
| void CLAM::LoopingSDIFFileReader::AddLoop | ( | SimpleLoopMetadata & | aSimpleLoop | ) |
| void CLAM::LoopingSDIFFileReader::SetListOfLoops | ( | std::vector< SimpleLoopMetadata > & | theLoopList | ) |
Adds a list of loop points for a sample.
(Note the data structure is actually a vector rather than a list.
Definition at line 57 of file LoopingSDIFFileReader.cxx.
| void CLAM::LoopingSDIFFileReader::ClearLoops | ( | ) |
Clears all of the loop points previously set.
Definition at line 47 of file LoopingSDIFFileReader.cxx.
| std::vector< SimpleLoopMetadata > & CLAM::LoopingSDIFFileReader::GetListOfLoops | ( | ) |
Returns all of the loop points previously set.
Definition at line 52 of file LoopingSDIFFileReader.cxx.
| void CLAM::LoopingSDIFFileReader::Reset | ( | ) |
Resets the SDIFFileReader to read the very first frame from the file again thereby restarting the attack stage of the sample.
Definition at line 263 of file LoopingSDIFFileReader.cxx.
References CLAM::BufferedSDIFFileReader::SetFrameBufferPosition().
The documentation for this class was generated from the following files:
