Packageorg.si.sion.sequencer
Classpublic class SiMMLVoice
InheritanceSiMMLVoice Inheritance Object
Subclasses SiONVoice

Voice data. This includes SiOPMChannelParam.

See also

org.si.sion.module.SiOPMChannelParam
org.si.sion.module.SiOPMOperatorParam


Public Properties
 PropertyDefined By
  amDelay : int
amplitude modulation changing delay.
SiMMLVoice
  amDepth : int
amplitude modulation depth.
SiMMLVoice
  amDepthEnd : int
amplitude modulation depth after changing.
SiMMLVoice
  amTerm : int
amplitude modulation changing term.
SiMMLVoice
  channelNum : int
channel number, 2nd argument of '%'.
SiMMLVoice
  channelParam : SiOPMChannelParam
parameters for FM sound channel.
SiMMLVoice
  chipType : String
chip type
SiMMLVoice
  defaultGateTicks : int
[Not implemented in current version] default absolute gate time (same as 1st argument of "@q" command), set -1 to ignore.
SiMMLVoice
  defaultGateTime : Number
default gate time (same as "q" command 0.125), set Number.NaN to ignore.
SiMMLVoice
  defaultKeyOnDelayTicks : int
[Not implemented in current version] default key on delay (same as 2nd argument "@q" command), set -1 to ignore.
SiMMLVoice
  expression : int
expression
SiMMLVoice
  expressionMode : int
expression table mode (same as "%x" command).
SiMMLVoice
  isFMVoice : Boolean
[read-only] FM voice flag
SiMMLVoice
  isPCMVoice : Boolean
[read-only] PCM voice flag
SiMMLVoice
  isSamplerVoice : Boolean
[read-only] Sampler voice flag
SiMMLVoice
  isWaveTableVoice : Boolean
[read-only] wave table voice flag
SiMMLVoice
  moduleType : int
module type, 1st argument of '%'.
SiMMLVoice
  noteOffAmplitudeEnvelop : SiMMLEnvelopTable
note off amplitude envelop table.
SiMMLVoice
  noteOffAmplitudeEnvelopStep : int
note off amplitude envelop tablestep.
SiMMLVoice
  noteOffFilterEnvelop : SiMMLEnvelopTable
note off filter envelop table.
SiMMLVoice
  noteOffFilterEnvelopStep : int
note off filter envelop tablestep.
SiMMLVoice
  noteOffNoteEnvelop : SiMMLEnvelopTable
note off note envelop table.
SiMMLVoice
  noteOffNoteEnvelopStep : int
note off note envelop tablestep.
SiMMLVoice
  noteOffPitchEnvelop : SiMMLEnvelopTable
note off pitch envelop table.
SiMMLVoice
  noteOffPitchEnvelopStep : int
note off pitch envelop tablestep.
SiMMLVoice
  noteOffToneEnvelop : SiMMLEnvelopTable
note off tone envelop table.
SiMMLVoice
  noteOffToneEnvelopStep : int
note off tone envelop tablestep.
SiMMLVoice
  noteOnAmplitudeEnvelop : SiMMLEnvelopTable
note on amplitude envelop table.
SiMMLVoice
  noteOnAmplitudeEnvelopStep : int
note on amplitude envelop tablestep.
SiMMLVoice
  noteOnFilterEnvelop : SiMMLEnvelopTable
note on filter envelop table.
SiMMLVoice
  noteOnFilterEnvelopStep : int
note on filter envelop tablestep.
SiMMLVoice
  noteOnNoteEnvelop : SiMMLEnvelopTable
note on note envelop table.
SiMMLVoice
  noteOnNoteEnvelopStep : int
note on note envelop tablestep.
SiMMLVoice
  noteOnPitchEnvelop : SiMMLEnvelopTable
note on pitch envelop table.
SiMMLVoice
  noteOnPitchEnvelopStep : int
note on pitch envelop tablestep.
SiMMLVoice
  noteOnToneEnvelop : SiMMLEnvelopTable
note on tone envelop table.
SiMMLVoice
  noteOnToneEnvelopStep : int
note on tone envelop tablestep.
SiMMLVoice
  noteShift : int
track key transpose (same as "kt" command).
SiMMLVoice
  pitchShift : int
track pitch shift (same as "k" command).
SiMMLVoice
  pmDelay : int
pitch modulation changing delay.
SiMMLVoice
  pmDepth : int
pitch modulation depth.
SiMMLVoice
  pmDepthEnd : int
pitch modulation depth after changing.
SiMMLVoice
  pmsTension : int
PMS guitar tension
SiMMLVoice
  pmTerm : int
pitch modulation changing term.
SiMMLVoice
  portament : int
portament.
SiMMLVoice
  preferableNote : int
preferable note.
SiMMLVoice
  releaseSweep : int
release sweep.
SiMMLVoice
  toneNum : int
tone number, 1st argument of '@'.
SiMMLVoice
  updateTrackParamaters : Boolean
update track paramaters, false to update only channel params.
SiMMLVoice
  updateVolumes : Boolean
