org.si.sound.DrumMachine

Public Properties

	Property		Defined By
		bass : Sequencer [read-only] Sequencer object of bass drum	DrumMachine
		bassPattern : Vector.<Note> Sequence pattern of bass drum	DrumMachine
		bassPatternNumber : int bass drum pattern number.	DrumMachine
		bassPatternNumberMax : int [read-only] maximum value of basePatternNumber	DrumMachine
		bassVoiceNumber : int bass drum pattern number.	DrumMachine
		bassVoiceNumberMax : int [read-only] maximum value of baseVoiceNumber	DrumMachine
		bassVolume : Number bass drum volume (0-1)	DrumMachine
		changePatternOnNextSegment : Boolean True to change bass line pattern at the head of segment.	DrumMachine
		coarseTune : int Master coarse tuning, 1 for half-tone.	SoundObject
		delay : Number Sound delay, uint in 16th beat.	SoundObject
		driver : SiONDriver [read-only] SiONDriver instrance to operate.	SoundObject
		effectors : Array Array of SiEffectBase to modify this sound object's output.	SoundObject
		effectSend1 : Number Channel effect send level for slot 1 (0:Minimum - 1:Maximum), this property can control track after play().	SoundObject
		effectSend2 : Number Channel effect send level for slot 2 (0:Minimum - 1:Maximum), this property can control track after play().	SoundObject
		effectSend3 : Number Channel effect send level for slot 3 (0:Minimum - 1:Maximum), this property can control track after play().	SoundObject
		effectSend4 : Number Channel effect send level for slot 4 (0:Minimum - 1:Maximum), this property can control track after play().	SoundObject
		eventMask : int Track event mask.	SoundObject
		eventTriggerID : int Track event trigger ID	SoundObject
		fineTune : Number Master fine tuning, 1 for half-tone, you can specify fineTune<-1 or fineTune>1.	SoundObject
		gateTime : Number Track gate time (0:Minimum - 1:Maximum).	SoundObject
		hihat : Sequencer [read-only] Sequencer object of hihat symbal	DrumMachine
		hihatPattern : Vector.<Note> Sequence pattern of hihat symbal	DrumMachine
		hihatPatternNumber : int hi-hat cymbal pattern number.	DrumMachine
		hihatPatternNumberMax : int [read-only] maximum value of hihatPatternNumber	DrumMachine
		hihatVoiceNumber : int hi-hat cymbal pattern number.	DrumMachine
		hihatVoiceNumberMax : int [read-only] maximum value of hihatVoiceNumber	DrumMachine
		hihatVolume : Number hihat symbal volume (0-1)	DrumMachine
		isPlaying : Boolean [read-only] is playing ?	SoundObject
		length : Number Sound length in 16th beat, 0 sets inifinity length.	SoundObject
		mute : Boolean Channel mute, this property can control track after play().	SoundObject
		name : String Name.	SoundObject
		note : int Base note of this sound	SoundObject
		noteOffTriggerType : int [read-only] Track note off trigger type	SoundObject
		noteOnTriggerType : int [read-only] Track note on trigger type	SoundObject
		pan : Number Channel panning (-1:Left - 0:Center - +1:Right), this property can control track after play().	SoundObject
		parent : SoundObjectContainer [read-only] parent container.	SoundObject
		pitchBend : Number Channel pitch bend, 1 for halftone, this property can control track after play().	SoundObject
		presetPattern : DrumMachinePresetPattern [read-only] Preset patterns	DrumMachine
		presetVoice : DrumMachinePresetVoice [read-only] Preset voices	DrumMachine
		quantize : Number Synchronizing quantizing, uint in 16th beat.	SoundObject
		snare : Sequencer [read-only] Sequencer object of snare drum	DrumMachine
		snarePattern : Vector.<Note> Sequence pattern of snare drum	DrumMachine
		snarePatternNumber : int snare drum pattern number.	DrumMachine
		snarePatternNumberMax : int [read-only] maximum value of snarePatternNumber	DrumMachine
		snareVoiceNumber : int snare drum pattern number.	DrumMachine
		snareVoiceNumberMax : int [read-only] maximum value of snareVoiceNumber	DrumMachine
		snareVolume : Number snare drum volume (0-1)	DrumMachine
		synthesizer : VoiceReference Synthesizer to generate sound	SoundObject
		trackCount : int [read-only] Returns the number of tracks.	MultiTrackSoundObject
		trackID : int [read-only] Track id	SoundObject
		voice : SiONVoice Voice data to play	SoundObject
		volume : Number Channel volume (0:Minimum - 1:Maximum), this property can control track after play().	SoundObject

	Method	Defined By
		DrumMachine(bassPatternNumber:int = 0, snarePatternNumber:int = 8, hihatPatternNumber:int = 0, bassVoiceNumber:int = 0, snareVoiceNumber:int = 0, hihatVoiceNumber:int = 0) constructor	DrumMachine
		fadeIn(time:Number):void Set fading in.	SoundObject
		fadeOut(time:Number):void Set fading out.	SoundObject
		play():void [override] play drum sequence	DrumMachine
		reset():void Reset	SoundObject
		setPatternNumbers(bassPatternNumber:int, snarePatternNumber:int, hihatPatternNumber:int):DrumMachine Set all pattern indeces	DrumMachine
		setVolume(slot:int, volume:Number):void Set volume by index.	SoundObject
		stop():void [override] stop sequence	DrumMachine

