Packagede.popforge.audio.processor.bitboy.formats.xm
Classpublic final class XMFormat
InheritanceXMFormat Inheritance FormatBase



Public Properties
 PropertyDefined by
 Inheritedcredits : Array
The credits of a song.
FormatBase
 InheriteddefaultBpm : uint
Default bpm.
FormatBase
  defaultBPM : uint
XMFormat
 InheriteddefaultSpeed : uint
Default speed.
FormatBase
  defaultTempo : uint
XMFormat
 Inheritedlength : uint
The length of the sequence property.
FormatBase
 InheritednumChannels : uint
The number of channels.
FormatBase
  numInstruments : uint
XMFormat
 InheritednumPatterns : uint
The length of the patterns property.
FormatBase
 InheritedrestartPosition : uint
Default restart position in sequence once song is completed.
FormatBase
 Inheritedtitle : String
The title of the current module.
FormatBase
  useLinearSlides : Boolean
XMFormat
Protected Properties
 PropertyDefined by
 Inheritedpatterns : Array
An Array of patterns.
FormatBase
 Inheritedsequence : Array
An Array of pattern identifiers.
FormatBase
Public Methods
 MethodDefined by
  
XMFormat(stream:ByteArray)
XMFormat
  
decode(stream:ByteArray):XMFormat
[static]
XMFormat
 Inherited
getChannels(bitboy:BitBoy):Array
Creates and reurns an array of channels.
FormatBase
 Inherited
getPatternLength(patternIndex:uint):uint
Returns the number of rows in the pattern at given index.
FormatBase
 Inherited
getSequenceAt(sequenceIndex:uint):uint
Finds the pattern index at given position in the sequence.
FormatBase
 Inherited
getTriggerAt(patternIndex:uint, rowIndex:uint, channelIndex:uint):TriggerBase
Finds the trigger object at given indices.
FormatBase
 Inherited
toString():String
Creates and returns the string representation of the object.
FormatBase
Protected Methods
 MethodDefined by
  
parse(stream:ByteArray):void
XMFormat
Public Constants
 ConstantDefined by
  ENCODING : String = "us-ascii"
[static]
XMFormat
Property detail
defaultBPMproperty
public var defaultBPM:uint
defaultTempoproperty 
public var defaultTempo:uint
numInstrumentsproperty 
public var numInstruments:uint
useLinearSlidesproperty 
public var useLinearSlides:Boolean
Constructor detail
XMFormat()constructor
public function XMFormat(stream:ByteArray)Parameters
stream:ByteArray
Method detail
decode()method
public static function decode(stream:ByteArray):XMFormatParameters
stream:ByteArray

Returns
XMFormat
parse()method 
protected override function parse(stream:ByteArray):voidParameters
stream:ByteArray
Constant detail
ENCODINGconstant
public static const ENCODING:String = "us-ascii"