Arduino STK 4.6.2
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
size_t getSize ()
 Returns a descriptor with additional information.
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_FD * registerFile (const char *fileName, const unsigned char *raw, unsigned int size)
 makes the file available so that the open (by name) operation is working
static void reset ()
 Clears all stored tables.
static void useRAM (bool ram)
 Defines if the audio data is copied from progmem to RAM.

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

Member Function Documentation

◆ getSize()

size_t stk::MemoryFS::getSize ( )

Returns a descriptor with additional information.

Determines the size (in samples)


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