Package | de.popforge.audio.processor.bitboy.formats |
Class | public class FormatBase |
Subclasses | XMFormat |
Property | Defined by | ||
---|---|---|---|
credits : Array
The credits of a song.
| FormatBase | ||
defaultBpm : uint
Default bpm.
| FormatBase | ||
defaultSpeed : uint
Default speed.
| FormatBase | ||
length : uint
The length of the
sequence property. | FormatBase | ||
numChannels : uint
The number of channels.
| FormatBase | ||
numPatterns : uint
The length of the
patterns property. | FormatBase | ||
restartPosition : uint
Default restart position in sequence once song is completed.
| FormatBase | ||
title : String
The title of the current module.
| FormatBase |
Property | Defined by | ||
---|---|---|---|
patterns : Array
An Array of patterns.
| FormatBase | ||
sequence : Array
An Array of pattern identifiers.
| FormatBase |
Method | Defined by | ||
---|---|---|---|
FormatBase(stream:ByteArray)
Creates a new FormatBase object.
| FormatBase | ||
getChannels(bitboy:BitBoy):Array
Creates and reurns an array of channels.
| FormatBase | ||
getPatternLength(patternIndex:uint):uint
Returns the number of rows in the pattern at given index.
| FormatBase | ||
getSequenceAt(sequenceIndex:uint):uint
Finds the pattern index at given position in the sequence.
| FormatBase | ||
getTriggerAt(patternIndex:uint, rowIndex:uint, channelIndex:uint):TriggerBase
Finds the trigger object at given indices.
| FormatBase | ||
toString():String
Creates and returns the string representation of the object.
| FormatBase |
Method | Defined by | ||
---|---|---|---|
parse(stream:ByteArray):void
| FormatBase |
credits | property |
public var credits:Array
The credits of a song. In MOD files the samples are used for the credits while in most of the XM files the instruments hold this information.
defaultBpm | property |
public var defaultBpm:uint
Default bpm.
defaultSpeed | property |
public var defaultSpeed:uint
Default speed.
length | property |
public var length:uint
The length of the sequence
property.
Since length
property stores the length of the sequence
property it is important to keep in mind that the length given in number of patterns instead
of seconds or milliseconds for instance.
numChannels | property |
public var numChannels:uint
The number of channels.
numPatterns | property |
public var numPatterns:uint
The length of the patterns
property.
patterns | property |
protected var patterns:Array
An Array of patterns.
A pattern is defined as an Array of rows. Each row is an Array of
numChannels
channels while each channel holds one
trigger object.
restartPosition | property |
public var restartPosition:uint
Default restart position in sequence once song is completed.
sequence | property |
protected var sequence:Array
An Array of pattern identifiers.
Each identifier is a uint. The sequence
variable
holds the order in which the patterns are played.
title | property |
public var title:String
The title of the current module.
FormatBase | () | constructor |
public function FormatBase(stream:ByteArray)
Creates a new FormatBase object. Each property of the FormatBase will be set to its default value.
Parametersstream:ByteArray |
getChannels | () | method |
public function getChannels(bitboy:BitBoy):Array
Creates and reurns an array of channels.
Parametersbitboy:BitBoy |
Array — An array of channels.
|
getPatternLength | () | method |
public function getPatternLength(patternIndex:uint):uint
Returns the number of rows in the pattern at given index.
ParameterspatternIndex:uint — The index of the pattern.
|
uint — Number of rows.
|
getSequenceAt | () | method |
public function getSequenceAt(sequenceIndex:uint):uint
Finds the pattern index at given position in the sequence.
ParameterssequenceIndex:uint — The index in the sequence table.
|
uint — The pattern index at given position in the sequence.
|
getTriggerAt | () | method |
public function getTriggerAt(patternIndex:uint, rowIndex:uint, channelIndex:uint):TriggerBase
Finds the trigger object at given indices.
ParameterspatternIndex:uint — The index of the pattern.
|
|
rowIndex:uint — The index of the row.
|
|
channelIndex:uint — The index of the channel.
|
TriggerBase —
The trigger at the given position.
|
parse | () | method |
protected function parse(stream:ByteArray):void
Parameters
stream:ByteArray |
toString | () | method |
public function toString():String
Creates and returns the string representation of the object.
ReturnsString — The string represenation of the object.
|