update volume, velocity, expression and panning when the voice is set.
SiMMLVoice
  vcommandShift : int
velocity table mode (same as 2nd argument of "%v" command).
SiMMLVoice
  velocity : int
velocity
SiMMLVoice
  velocityMode : int
velocity table mode (same as 1st argument of "%v" command).
SiMMLVoice
  waveData : SiOPMWaveBase
wave data.
SiMMLVoice
Public Methods
 MethodDefined By
  
constructor.
SiMMLVoice
  
copy all parameters
SiMMLVoice
  
initialize():void
initializer
SiMMLVoice
  
setModuleType(moduleType:int, channelNum:int = 0, toneNum:int = -1):void
set moduleType, channelNum, toneNum and 0th operator's pgType simultaneously.
SiMMLVoice
  
[NOT RECOMENDED] this function is only for compatibility of previous versions
SiMMLVoice
  
update track's voice paramters
SiMMLVoice
Property Detail
amDelayproperty
public var amDelay:int

amplitude modulation changing delay. 3rd argument of 'ma'.

The default value is 0.

amDepthproperty 
public var amDepth:int

amplitude modulation depth. 1st argument of 'ma'.

The default value is 0.

amDepthEndproperty 
public var amDepthEnd:int

amplitude modulation depth after changing. 2nd argument of 'ma'.

The default value is 0.

amTermproperty 
public var amTerm:int

amplitude modulation changing term. 4th argument of 'ma'.

The default value is 0.

channelNumproperty 
public var channelNum:int

channel number, 2nd argument of '%'.

The default value is 0.

channelParamproperty 
public var channelParam:SiOPMChannelParam

parameters for FM sound channel.

chipTypeproperty 
public var chipType:String

chip type

defaultGateTicksproperty 
public var defaultGateTicks:int

[Not implemented in current version] default absolute gate time (same as 1st argument of "@q" command), set -1 to ignore.

The default value is -1.

defaultGateTimeproperty 
public var defaultGateTime:Number

default gate time (same as "q" command 0.125), set Number.NaN to ignore.

The default value is Number.NaN.

defaultKeyOnDelayTicksproperty 
public var defaultKeyOnDelayTicks:int

[Not implemented in current version] default key on delay (same as 2nd argument "@q" command), set -1 to ignore.

The default value is -1.

expressionproperty 
public var expression:int

expression

The default value is 128.

expressionModeproperty 
public var expressionMode:int

expression table mode (same as "%x" command).

The default value is 0.

isFMVoiceproperty 
isFMVoice:Boolean  [read-only]

FM voice flag


Implementation
    public function get isFMVoice():Boolean
isPCMVoiceproperty 
isPCMVoice:Boolean  [read-only]

PCM voice flag


Implementation
    public function get isPCMVoice():Boolean
isSamplerVoiceproperty 
isSamplerVoice:Boolean  [read-only]

Sampler voice flag


Implementation
    public function get isSamplerVoice():Boolean
isWaveTableVoiceproperty 
isWaveTableVoice:Boolean  [read-only]

wave table voice flag


Implementation
    public function get isWaveTableVoice():Boolean
moduleTypeproperty 
public var moduleType:int

module type, 1st argument of '%'.

The default value is 0.

noteOffAmplitudeEnvelopproperty 
public var noteOffAmplitudeEnvelop:SiMMLEnvelopTable

note off amplitude envelop table. 1st argument of '_na'

The default value is null.

noteOffAmplitudeEnvelopStepproperty 
public var noteOffAmplitudeEnvelopStep:int

note off amplitude envelop tablestep. 2nd argument of '_na'

The default value is 1.

noteOffFilterEnvelopproperty 
public var noteOffFilterEnvelop:SiMMLEnvelopTable

note off filter envelop table. 1st argument of '_nf'

The default value is null.

noteOffFilterEnvelopStepproperty 
public var noteOffFilterEnvelopStep:int

note off filter envelop tablestep. 2nd argument of '_nf'

The default value is 1.

noteOffNoteEnvelopproperty 
public var noteOffNoteEnvelop:SiMMLEnvelopTable

note off note envelop table. 1st argument of '_nt'

The default value is null.

noteOffNoteEnvelopStepproperty 
public var noteOffNoteEnvelopStep:int

note off note envelop tablestep. 2nd argument of '_nt'

The default value is 1.

noteOffPitchEnvelopproperty 
public var noteOffPitchEnvelop:SiMMLEnvelopTable

note off pitch envelop table. 1st argument of '_np'

The default value is null.

noteOffPitchEnvelopStepproperty 
public var noteOffPitchEnvelopStep:int

note off pitch envelop tablestep. 2nd argument of '_np'

The default value is 1.

noteOffToneEnvelopproperty 
public var noteOffToneEnvelop:SiMMLEnvelopTable

note off tone envelop table. 1st argument of '_@@'

The default value is null.

noteOffToneEnvelopStepproperty 
public var noteOffToneEnvelopStep:int

note off tone envelop tablestep. 2nd argument of '_@@'

The default value is 1.

