Class weasel.DOCSoundTracker9

Extends weasel.UltimateSoundTracker18.

Defined in: DOCSoundTracker9.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	weasel.DOCSoundTracker9(aModuleData, iPlaybackFrequency, iSampleScannerMode) Create a DOC Soundtracker 9 module out of the provided data (which has already passed the module sniffer test).

Fields borrowed from class weasel.UltimateSoundTracker121:: NTSC, PAL, TimingOverrides

Method Summary
Method Attributes	Method Name and Description
	getLengthOfSongInMilliSeconds() Get length of song in milliseconds.
	getSongPositionInMilliSeconds() Get song position in milliseconds.
	processTick0Effects() Process the effects column for all channels when current tick is zero (a new row has been fetched).
	setTickSpeed(iTickSpeed) Set the row tick speed.

Methods borrowed from class weasel.UltimateSoundTracker121:: changePlaybackFrequency, extractPatterns, fetchRow, findMaximumPatternNumber, FormatInstrumentTotal, FormatModuleHeaderSize, getChannel, getCIATimerConstant, getCurrentPatternCell, getCurrentPatternRowPosition, getCurrentSequencePosition, getCurrentTick, getFSTPanningMode, getInstrument, getMasterVolume, getModuleData, getModuleType, getNoiseTrackerLoopQuirkEnabled, getNoteFromPeriod, getNumberOfChannels, getPattern, getPatternNumber, getPatternSizeInBytes, getPlaybackFrequency, getProtracker3SampleOffsetMode, getProtrackerTremoloSawtoothBugMode, getSequenceTable, getSongLengthInPatterns, getSongSpeed, getTickSpeed, getTimingOverride, getTitle, getVibratoMode, hasSongEnded, numberOfUniquePatternsInSong, play, processEffects, processPattern, restartSong, setClockConstant, setCurrentSequencePosition, setFST7BitPanningMode, setMasterVolume, setProtracker3SampleOffsetMode, setProtrackerTremoloSawtoothBugMode, setSamplesPerTick, setSongSpeed, setVibratoMode, startPendingSample, tickPlaybackRateInHz, timingOverride, WaitForDMAToStop

Class Detail

weasel.DOCSoundTracker9(aModuleData, iPlaybackFrequency, iSampleScannerMode)

Create a DOC Soundtracker 9 module out of the provided data (which has already passed the module sniffer test). DOC Soundtracker 9 is based upon Ultimate Soundtracker 1.8 with some additional effect commands.
Author: Warren Willmey 2012.

Parameters:
{Array|Uint8Array} aModuleData: = The DOC Soundtracker 9 module as a byte array that MUST have passed the module sniffer test.
{int} iPlaybackFrequency: = The playback frequency in hertz to use (e.g. 44100 ).
{weasel.Sample.prototype.SampleScannerMode} iSampleScannerMode: = Scan for IFF Header corruption residue?.

Method Detail

{float} getLengthOfSongInMilliSeconds()

Get length of song in milliseconds.

Returns:: {float} = The length of the song in ms.

{float} getSongPositionInMilliSeconds()

Get song position in milliseconds.

Returns:: {float} = The song position from its beginning in ms.

processTick0Effects()

Process the effects column for all channels when current tick is zero (a new row has been fetched).

setTickSpeed(iTickSpeed)

Set the row tick speed.

Parameters:
{int} iTickSpeed: = The new row tick speed to use (2-15).

Classes

Class weasel.DOCSoundTracker9