Sifteo::AudioTracker Struct Reference

Playback interface for Tracker modules. More...

#include <sifteo/audio.h>

Static Public Member Functions
static bool	isPaused ()
	Is the tracker currently playing a module?
static bool	isStopped ()
	Is the tracker currently playing a module?
static void	pause ()
	Pause playback of a module.
static bool	play (const AssetTracker &asset)
	Begin playback of a module. More...
static bool	resume ()
	Resume playback of a paused module.
static void	setPosition (uint16_t phrase, uint16_t row)
	Set play position for current song. More...
static void	setTempoModifier (int modifier)
	Scale tempo for current song. More...
static void	setVolume (int volume, _SYSAudioChannelID ch=-1)
	Scale volume for current channel. More...
static void	stop ()
	Stop playback of the current module. More...

Detailed Description

Playback interface for Tracker modules.

Supported module format is standard XM. stir processes your modules as part of the application packaging process, resulting in an AssetTracker instance for each.

Member Function Documentation

static bool Sifteo::AudioTracker::play ( const AssetTracker &  asset )

inlinestatic

Begin playback of a module.

Parameters

asset

specifies the module for playback.

static void Sifteo::AudioTracker::setPosition ( uint16_t  phrase, uint16_t  row  )

inlinestatic

Set play position for current song.

Must only be called while a module is playing, takes effect at the end of the current note.

Parameters

phrase	Index of target phrase.
row	Index of target row in the pattern.

static void Sifteo::AudioTracker::setTempoModifier ( int  modifier )

inlinestatic

Scale tempo for current song.

Must only be called while a module is playing, takes effect at the end of the current tick.

Parameters

modifier

Value with which to increase/decrease tempo, in percent.

static void Sifteo::AudioTracker::setVolume ( int  volume, _SYSAudioChannelID  ch = -1  )

inlinestatic

Scale volume for current channel.

Must only be called while a module is playing.

Parameters

volume	from 0 to MAX_VOLUME.
ch	specifies the index of the channel in the module. Leave empty to set global volume.

static void Sifteo::AudioTracker::stop ( )

inlinestatic

Stop playback of the current module.

Has no effect if a module is not currently playing.

---

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

• audio.h