noteOnAmplitudeEnvelopproperty 
public var noteOnAmplitudeEnvelop:SiMMLEnvelopTable

note on amplitude envelop table. 1st argument of 'na'

The default value is null.

noteOnAmplitudeEnvelopStepproperty 
public var noteOnAmplitudeEnvelopStep:int

note on amplitude envelop tablestep. 2nd argument of 'na'

The default value is 1.

noteOnFilterEnvelopproperty 
public var noteOnFilterEnvelop:SiMMLEnvelopTable

note on filter envelop table. 1st argument of 'nf'

The default value is null.

noteOnFilterEnvelopStepproperty 
public var noteOnFilterEnvelopStep:int

note on filter envelop tablestep. 2nd argument of 'nf'

The default value is 1.

noteOnNoteEnvelopproperty 
public var noteOnNoteEnvelop:SiMMLEnvelopTable

note on note envelop table. 1st argument of 'nt'

The default value is null.

noteOnNoteEnvelopStepproperty 
public var noteOnNoteEnvelopStep:int

note on note envelop tablestep. 2nd argument of 'nt'

The default value is 1.

noteOnPitchEnvelopproperty 
public var noteOnPitchEnvelop:SiMMLEnvelopTable

note on pitch envelop table. 1st argument of 'np'

The default value is null.

noteOnPitchEnvelopStepproperty 
public var noteOnPitchEnvelopStep:int

note on pitch envelop tablestep. 2nd argument of 'np'

The default value is 1.

noteOnToneEnvelopproperty 
public var noteOnToneEnvelop:SiMMLEnvelopTable

note on tone envelop table. 1st argument of '@@'

The default value is null.

noteOnToneEnvelopStepproperty 
public var noteOnToneEnvelopStep:int

note on tone envelop tablestep. 2nd argument of '@@'

The default value is 1.

noteShiftproperty 
public var noteShift:int

track key transpose (same as "kt" command).

The default value is 0.

pitchShiftproperty 
public var pitchShift:int

track pitch shift (same as "k" command).

The default value is 0.

pmDelayproperty 
public var pmDelay:int

pitch modulation changing delay. 3rd argument of 'mp'.

The default value is 0.

pmDepthproperty 
public var pmDepth:int

pitch modulation depth. 1st argument of 'mp'.

The default value is 0.

pmDepthEndproperty 
public var pmDepthEnd:int

pitch modulation depth after changing. 2nd argument of 'mp'.

The default value is 0.

pmsTensionproperty 
public var pmsTension:int

PMS guitar tension

The default value is 8.

pmTermproperty 
public var pmTerm:int

pitch modulation changing term. 4th argument of 'mp'.

The default value is 0.

portamentproperty 
public var portament:int

portament.

The default value is 0.

preferableNoteproperty 
public var preferableNote:int

preferable note. -1;no preferable note.

The default value is -1.

releaseSweepproperty 
public var releaseSweep:int

release sweep. 2nd argument of '@rr' and 's'.

The default value is 0.

toneNumproperty 
public var toneNum:int

tone number, 1st argument of '@'. -1;do nothing.

The default value is -1.

updateTrackParamatersproperty 
public var updateTrackParamaters:Boolean

update track paramaters, false to update only channel params.

The default value is false(SiMMLVoice), true(SiONVoice).

updateVolumesproperty 
public var updateVolumes:Boolean

update volume, velocity, expression and panning when the voice is set.

The default value is false(ignore volume settings).

vcommandShiftproperty 
public var vcommandShift:int

velocity table mode (same as 2nd argument of "%v" command).

The default value is 0.

velocityproperty 
public var velocity:int

velocity

The default value is 256.

velocityModeproperty 
public var velocityMode:int

velocity table mode (same as 1st argument of "%v" command).

The default value is 0.

waveDataproperty 
public var waveData:SiOPMWaveBase

wave data.

The default value is null.

Constructor Detail
SiMMLVoice()Constructor
public function SiMMLVoice()

constructor.

Method Detail
copyFrom()method
public function copyFrom(src:SiMMLVoice):void

copy all parameters

Parameters

src:SiMMLVoice

initialize()method 
public function initialize():void

initializer

setModuleType()method 
public function setModuleType(moduleType:int, channelNum:int = 0, toneNum:int = -1):void

set moduleType, channelNum, toneNum and 0th operator's pgType simultaneously.

Parameters

moduleType:int — Channel module type
 
channelNum:int (default = 0) — Channel number. For %2-11, this value is same as 1st argument of '_@'.
 
toneNum:int (default = -1) — Tone number. Ussualy, this argument is used only in %0;PSG and %1;APU.

setTrackVoice()method 
public function setTrackVoice(track:SiMMLTrack):SiMMLTrack

[NOT RECOMENDED] this function is only for compatibility of previous versions

Parameters

track:SiMMLTrack

Returns
SiMMLTrack
updateTrackVoice()method 
public function updateTrackVoice(track:SiMMLTrack):SiMMLTrack

update track's voice paramters

Parameters

track:SiMMLTrack

Returns
SiMMLTrack