Packageorg.si.sound
Classpublic class FlashSoundPlayer
InheritanceFlashSoundPlayer Inheritance PatternSequencer Inheritance SoundObject Inheritance flash.events.EventDispatcher

FlashSoundPlayer provides advanced operations of Sound class (in flash media package).



Public Properties
 PropertyDefined By
 InheritedcoarseTune : int
Master coarse tuning, 1 for half-tone.
SoundObject
 Inheriteddelay : Number
Sound delay, uint in 16th beat.
SoundObject
 Inheriteddriver : SiONDriver
[read-only] SiONDriver instrance to operate.
SoundObject
 Inheritedeffectors : Array
Array of SiEffectBase to modify this sound object's output.
SoundObject
 InheritedeffectSend1 : Number
Channel effect send level for slot 1 (0:Minimum - 1:Maximum), this property can control track after play().
SoundObject
 InheritedeffectSend2 : Number
Channel effect send level for slot 2 (0:Minimum - 1:Maximum), this property can control track after play().
SoundObject
 InheritedeffectSend3 : Number
Channel effect send level for slot 3 (0:Minimum - 1:Maximum), this property can control track after play().
SoundObject
 InheritedeffectSend4 : Number
Channel effect send level for slot 4 (0:Minimum - 1:Maximum), this property can control track after play().
SoundObject
 InheritedeventMask : int
Track event mask.
SoundObject
 InheritedeventTriggerID : int
Track event trigger ID
SoundObject
 InheritedfineTune : Number
Master fine tuning, 1 for half-tone, you can specify fineTune<-1 or fineTune>1.
SoundObject
 InheritedgateTime : 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
 Inheritedlength : Number
[override] current length in the sequence, you cannot change this property.
PatternSequencer
 Inheritedmute : Boolean
Channel mute, this property can control track after play().
SoundObject
 Inheritedname : String
Name.
SoundObject
 Inheritednote : int
[override] current note in the sequence, you cannot change this property.
PatternSequencer
 InheritednoteOffTriggerType : int
[read-only] Track note off trigger type
SoundObject
 InheritednoteOnTriggerType : int
[read-only] Track note on trigger type
SoundObject
 InheritedonEnterFrame : Function
callback on enter frame
PatternSequencer
 InheritedonEnterSegment : Function
callback on enter segment
PatternSequencer
 InheritedonExitFrame : Function
callback on exit frame
PatternSequencer
 Inheritedpan : Number
Channel panning (-1:Left - 0:Center - +1:Right), this property can control track after play().
SoundObject
 Inheritedparent : SoundObjectContainer
[read-only] parent container.
SoundObject
 InheritedpitchBend : Number
Channel pitch bend, 1 for halftone, this property can control track after play().
SoundObject
 Inheritedportament : int
portament
PatternSequencer
 Inheritedquantize : Number
Synchronizing quantizing, uint in 16th beat.
SoundObject
 Inheritedsequencer : 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
 InheritedtrackID : int
[read-only] Track id
SoundObject
  voice : SiONVoice
[override] Voice data to play, You cannot change the voice of this sound object.
FlashSoundPlayer
 Inheritedvolume : Number
Channel volume (0:Minimum - 1:Maximum), this property can control track after play().
SoundObject
Public Methods
 MethodDefined By
  
FlashSoundPlayer(soundData:Sound = null)
constructor
FlashSoundPlayer
 Inherited
fadeIn(time:Number):void
Set fading in.
SoundObject
 Inherited
fadeOut(time:Number):void
Set fading out.
SoundObject
  
play():void
[override] start sequence
FlashSoundPlayer
 Inherited
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
 Inherited
setVolume(slot:int, volume:Number):void
Set volume by index.
SoundObject
  
stop():void
[override] stop sequence
FlashSoundPlayer
Events
 Event Summary Defined By
  FlashSoundPlayer
  FlashSoundPlayer
  FlashSoundPlayer
 Inherited Dispatch when the sound ends.SoundObject
 Inherited Dispatch when the note off appears in the sequence.SoundObject
 Inherited Dispatch when the sound starts.SoundObject
 Inherited Dispatch when the note on appears.SoundObject
  FlashSoundPlayer
  FlashSoundPlayer
Property Detail
isPlayingproperty
isPlaying:Boolean  [read-only] [override]

is playing ?


Implementation
    public function get isPlaying():Boolean
isSoundDataAvailableproperty 
isSoundDataAvailable:Boolean  [read-only]

is sound data available to play ?


Implementation
    public function get isSoundDataAvailable():Boolean
soundDataproperty 
soundData:Sound

the Sequencer instance belonging to this PatternSequencer, where the sequence pattern appears.


Implementation
    public function get soundData():Sound
    public function set soundData(value:Sound):void
synthesizerproperty 
synthesizer:VoiceReference[override]

Synthesizer to generate sound, You cannot change the synthesizer of this sound object


Implementation
    public function get synthesizer():VoiceReference
    public function set synthesizer(value:VoiceReference):void
voiceproperty 
voice:SiONVoice[override]

Voice data to play, You cannot change the voice of this sound object.


Implementation
    public function get voice():SiONVoice
    public function set voice(value:SiONVoice):void
Constructor Detail
FlashSoundPlayer()Constructor
public function FlashSoundPlayer(soundData:Sound = null)

constructor

Parameters
soundData:Sound (default = null) — flash.media.Sound instance to control.
Method Detail
play()method
override public function play():void

start sequence

setSoundData()method 
public function 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.

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():void

stop sequence

Event Detail
fspComplete Event
Event Object Type: org.si.sound.events.FlashSoundPlayerEvent
FlashSoundPlayerEvent.type property = flash.events.Event

id3 Event  
Event Object Type: flash.events.Event
Event.type property = flash.events.Event

ioError Event  
Event Object Type: flash.events.IOErrorEvent
IOErrorEvent.type property = flash.events.IOErrorEvent

open Event  
Event Object Type: flash.events.Event
Event.type property = flash.events.Event

progress Event  
Event Object Type: flash.events.ProgressEvent
ProgressEvent.type property = flash.events.ProgressEvent