org.si.sound.Arpeggiator

Public Properties

	Property		Defined By
		changePatternOnNextSegment : Boolean True to change bass line pattern at the head of segment.	Arpeggiator
		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 [override] current length in the sequence, you cannot change this property.	PatternSequencer
		isPlaying : Boolean [read-only] is playing ?	SoundObject
		length : Number [override] current length in the sequence, you cannot change this property.	PatternSequencer
		mute : Boolean Channel mute, this property can control track after play().	SoundObject
		name : String Name.	SoundObject
		note : int [override] change root note of the scale	Arpeggiator
		noteLength : Number note length in 16th beat.	Arpeggiator
		noteOffTriggerType : int [read-only] Track note off trigger type	SoundObject
		noteOnTriggerType : int [read-only] Track note on trigger type	SoundObject
		noteQuantize : int [NOT RECOMENDED] Only for the compatibility before version 0.58, the getTime property can be used instead of this property.	Arpeggiator
		onEnterFrame : Function callback on enter frame	PatternSequencer
		onEnterSegment : Function callback on enter segment	PatternSequencer
		onExitFrame : Function callback on exit frame	PatternSequencer
		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
		pattern : Array Note index array of the arpeggio pattern.	Arpeggiator
		pitchBend : Number Channel pitch bend, 1 for halftone, this property can control track after play().	SoundObject
		portament : int portament	PatternSequencer
		quantize : Number Synchronizing quantizing, uint in 16th beat.	SoundObject
		scale : Scale scale instance	Arpeggiator
		scaleIndex : int index on scale	Arpeggiator
		scaleName : String specify scale by name	Arpeggiator
		sequencer : Sequencer [read-only] the Sequencer instance belonging to this PatternSequencer, where the sequence pattern appears.	PatternSequencer
		synthesizer : VoiceReference Synthesizer to generate sound	SoundObject
		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
		Arpeggiator(scale:* = null, noteLength:Number = 2, pattern:Array = null) constructor	Arpeggiator
		fadeIn(time:Number):void Set fading in.	SoundObject
		fadeOut(time:Number):void Set fading out.	SoundObject
		play():void [override] start sequence	PatternSequencer
		reset():void Reset	SoundObject
		setVolume(slot:int, volume:Number):void Set volume by index.	SoundObject
		stop():void [override] stop sequence	PatternSequencer

Summary	Defined By
enterFrame	Dispatch in each frame in PatternSequencer.	Arpeggiator
enterSegment	Dispatch in each segment in PatternSequencer.	Arpeggiator
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

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

note

property

note:int[override]

change root note of the scale

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

noteLength

property

noteLength:Number

note length in 16th beat.

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

noteQuantize

property

noteQuantize:int

[NOT RECOMENDED] Only for the compatibility before version 0.58, the getTime property can be used instead of this property.

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

pattern

property

pattern:Array

Note index array of the arpeggio pattern. If the index is out of range, insert rest instead.

Implementation
public function get pattern():Array
public function set pattern(value:Array):void

scale

property

scale:Scale

scale instance

Implementation
public function get scale():Scale
public function set scale(value:Scale):void

scaleIndex

property

scaleIndex:int

index on scale

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

scaleName

property

scaleName:String

specify scale by name

Implementation
public function get scaleName():String
public function set scaleName(value:String):void

Constructor Detail

Arpeggiator

()

Constructor

public function Arpeggiator(scale:* = null, noteLength:Number = 2, pattern:Array = null)

constructor

Parameters

	`scale:*` (default = `null`) — Arpaggio scale, org.si.sion.utils.Scale instance, scale name String or null is suitable.

	`noteLength:Number` (default = `2`) — length for each note

	`pattern:Array` (default = `null`) — Note index array of the arpeggio pattern. If the index is out of range, insert rest instead.

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

Package	org.si.sound
Class	public class Arpeggiator
Inheritance	Arpeggiator PatternSequencer SoundObject flash.events.EventDispatcher

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

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