| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../../override.css" type="text/css"><meta name="keywords" content="SoundEffectInstance,mx.effects.effectClasses.SoundEffectInstance,add,alphaFrom,alphaFrom,alphaFrom,alphaTo,alphaTo,alphaTo,angleFrom,angleTo,blurXFrom,blurXFrom,blurXTo,blurXTo,blurYFrom,blurYFrom,blurYTo,blurYTo,bufferTime,captureRollEvents,color,color,createMaskFunction,easingFunction,effectHost,effectMask,end,eventName,fromValue,heightBy,heightFrom,heightTo,hideChildrenTargets,index,inner,isLoading,isStyle,knockout,loops,moveEasingFunction,name,name,originX,originX,originY,originY,panEasingFunction,panFrom,panTo,playedAction,playheadTime,playheadTime,playheadTime,playheadTime,position,property,relativeTo,roundValue,scaleEasingFunction,scaleXFrom,scaleXTo,scaleYFrom,scaleYTo,show,showTarget,sound,soundChannel,source,start,startTime,strength,stripUnchangedValues,target,targetArea,targetArea,targetVisualBounds,toValue,tween,useDuration,value,value,volumeEasingFunction,volumeFrom,volumeTo,widthBy,widthFrom,widthTo,xBy,xFrom,xFrom,xTo,xTo,yBy,yFrom,yFrom,yTo,yTo,zoomHeightFrom,zoomHeightTo,zoomWidthFrom,zoomWidthTo"><title>mx.effects.effectClasses.SoundEffectInstance</title></head><body><script language="javascript" type="text/javascript" src="../../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../../help.js"></script><script language="javascript" type="text/javascript" src="../../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'SoundEffectInstance - ApacheFlex API Reference'; |
| var baseRef = '../../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../../package-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Packages</a> | <a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a> | <a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a> | <a id="framesLink1" href="../../../index.html?mx/effects/effectClasses/SoundEffectInstance.html&mx/effects/effectClasses/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">SoundEffectInstance</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("SoundEffectInstance"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.effects.effectClasses</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class SoundEffectInstance</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">SoundEffectInstance <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../../mx/effects/EffectInstance.html">EffectInstance</a> <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| The SoundEffectInstance class implements the instance class |
| for the SoundEffect effect. |
| Flex creates an instance of this class when it plays a SoundEffect effect; |
| you do not create one yourself. |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../../mx/effects/Fade.html" target="">mx.effects.Fade</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#bufferTime" class="signatureLink">bufferTime</a> : Number = 1000<div class="summaryTableDescription"> |
| The SoundEffect class uses an internal Sound object to control |
| the MP3 file.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#className" class="signatureLink">className</a> : String<div class="summaryTableDescription">[read-only] |
| The name of the effect class, such as "FadeInstance".</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#duration" class="signatureLink">duration</a> : Number<div class="summaryTableDescription"> |
| The duration of the effect, in milliseconds.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#effect" class="signatureLink">effect</a> : <a href="../../../mx/effects/IEffect.html">IEffect</a><div class="summaryTableDescription"> |
| The IEffect object that created this IEffectInstance object.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#effectTargetHost" class="signatureLink">effectTargetHost</a> : <a href="../../../mx/effects/IEffectTargetHost.html">IEffectTargetHost</a><div class="summaryTableDescription"> |
| A property that lets you access the target |
| list-based control of a data effect.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#hideFocusRing" class="signatureLink">hideFocusRing</a> : Boolean<div class="summaryTableDescription"> |
| Determines whether the effect should hide |
| the focus ring when starting the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#isLoading" class="signatureLink">isLoading</a> : Boolean<div class="summaryTableDescription">[read-only] |
| This property is true if the MP3 has been loaded.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#loops" class="signatureLink">loops</a> : int = 0<div class="summaryTableDescription"> |
| The number of times to play the sound in a loop, where a value of |
| 0 means play the effect once, a value of 1 means play the effect twice, |
| and so on.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#panEasingFunction" class="signatureLink">panEasingFunction</a> : Function<div class="summaryTableDescription"> |
| The easing function for the pan effect.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#panFrom" class="signatureLink">panFrom</a> : Number<div class="summaryTableDescription"> |
| Initial pan of the Sound object.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#panTo" class="signatureLink">panTo</a> : Number<div class="summaryTableDescription"> |
| Final pan of the Sound object.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#playheadTime" class="signatureLink">playheadTime</a> : Number<div class="summaryTableDescription"> |
| Current time position of the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#propertyChanges" class="signatureLink">propertyChanges</a> : <a href="../../../mx/effects/effectClasses/PropertyChanges.html">PropertyChanges</a><div class="summaryTableDescription"> |
| Specifies the PropertyChanges object containing |
| the start and end values for the set of properties |
| relevant to the effect's targets.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#repeatCount" class="signatureLink">repeatCount</a> : int<div class="summaryTableDescription"> |
| Number of times to repeat the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#repeatDelay" class="signatureLink">repeatDelay</a> : int<div class="summaryTableDescription"> |
| Amount of time, in milliseconds, |
| to wait before repeating the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#sound" class="signatureLink">sound</a> : Sound<div class="summaryTableDescription"> |
| Reference to the internal Sound object.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#soundChannel" class="signatureLink">soundChannel</a> : SoundChannel<div class="summaryTableDescription">[read-only] |
| The SoundChannel object that the MP3 file has been loaded into.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#source" class="signatureLink">source</a> : Object<div class="summaryTableDescription"> |
| The URL or class of the MP3 file to play.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#startDelay" class="signatureLink">startDelay</a> : int<div class="summaryTableDescription"> |
| Amount of time, in milliseconds, |
| to wait before starting the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#startTime" class="signatureLink">startTime</a> : Number = 0<div class="summaryTableDescription"> |
| The initial position in the MP3 file, in milliseconds, |
| at which playback should start.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#suspendBackgroundProcessing" class="signatureLink">suspendBackgroundProcessing</a> : Boolean<div class="summaryTableDescription"> |
| If true, blocks all background processing |
| while the effect is playing.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#target" class="signatureLink">target</a> : Object<div class="summaryTableDescription"> |
| The UIComponent object to which this effect is applied.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#triggerEvent" class="signatureLink">triggerEvent</a> : Event<div class="summaryTableDescription"> |
| The event, if any, which triggered the playing of the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#useDuration" class="signatureLink">useDuration</a> : Boolean = true<div class="summaryTableDescription"> |
| If true, stop the effect |
| after the time specified by the duration |
| property has elapsed.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#volumeEasingFunction" class="signatureLink">volumeEasingFunction</a> : Function<div class="summaryTableDescription"> |
| The easing function for the volume effect.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#volumeFrom" class="signatureLink">volumeFrom</a> : Number<div class="summaryTableDescription"> |
| Initial volume of the Sound object.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#volumeTo" class="signatureLink">volumeTo</a> : Number<div class="summaryTableDescription"> |
| Final volume of the Sound object.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><div class="showHideLinks"><div id="hideInheritedProtectedProperty" class="hideInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(false,'ProtectedProperty');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Protected Properties</a></div><div id="showInheritedProtectedProperty" class="showInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(true,'ProtectedProperty');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Protected Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProtectedProperty" id="summaryTableProtectedProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProtectedProperty"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../../mx/effects/EffectInstance.html#playCount" class="signatureLink">playCount</a> : int = 0<div class="summaryTableDescription"> |
| Number of times that the instance has been played.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../../images/collapsed.gif"> Show Inherited Public Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#SoundEffectInstance()" class="signatureLink">SoundEffectInstance</a>(target:Object)</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">SoundEffectInstance</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#end()" class="signatureLink">end</a>():void</div><div class="summaryTableDescription"> |
| Interrupts an effect instance that is currently playing, |
| and jumps immediately to the end of the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#finishEffect()" class="signatureLink">finishEffect</a>():void</div><div class="summaryTableDescription"> |
| Called by the end() method when the effect |
| finishes playing.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#finishRepeat()" class="signatureLink">finishRepeat</a>():void</div><div class="summaryTableDescription"> |
| Called after each iteration of a repeated effect finishes playing.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#initEffect()" class="signatureLink">initEffect</a>(event:Event):void</div><div class="summaryTableDescription"> |
| This method is called if the effect was triggered by the EffectManager.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#pause()" class="signatureLink">pause</a>():void</div><div class="summaryTableDescription"> |
| Pauses the effect until you call the resume() method.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#play()" class="signatureLink">play</a>():void</div><div class="summaryTableDescription"> |
| Plays the effect instance on the target.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#resume()" class="signatureLink">resume</a>():void</div><div class="summaryTableDescription"> |
| Resumes the effect after it has been paused |
| by a call to the pause() method.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#reverse()" class="signatureLink">reverse</a>():void</div><div class="summaryTableDescription"> |
| Plays the effect in reverse, starting from |
| the current position of the effect.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#startEffect()" class="signatureLink">startEffect</a>():void</div><div class="summaryTableDescription"> |
| Plays the effect instance on the target after the |
| startDelay period has elapsed.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"><img src="../../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../../mx/effects/EffectInstance.html#stop()" class="signatureLink">stop</a>():void</div><div class="summaryTableDescription"> |
| Stops the effect, leaving the target in its current state.</div></td><td class="summaryTableOwnerCol"><a href="../../../mx/effects/EffectInstance.html">EffectInstance</a></td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="bufferTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">bufferTime</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var bufferTime:Number = 1000</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The SoundEffect class uses an internal Sound object to control |
| the MP3 file. |
| This property specifies the minimum number of milliseconds |
| worth of sound data |
| to hold in the Sound object's buffer. |
| The Sound object waits until it has at least |
| this much data before beginning playback, |
| and before resuming playback after a network stall. |
| |
| </p><p> The default value is <code>1000</code>.</p></div><a name="propertyDetail"></a><a name="isLoading"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">isLoading</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>isLoading:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| This property is <code>true</code> if the MP3 has been loaded. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get isLoading():Boolean</code><br/></div><a name="propertyDetail"></a><a name="loops"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">loops</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var loops:int = 0</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The number of times to play the sound in a loop, where a value of |
| 0 means play the effect once, a value of 1 means play the effect twice, |
| and so on. If you repeat the MP3 file, it still uses the setting of the |
| <code>useDuration</code> property to determine the playback time. |
| <p>The <code>duration</code> property takes precedence |
| over this property. |
| If the effect duration is not long enough to play the sound at least once, |
| the sound does not loop.</p> |
| </p><p> The default value is <code>0</code>.</p></div><a name="propertyDetail"></a><a name="panEasingFunction"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">panEasingFunction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var panEasingFunction:Function</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The easing function for the pan effect. |
| This function is used to interpolate between the values |
| of <code>panFrom</code> and <code>panTo</code>. |
| |
| </p></div><a name="propertyDetail"></a><a name="panFrom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">panFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var panFrom:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Initial pan of the Sound object. |
| The value can range from -1.0 to 1.0, where -1.0 uses only the left channel, |
| 1.0 uses only the right channel, and 0.0 balances the sound evenly |
| between the two channels. |
| |
| </p><p> The default value is <code>0</code>.</p></div><a name="propertyDetail"></a><a name="panTo"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">panTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var panTo:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Final pan of the Sound object. |
| The value can range from -1.0 to 1.0, where -1.0 uses only the left channel, |
| 1.0 uses only the right channel, and 0.0 balances the sound evenly |
| between the two channels. |
| |
| </p><p> The default value is <code>0</code>.</p></div><a name="propertyDetail"></a><a name="sound"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">sound</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var sound:Sound</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Reference to the internal Sound object. The SoundEffect uses this |
| instance to play the MP3 file. |
| |
| </p></div><a name="propertyDetail"></a><a name="soundChannel"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">soundChannel</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>soundChannel:SoundChannel</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The SoundChannel object that the MP3 file has been loaded into. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get soundChannel():SoundChannel</code><br/></div><a name="propertyDetail"></a><a name="source"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">source</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>source:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The URL or class of the MP3 file to play. |
| If you have already embedded the MP3 file, using the |
| <code>Embed</code> keyword, you can pass the Class object |
| of the MP3 file to the <code>source</code> property. |
| Otherwise, specify the full URL to the MP3 file. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get source():Object</code><br/><code> public function set source(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="startTime"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">startTime</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var startTime:Number = 0</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The initial position in the MP3 file, in milliseconds, |
| at which playback should start. |
| </p><p> The default value is <code>0</code>.</p></div><a name="propertyDetail"></a><a name="useDuration"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">useDuration</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var useDuration:Boolean = true</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| If <code>true</code>, stop the effect |
| after the time specified by the <code>duration</code> |
| property has elapsed. |
| If <code>false</code>, stop the effect |
| after the MP3 finishes playing or looping. |
| |
| </p><p> The default value is <code>true</code>.</p></div><a name="propertyDetail"></a><a name="volumeEasingFunction"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">volumeEasingFunction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var volumeEasingFunction:Function</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The easing function for the volume effect. |
| Use this function to interpolate between the values |
| of <code>volumeFrom</code> and <code>volumeTo</code>. |
| |
| </p></div><a name="propertyDetail"></a><a name="volumeFrom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">volumeFrom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var volumeFrom:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Initial volume of the Sound object. |
| Value can range from 0.0 to 1.0. |
| |
| </p><p> The default value is <code>1.0</code>.</p></div><a name="propertyDetail"></a><a name="volumeTo"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">volumeTo</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var volumeTo:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Final volume of the Sound object. |
| Value can range from 0.0 to 1.0. |
| |
| </p><p> The default value is <code>1.0</code>.</p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="SoundEffectInstance()"></a><a name="SoundEffectInstance(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">SoundEffectInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function SoundEffectInstance(target:Object)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p> |
| Constructor. |
| </p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">target</span>:Object</code> — The Object to animate with this effect. |
| |
| </td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