Summary	Defined By
enterFrame	Dispatch in each frame in PatternSequencer.	DrumMachine
enterSegment	Dispatch in each segment in PatternSequencer.	DrumMachine
noteOffFrame	Dispatch when the sound ends.	SoundObject
noteOffStream	Dispatch when the note off appears in the sequence.	SoundObject
noteOnFrame	Dispatch when the sound starts.	SoundObject
noteOnStream	Dispatch when the note on appears.	SoundObject

Property Detail

bass

property

bass:Sequencer [read-only]

Sequencer object of bass drum

Implementation
public function get bass():Sequencer

bassPattern

property

bassPattern:Vector.<Note>

Sequence pattern of bass drum

Implementation
public function get bassPattern():Vector.<Note>
public function set bassPattern(value:Vector.<Note>):void

bassPatternNumber

property

bassPatternNumber:int

bass drum pattern number.

Implementation
public function get bassPatternNumber():int
public function set bassPatternNumber(value:int):void

bassPatternNumberMax

property

bassPatternNumberMax:int [read-only]

maximum value of basePatternNumber

Implementation
public function get bassPatternNumberMax():int

bassVoiceNumber

property

bassVoiceNumber:int

bass drum pattern number.

Implementation
public function get bassVoiceNumber():int
public function set bassVoiceNumber(value:int):void

bassVoiceNumberMax

property

bassVoiceNumberMax:int [read-only]

maximum value of baseVoiceNumber

Implementation
public function get bassVoiceNumberMax():int

bassVolume

property

bassVolume:Number

bass drum volume (0-1)

Implementation
public function get bassVolume():Number
public function set bassVolume(value:Number):void

changePatternOnNextSegment

property

changePatternOnNextSegment:Boolean

True to change bass line pattern at the head of segment.

The default value is true.

Implementation
public function get changePatternOnNextSegment():Boolean
public function set changePatternOnNextSegment(value:Boolean):void

hihat

property

hihat:Sequencer [read-only]

Sequencer object of hihat symbal

Implementation
public function get hihat():Sequencer

hihatPattern

property

hihatPattern:Vector.<Note>

Sequence pattern of hihat symbal

Implementation
public function get hihatPattern():Vector.<Note>
public function set hihatPattern(value:Vector.<Note>):void

hihatPatternNumber

property

hihatPatternNumber:int

hi-hat cymbal pattern number.

Implementation
public function get hihatPatternNumber():int
public function set hihatPatternNumber(value:int):void

hihatPatternNumberMax

property

hihatPatternNumberMax:int [read-only]

maximum value of hihatPatternNumber

Implementation
public function get hihatPatternNumberMax():int

hihatVoiceNumber

property

hihatVoiceNumber:int

hi-hat cymbal pattern number.

Implementation
public function get hihatVoiceNumber():int
public function set hihatVoiceNumber(value:int):void

hihatVoiceNumberMax

property

hihatVoiceNumberMax:int [read-only]

maximum value of hihatVoiceNumber

Implementation
public function get hihatVoiceNumberMax():int

hihatVolume

property

hihatVolume:Number

hihat symbal volume (0-1)

Implementation
public function get hihatVolume():Number
public function set hihatVolume(value:Number):void

presetPattern

property

presetPattern:DrumMachinePresetPattern [read-only]

Preset patterns

Implementation
public function get presetPattern():DrumMachinePresetPattern

presetVoice

property

presetVoice:DrumMachinePresetVoice [read-only]

Preset voices

Implementation
public function get presetVoice():DrumMachinePresetVoice

snare

property

snare:Sequencer [read-only]

Sequencer object of snare drum

Implementation
public function get snare():Sequencer

snarePattern

property

snarePattern:Vector.<Note>

Sequence pattern of snare drum

Implementation
public function get snarePattern():Vector.<Note>
public function set snarePattern(value:Vector.<Note>):void

snarePatternNumber

property

snarePatternNumber:int

snare drum pattern number.

Implementation
public function get snarePatternNumber():int
public function set snarePatternNumber(value:int):void

snarePatternNumberMax

property

snarePatternNumberMax:int [read-only]

maximum value of snarePatternNumber

Implementation
public function get snarePatternNumberMax():int

snareVoiceNumber

property

snareVoiceNumber:int

snare drum pattern number.

Implementation
public function get snareVoiceNumber():int
public function set snareVoiceNumber(value:int):void

snareVoiceNumberMax

property

snareVoiceNumberMax:int [read-only]

maximum value of snareVoiceNumber

Implementation
public function get snareVoiceNumberMax():int

snareVolume

property

snareVolume:Number

snare drum volume (0-1)

Implementation
public function get snareVolume():Number
public function set snareVolume(value:Number):void

Constructor Detail

DrumMachine

()

Constructor

public function DrumMachine(bassPatternNumber:int = 0, snarePatternNumber:int = 8, hihatPatternNumber:int = 0, bassVoiceNumber:int = 0, snareVoiceNumber:int = 0, hihatVoiceNumber:int = 0)

constructor

Parameters

	`bassPatternNumber:int` (default = `0`) — bass drum pattern number

	`snarePatternNumber:int` (default = `8`) — snare drum pattern number

	`hihatPatternNumber:int` (default = `0`) — hihat symbal pattern number

	`bassVoiceNumber:int` (default = `0`) — bass drum voice number

	`snareVoiceNumber:int` (default = `0`) — snare drum voice number

	`hihatVoiceNumber:int` (default = `0`) — hihat symbal voice number

Method Detail

play

()

method

override public function play():void

play drum sequence

setPatternNumbers

()

method

public function setPatternNumbers(bassPatternNumber:int, snarePatternNumber:int, hihatPatternNumber:int):DrumMachine

Set all pattern indeces

Parameters

	`bassPatternNumber:int` — bass drum pattern index

	`snarePatternNumber:int` — snare drum pattern index

	`hihatPatternNumber:int` — hihat symbal pattern index

Returns

DrumMachine

stop

()

method

override public function stop():void

stop sequence

Event Detail

enterFrame

Event

Event Object Type: org.si.sound.events.SoundObjectEvent
SoundObjectEvent.type property = org.si.sound.events.SoundObjectEvent.ENTER_FRAME

Dispatch in each frame in PatternSequencer.

The properties of the event object have the following values:

Property	Value
cancelable	false
soundObject	Target SoundObject.
track	null. no meanings.
eventTriggerID	Trigger ID specifyed by setEventTrigger().
note	Note number.
bufferIndex	0. no meanings

enterSegment

Event

Event Object Type: org.si.sound.events.SoundObjectEvent
SoundObjectEvent.type property = org.si.sound.events.SoundObjectEvent.ENTER_SEGMENT

Dispatch in each segment in PatternSequencer.

The properties of the event object have the following values:

Property	Value
cancelable	false
soundObject	Target SoundObject.
track	null. no meanings.
eventTriggerID	Trigger ID specifyed by setEventTrigger().
note	0. no meanings
bufferIndex	0. no meanings

Fri Jan 22 2016, 07:46 PM +09:00

SiON version 0.66 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
DrumMachine	Properties \| Methods \| Events

Package	org.si.sound
Class	public class DrumMachine
Inheritance	DrumMachine MultiTrackSoundObject SoundObject flash.events.EventDispatcher