|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.vwp.sound.mod.modplay.module.Module
public class Module
A module. Should be generic enough to support all module formats. A module contains a set of patterns and instruments, Each pattern contains several tracks (often 4), and each instrument contain several samples.
Field Summary | |
---|---|
static int |
INSTRUMENT_PANNING
indicates that the panning of a sample is decided by the panning value of the instrument that this sample is a part of |
static int |
SAMPLE_PANNING
indicates that the panning of a sample is decided by the panning value of that sample (This is uses by XMs) |
static int |
TRACK_PANNING
Indicates that the panning of a sample is decided by which track it is played in (This is used by MODs.) |
Constructor Summary | |
---|---|
Module(java.lang.String name,
java.lang.String id,
java.lang.String tracker,
Instrument[] instruments,
Pattern[] patterns,
int[] patternOrder,
int restartPos,
int initialBPM,
int initialSpeed,
double initialVolume,
int panningType,
double[] initialTrackVolume,
double[] initialPanning)
|
Method Summary | |
---|---|
java.lang.String |
getDescription()
|
java.lang.String |
getId()
|
java.lang.String |
getInfo()
|
int |
getInitialBpm()
|
double |
getInitialPanning(int track)
|
int |
getInitialSpeed()
|
double |
getInitialVolume()
|
double |
getInitialVolume(int track)
get the value of the initial relative volume of a track. |
Instrument |
getInstrument(int n)
|
Instrument[] |
getInstruments()
|
java.lang.String |
getName()
|
int |
getNumberOfInstruments()
|
int |
getNumberOfPatterns()
|
int |
getNumberOfPositions()
|
int |
getPanningType()
|
Pattern |
getPattern(int n)
|
Pattern |
getPatternAtPos(int n)
|
int |
getPatternIndexAtPos(int n)
|
int |
getRestartPos()
|
int |
getTrackCount()
utility method for finding the number of tracks (channels) in the module. |
java.lang.String |
getTracker()
|
void |
setDescription(java.lang.String description)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int TRACK_PANNING
public static final int SAMPLE_PANNING
public static final int INSTRUMENT_PANNING
Constructor Detail |
---|
public Module(java.lang.String name, java.lang.String id, java.lang.String tracker, Instrument[] instruments, Pattern[] patterns, int[] patternOrder, int restartPos, int initialBPM, int initialSpeed, double initialVolume, int panningType, double[] initialTrackVolume, double[] initialPanning)
name
- the name of the moduleid
- the id (type) ofthis moduletracker
- the tracker this module was made withinstruments
- the instruments that this module will playpatterns
- the patterns of this instrumentpatternOrder
- the order the patterns is to be played inrestartPos
- the position to restart the module at when it is finnishedinitialBPM
- the speed in Beats Per Minute to start playing this module ininitialSpeed
- the initial speed in ticks per division to play this module ininitialVolume
- the initial volumeinitialPanning
- the initial panning of each trackMethod Detail |
---|
public java.lang.String getInfo()
public java.lang.String getName()
public java.lang.String getId()
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
public java.lang.String getTracker()
public int getNumberOfInstruments()
public Instrument getInstrument(int n)
public Instrument[] getInstruments()
public int getNumberOfPatterns()
public int getNumberOfPositions()
public int getPatternIndexAtPos(int n)
public Pattern getPattern(int n)
public Pattern getPatternAtPos(int n)
public int getRestartPos()
public int getInitialBpm()
public int getInitialSpeed()
public double getInitialVolume()
public int getPanningType()
public double getInitialVolume(int track)
track
-
public double getInitialPanning(int track)
public int getTrackCount()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |