| Package | org.si.sound |
| Class | public class SoundObjectContainer |
| Inheritance | SoundObjectContainer  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 Track gate time (0:Minimum - 1:Maximum). | SoundObject | |
| 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 | |
| numChildren : int [read-only] Returns the number of children of this object. | SoundObjectContainer | ||
| 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 | |
| quantize : Number Synchronizing quantizing, uint in 16th beat. | SoundObject | |
| 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 | ||
|---|---|---|---|
SoundObjectContainer(name:String) constructor. | SoundObjectContainer | ||
Adds a child SoundObject instance to this SoundObjectContainer instance. | SoundObjectContainer | ||
Adds a child SoundObject instance to this SoundObjectContainer instance. | SoundObjectContainer | ||
| fadeIn(time:Number):void Set fading in. | SoundObject | |
| fadeOut(time:Number):void Set fading out. | SoundObject | |
getChildAt(index:int):SoundObject Returns the child sound object instance that exists at the specified index. | SoundObjectContainer | ||
getChildByName(name:String):SoundObject Returns the child sound object that exists with the specified name. | SoundObjectContainer | ||
getChildIndex(sound:SoundObject):Number Returns the index position of a child SoundObject instance. | SoundObjectContainer | ||
play():void [override] Play all children sound. | SoundObjectContainer | ||
Removes the specified child SoundObject instance from the child list of the SoundObjectContainer instance. | SoundObjectContainer | ||
removeChildAt(index:int):SoundObject Removes a child SoundObject from the specified index position in the child list of the SoundObjectContainer. | SoundObjectContainer | ||
reset():void [override] Reset | SoundObjectContainer | ||
Changes the position of an existing child in the sound object container. | SoundObjectContainer | ||
setVolume(slot:int, volume:Number):void [override] Set all children's volume by index. | SoundObjectContainer | ||
stop():void [override] Stop all children sound. | SoundObjectContainer | ||
| numChildren | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesnumChildren:int [read-only] Returns the number of children of this object.
public function get numChildren():int| SoundObjectContainer | () | Constructor |
public function SoundObjectContainer(name:String)constructor.
Parametersname:String |
| addChild | () | method |
public function addChild(sound:SoundObject):SoundObjectAdds a child SoundObject instance to this SoundObjectContainer instance. The added sound object will play sound during this container is playing. The child is added to the end of all other children in this SoundObjectContainer instance. (To add a child to a specific index position, use the addChildAt() method.) If you add a child object that already has a different sound object container as a parent, the object is removed from the child list of the other sound object container.
Parameters
sound:SoundObject — The SoundObject instance to add as a child of this SoundObjectContainer instance.
|
SoundObject — The SoundObject instance that you pass in the sound parameter
|
| addChildAt | () | method |
public function addChildAt(sound:SoundObject, index:int):SoundObjectAdds a child SoundObject instance to this SoundObjectContainer instance. The added sound object will play sound during this container is playing. The child is added at the index position specified. An index of 0 represents the head of the sound list for this SoundObjectContainer object.
Parameters
sound:SoundObject — The SoundObject instance to add as a child of this SoundObjectContainer instance.
| |
index:int — The index position to which the child is added. If you specify a currently occupied index position, the child object that exists at that position and all higher positions are moved up one position in the child list.
|
SoundObject — The child sound object at the specified index position.
|
| getChildAt | () | method |
public function getChildAt(index:int):SoundObjectReturns the child sound object instance that exists at the specified index.
Parameters
index:int — child index of the SoundObject to find.
|
SoundObject — founded SoundObject instance.
|
| getChildByName | () | method |
public function getChildByName(name:String):SoundObjectReturns the child sound object that exists with the specified name. If more than one child sound object has the specified name, the method returns the first object in the child list.
Parameters
name:String — child name of the SoundObject to find.
|
SoundObject — founded SoundObject instance. Returns null if its not found.
|
| getChildIndex | () | method |
public function getChildIndex(sound:SoundObject):NumberReturns the index position of a child SoundObject instance.
Parameters
sound:SoundObject — The SoundObject instance want to know.
|
Number — index of specifyed SoundObject. Returns -1 if its not found.
|
| play | () | method |
override public function play():voidPlay all children sound.
| removeChild | () | method |
public function removeChild(sound:SoundObject):SoundObjectRemoves the specified child SoundObject instance from the child list of the SoundObjectContainer instance. The removed sound object always stops. The parent property of the removed child is set to null, and the object is garbage collected if no other references to the child exist. The index positions of any sound objects after the child in the SoundObjectContainer are decreased by 1.
Parameters
sound:SoundObject — The DisplayObject instance to remove
|
SoundObject — The SoundObject instance that you pass in the sound parameter.
|
| removeChildAt | () | method |
public function removeChildAt(index:int):SoundObjectRemoves a child SoundObject from the specified index position in the child list of the SoundObjectContainer. The removed sound object always stops. The parent property of the removed child is set to null, and the object is garbage collected if no other references to the child exist. The index positions of any display objects above the child in the DisplayObjectContainer are decreased by 1.
Parameters
index:int — child index of the SoundObject to remove.
|
SoundObject — The SoundObject instance that was removed.
|
| reset | () | method |
override public function reset():voidReset
| setChildIndex | () | method |
public function setChildIndex(child:SoundObject, index:int):SoundObjectChanges the position of an existing child in the sound object container. This affects the processing order of child objects.
Parameters
child:SoundObject — The child SoundObject instance for which you want to change the index number.
| |
index:int — The resulting index number for the child sound object.
|
SoundObject |
| setVolume | () | method |
override public function setVolume(slot:int, volume:Number):voidSet all children's volume by index.
Parameters
slot:int — streaming slot number.
| |
volume:Number — volume (0:Minimum - 1:Maximum).
|
| stop | () | method |
override public function stop():voidStop all children sound.