| Package | org.si.sound |
| Class | public class FlashSoundPlayer |
| Inheritance | FlashSoundPlayer PatternSequencer SoundObject flash.events.EventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
![]() | 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 [override] [read-only] is playing ? | FlashSoundPlayer | ||
| isSoundDataAvailable : Boolean [read-only] is sound data available to play ? | FlashSoundPlayer | ||
![]() | 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] current note in the sequence, you cannot change this property. | PatternSequencer | |
![]() | noteOffTriggerType : int [read-only] Track note off trigger type | SoundObject | |
![]() | noteOnTriggerType : int [read-only] Track note on trigger type | SoundObject | |
![]() | 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 | |
![]() | 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 | |
![]() | sequencer : Sequencer [read-only] the Sequencer instance belonging to this PatternSequencer, where the sequence pattern appears. | PatternSequencer | |
| soundData : Sound the Sequencer instance belonging to this PatternSequencer, where the sequence pattern appears. | FlashSoundPlayer | ||
| synthesizer : VoiceReference [override] Synthesizer to generate sound, You cannot change the synthesizer of this sound object | FlashSoundPlayer | ||
![]() | trackID : int [read-only] Track id | SoundObject | |
| voice : SiONVoice [override] Voice data to play, You cannot change the voice of this sound object. | FlashSoundPlayer | ||
![]() | volume : Number Channel volume (0:Minimum - 1:Maximum), this property can control track after play(). | SoundObject | |
| Method | Defined By | ||
|---|---|---|---|
FlashSoundPlayer(soundData:Sound = null) constructor
| FlashSoundPlayer | ||
![]() | fadeIn(time:Number):void Set fading in. | SoundObject | |
![]() | fadeOut(time:Number):void Set fading out. | SoundObject | |
play():void [override] start sequence | FlashSoundPlayer | ||
![]() | reset():void Reset | SoundObject | |
setSoundData(sound:Sound, keyRangeFrom:int = 0, keyRangeTo:int = 127, startPoint:int = 0, endPoint:int = -1, loopPoint:int = -1):void Set flash sound instance with key range. | FlashSoundPlayer | ||
![]() | setVolume(slot:int, volume:Number):void Set volume by index. | SoundObject | |
stop():void [override] stop sequence | FlashSoundPlayer | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| FlashSoundPlayer | ||||
| FlashSoundPlayer | ||||
| FlashSoundPlayer | ||||
![]() | Dispatch when the sound ends. | SoundObject | ||
![]() | Dispatch when the note off appears in the sequence. | SoundObject | ||
![]() | Dispatch when the sound starts. | SoundObject | ||
![]() | Dispatch when the note on appears. | SoundObject | ||
| FlashSoundPlayer | ||||
| FlashSoundPlayer | ||||
| isPlaying | property |
isPlaying:Boolean [read-only] [override] is playing ?
public function get isPlaying():Boolean| isSoundDataAvailable | property |
isSoundDataAvailable:Boolean [read-only] is sound data available to play ?
public function get isSoundDataAvailable():Boolean| soundData | property |
soundData:Soundthe Sequencer instance belonging to this PatternSequencer, where the sequence pattern appears.
public function get soundData():Sound public function set soundData(value:Sound):void| synthesizer | property |
synthesizer:VoiceReference[override] Synthesizer to generate sound, You cannot change the synthesizer of this sound object
public function get synthesizer():VoiceReference public function set synthesizer(value:VoiceReference):void| voice | property |
voice:SiONVoice[override] Voice data to play, You cannot change the voice of this sound object.
public function get voice():SiONVoice public function set voice(value:SiONVoice):void| FlashSoundPlayer | () | Constructor |
public function FlashSoundPlayer(soundData:Sound = null)constructor
ParameterssoundData:Sound (default = null) — flash.media.Sound instance to control.
|
| play | () | method |
override public function play():voidstart sequence
| setSoundData | () | method |
public function setSoundData(sound:Sound, keyRangeFrom:int = 0, keyRangeTo:int = 127, startPoint:int = 0, endPoint:int = -1, loopPoint:int = -1):voidSet flash sound instance with key range.
Parameters
sound:Sound — Sound instance to assign
| |
keyRangeFrom:int (default = 0) — Assigning key range starts from
| |
keyRangeTo:int (default = 127) — Assigning key range ends at. -1 to set only at the key of argument "keyRangeFrom".
| |
startPoint:int (default = 0) — slicing point to start data.
| |
endPoint:int (default = -1) — slicing point to end data. The negative value plays whole data.
| |
loopPoint:int (default = -1) — slicing point to repeat data. -1 means no repeat
|
| stop | () | method |
override public function stop():voidstop sequence
| fspComplete | Event |
org.si.sound.events.FlashSoundPlayerEventflash.events.Event
| id3 | Event |
flash.events.Eventflash.events.Event
| ioError | Event |
flash.events.IOErrorEventflash.events.IOErrorEvent
| open | Event |
flash.events.Eventflash.events.Event
| progress | Event |
flash.events.ProgressEventflash.events.ProgressEvent