libsidplayfp  0.3.5
Public Member Functions | List of all members
sidplay2 Class Reference

#include <sidplay2.h>

Public Member Functions

const sid2_config_tconfig (void) const
const sid2_info_tinfo (void) const
int config (const sid2_config_t &cfg)
const char * error (void) const
int fastForward (uint percent)
int load (SidTune *tune)
void pause (void)
uint_least32_t play (short *buffer, uint_least32_t count)
sid2_player_t state (void) const
void stop (void)
void debug (bool enable, FILE *out)
void mute (int voice, bool enable)
 operator bool () const
bool operator! () const
SID_DEPRECATED uint_least32_t timebase (void) const
 Timer functions with respect to resolution returned by timebase.
uint_least32_t time (void) const
 Timer functions with respect to resolution returned by timebase.
uint_least32_t mileage (void) const
 Timer functions with respect to resolution returned by timebase.

Detailed Description

sidplay2

Member Function Documentation

int sidplay2::config ( const sid2_config_t cfg)

Configure the engine.

Parameters
cfg
Returns
0 on sucess, -1 otherwise.
void sidplay2::debug ( bool  enable,
FILE *  out 
)

Control debugging

Parameters
enableenable/disable debugging.
outthe file where to redirect the debug info.
const char * sidplay2::error ( void  ) const

Error message

Returns
string error message.
int sidplay2::fastForward ( uint  percent)
Parameters
percent
int sidplay2::load ( SidTune tune)

Load a tune

Parameters
tunethe SidTune to load, 0 unloads current tune
Returns
0 on sucess, -1 otherwise
void sidplay2::pause ( void  )

Pause the engine

uint_least32_t sidplay2::play ( short *  buffer,
uint_least32_t  count 
)

Produce samples to play

Parameters
bufferpointer to the buffer to fill with samples.
countthe size of the buffer.
Returns
the number of produced samples.
sid2_player_t sidplay2::state ( void  ) const

Check the state of the engine.

Returns
void sidplay2::stop ( void  )

Stop engine


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