Marsyas  0.5.0-beta1
Public Types | Static Public Member Functions | Static Public Attributes
Stk Class Reference

#include <Stk.h>

Public Types

typedef unsigned long STK_FORMAT

Static Public Member Functions

static std::string rawwavePath (void)
 Static method which returns the current rawwave path.
static MY_FLOAT sampleRate (void)
 Static method which returns the current STK sample rate.
static void setRawwavePath (std::string newPath)
 Static method which sets the STK rawwave path.
static void setSampleRate (MY_FLOAT newRate)
 Static method which sets the STK sample rate.
static void sleep (unsigned long milliseconds)
 Static cross-platform method to sleep for a number of milliseconds.
static void swap16 (unsigned char *ptr)
 Static method which byte-swaps a 16-bit data type.
static void swap32 (unsigned char *ptr)
 Static method which byte-swaps a 32-bit data type.
static void swap64 (unsigned char *ptr)
 Static method which byte-swaps a 64-bit data type.

Static Public Attributes

static const STK_FORMAT MY_FLOAT32 = 16
static const STK_FORMAT MY_FLOAT64 = 32
static const STK_FORMAT STK_SINT16 = 2
static const STK_FORMAT STK_SINT32 = 8
static const STK_FORMAT STK_SINT8 = 1

Detailed Description

Definition at line 84 of file Stk.h.


Member Typedef Documentation

typedef unsigned long STK_FORMAT

Definition at line 88 of file Stk.h.


Member Function Documentation

std::string rawwavePath ( void  ) [static]

Static method which returns the current rawwave path.

Definition at line 53 of file Stk.cpp.

MY_FLOAT sampleRate ( void  ) [static]

Static method which returns the current STK sample rate.

Definition at line 42 of file Stk.cpp.

void setRawwavePath ( std::string  newPath) [static]

Static method which sets the STK rawwave path.

Definition at line 58 of file Stk.cpp.

void setSampleRate ( MY_FLOAT  newRate) [static]

Static method which sets the STK sample rate.

The sample rate set using this method is queried by all STK classes which depend on its value. It is initialized to the default SRATE set in Stk.h. Many STK classes use the sample rate during instantiation. Therefore, if you wish to use a rate which is different from the default rate, it is imperative that it be set BEFORE STK objects are instantiated.

Definition at line 47 of file Stk.cpp.

void sleep ( unsigned long  milliseconds) [static]

Static cross-platform method to sleep for a number of milliseconds.

Definition at line 128 of file Stk.cpp.

void swap16 ( unsigned char *  ptr) [static]

Static method which byte-swaps a 16-bit data type.

Definition at line 68 of file Stk.cpp.

void swap32 ( unsigned char *  ptr) [static]

Static method which byte-swaps a 32-bit data type.

Definition at line 78 of file Stk.cpp.

void swap64 ( unsigned char *  ptr) [static]

Static method which byte-swaps a 64-bit data type.

Definition at line 94 of file Stk.cpp.


Field Documentation

const Stk::STK_FORMAT MY_FLOAT32 = 16 [static]

Normalized between plus/minus 1.0.

Definition at line 92 of file Stk.h.

const Stk::STK_FORMAT MY_FLOAT64 = 32 [static]

Normalized between plus/minus 1.0.

Definition at line 93 of file Stk.h.

const Stk::STK_FORMAT STK_SINT16 = 2 [static]

-32768 to +32767

Definition at line 90 of file Stk.h.

const Stk::STK_FORMAT STK_SINT32 = 8 [static]

-2147483648 to +2147483647.

Definition at line 91 of file Stk.h.

const Stk::STK_FORMAT STK_SINT8 = 1 [static]

-128 to +127

Definition at line 89 of file Stk.h.


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