Arduino STK  4.6.2
Public Member Functions | Static Public Member Functions | List of all members
stk::MemoryFS Class Reference

STK in memory File An instance is representing an individual memory array which can be registered with a file name. More...

#include <MemoryFS.h>

Public Member Functions

bool open (const char *fileName, int bytesPerSample=2)
 opens the indicated file
 
VFS_FDgetFD ()
 Returns a descriptor with additional information.
 
size_t getSize ()
 Determines the size (in samples)
 
void close ()
 sets to open flag to false
 
bool isOpen ()
 checks if the file has been opened
 
bool fileRead (StkFrames &buffer, unsigned long startFrame, bool doNormalize)
 Reads the data into the buffer at the indicated start frame.
 

Static Public Member Functions

static VFS_FDregisterFile (const char *fileName, const unsigned char *raw, unsigned int size)
 makes the file available so that the open (by name) operation is working
 

Detailed Description

STK in memory File An instance is representing an individual memory array which can be registered with a file name.

This functionality is used by the MemoryLoop and MemoryWvIn as compatibility layer for the related file based operations. So that we can use the instruments which are based on recorded samples.

Phil Schatzmann


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