| Package | mx.effects |
| Classe | public class SoundEffect |
| Héritage | SoundEffect  Effect EventDispatcher Object |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Vous pouvez spécifier le fichier MP3 à l’aide de la propriété source. Si vous avez déjà incorporé le fichier MP3, vous pouvez, à l’aide du mot de passe Embed, transmettre l’objet Class du fichier MP3 à la propriété source. Sinon, spécifiez l’URL intégral du fichier MP3.
Afficher la syntaxe MXML
Masquer la syntaxe MXMLThe <mx:SoundEffect> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:SoundEffect
Properties
id="ID"
autoLoad="true|false"
bufferTime="1000"
loops="0"
panEasingFunction=""
panFrom="0"
source=""
startTime="0"
useDuration="true|false"
volumeEasingFunction="true|false"
volumeTo="1"
Events
complete="No default"
id3="No default"
ioError="No default"
progress="No default"
/>
Eléments de l’API associés
| Propriété | Défini par | ||
|---|---|---|---|
| autoLoad : Boolean
Si la valeur est true, chargez le fichier MP3 lorsque la source a été spécifiée. | SoundEffect | ||
| bufferTime : Number = 1000
La classe SoundEffect utilise un objet Sound interne pour contrôler le fichier MP3. | SoundEffect | ||
 | className : String [lecture seule]
Le nom de la classe d’effet, tel que « Fade ». | Effect | |
| constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| customFilter : mx.effects:EffectTargetFilter
Spécifie un objet filtre personnalisé, de type EffectTargetFilter, utilisé par l’effet pour déterminer les cibles sur lequel lire l’effet. | Effect | |
| duration : Number
Durée de l’effet en millisecondes. | Effect | |
| effectTargetHost : mx.effects:IEffectTargetHost
Propriété qui permet d’accéder au contrôle à base de liste de la cible d’un effet data. | Effect | |
| filter : String
Spécifie un algorithme de filtrage des cibles d’un effet. | Effect | |
| hideFocusRing : Boolean
Détermine si l’effet doit masquer l’anneau de focus lors du démarrage. | Effect | |
| instanceClass : Class
Objet de type Class qui spécifie la classe de l’instance d’effet de cette classe d’effets. | Effect | |
| isLoading : Boolean [lecture seule]
Cette propriété est définie sur true si le fichier MP3 a été chargé. | SoundEffect | ||
| isPlaying : Boolean [lecture seule]
Indicateur de lecture seule défini sur true si les instances de l’effet sont en cours de lecture et sur false si aucune instance n’est définie. | Effect | |
| loops : int = 0
Fréquence de lecture du son dans une boucle, où la valeur 0 signifie exécuter l’effet une fois, la valeur 1 signifie exécuter l’effet deux fois, etc. | SoundEffect | ||
| panEasingFunction : Function
Fonction d’accélération de l’effet panoramique. | SoundEffect | ||
| panFrom : Number
Panoramique de départ de l’objet Sound. | SoundEffect | ||
| panTo : Number
Panoramique final de l’objet Sound. | SoundEffect | ||
| perElementOffset : Number
Autre délai, en millisecondes, pour les cibles d’effet suivant la première cible de l’effet. | Effect | |
| playheadTime : Number
Temps de position actuelle de l’effet. | Effect | |
| relevantProperties : Array
Tableau de noms de propriété à utiliser pour effectuer le filtrage. | Effect | |
| relevantStyles : Array
Tableau des noms de style à utiliser pour effectuer le filtrage. | Effect | |
| repeatCount : int = 1
Nombre de fois que l’effet doit être répété. | Effect | |
| repeatDelay : int = 0
Intervalle (en millisecondes), qui s’écoule avant de répéter l’effet. | Effect | |
| sound : Sound [lecture seule]
Objet Sound dans lequel le fichier MP3 a été chargé. | SoundEffect | ||
| source : Object
URL ou classe du fichier MP3 à lire. | SoundEffect | ||
| startDelay : int = 0
Intervalle (en millisecondes), qui s’écoule avant de commencer l’effet. | Effect | |
| startTime : Number = 0
Position de départ dans le fichier MP3, en millisecondes, à laquelle la lecture doit démarrer. | SoundEffect | ||
| suspendBackgroundProcessing : Boolean = false
Si la valeur est true, elle bloque tout le traitement en arrière-plan pendant l’exécution de l’effet. | Effect | |
| target : Object
Objet auquel s’applique cet effet. | Effect | |
| targets : Array
Tableau d’objets représentant des cibles de l’effet. | Effect | |
| triggerEvent : Event
Objet Evénement transmis à cet Effet par le gestionnaire EffectManager lorsqu’un effet est déclenché, ou nul si l’effet n’est pas exécuté par le gestionnaire EffectManager. | Effect | |
| useDuration : Boolean = true
Si la valeur est true, arrêtez l’effet à la fin du délai spécifié par la propriété duration a écoulé. | SoundEffect | ||
| volumeEasingFunction : Function
Fonction d’accélération de l’effet du volume. | SoundEffect | ||
| volumeFrom : Number
Volume de départ de l’objet Sound. | SoundEffect | ||
| volumeTo : Number
Volume définitif de l’objet Sound. | SoundEffect | ||
| Méthode | Défini par | ||
|---|---|---|---|
SoundEffect(target:Object = null)
Constructeur. | SoundEffect | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | |
|
Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet et les enregistre en tant que valeurs d’arrivée. | Effect | |
|
Capture les valeurs actuelles des propriétés correspondantes d’un autre ensemble de cibles. Flex utilise cette fonction lorsqu’un effet de modifications de données est exécuté.
| Effect | |
|
Capture les valeurs actuelles des propriétés correspondantes sur les cibles de l’effet. | Effect | |
|
Crée une seule instance d’effet et l’initialise. | Effect | |
|
Prend un tableau d’objets cible et invoque la méthode createInstance() sur chaque cible. | Effect | |
|
Supprime les écouteurs d’événement d’une instance et les retire de la liste d’instances. | Effect | |
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
|
Interrompt un effet en cours de lecture et passe immédiatement à la fin de l’effet. | Effect | |
|
Renvoie un tableau de chaînes, où chaque chaîne correspond au nom d’une propriété modifiée par cet effet. | Effect | |
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
|
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | |
Charge le fichier MP3 si la propriété source indique une URL. | SoundEffect | ||
|
Interrompt momentanément l’effet jusqu’à un appel de la méthode resume(). | Effect | |
|
Commence la lecture de l’effet. | Effect | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
|
Reprend l’effet après une interruption demandée par un appel de la méthode pause(). | Effect | |
|
Exécute l’effet en sens inverse, si l’effet est en cours de lecture, à partir de sa position actuelle. | Effect | |
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Arrête l’effet, en laissant les cibles de l’effet dans leur état actuel. | Effect | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
|
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher | |
| Evénement | Synthèse | Défini par | ||
|---|---|---|---|---|
| [Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active. | EventDispatcher | ||
| Envoyé lorsque le fichier audio termine son chargement. | SoundEffect | |||
| [Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive. | EventDispatcher | ||
| Distribué lorsque la lecture de l’une des instances de l’effet s’arrête, soit lorsque la lecture de l’instance s’arrête, soit lorsque l’effet est interrompu par un appel de la méthode end(). | Effect | ||
| Diffusé lorsque l’exécution de l’effet commence. | Effect | ||
| Distribué lorsque l’effet a été interrompu, ce qui se produit uniquement lorsque l’effet est interrompu par un appel de la méthode stop(). | Effect | ||
| Envoyé lorsque les données ID3 sont disponibles pour un fichier audio MP3. | SoundEffect | |||
| Distribué lorsqu’une erreur se produit pendant le chargement du fichier audio. | SoundEffect | |||
| Distribué périodiquement au fur et à mesure que le fichier son charge. | SoundEffect | |||
autoLoad | propriété |
autoLoad:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Si la valeur est true, chargez le fichier MP3 lorsque la source a été spécifiée.
La valeur par défaut est true.
Implémentation
public function get autoLoad():Boolean public function set autoLoad(value:Boolean):voidbufferTime | propriété |
public var bufferTime:Number = 1000| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
La classe SoundEffect utilise un objet interne Sound pour contrôler le fichier MP3. Cette propriété spécifie le nombre minimum de millisecondes nécessaires pour que les données audio soient conservées dans la mémoire tampon de l’objet Sound. Celui-ci attend de disposer au moins de cette quantité de données avant de commencer la lecture ou avant de reprendre la lecture après une interruption réseau.
La valeur par défaut est 1000.
isLoading | propriété |
loops | propriété |
public var loops:int = 0| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fréquence de lecture du son dans une boucle, où la valeur 0 signifie exécuter l’effet une fois, la valeur 1 signifie exécuter l’effet deux fois, etc. Si vous répétez le fichier MP3, il continue d’utiliser le paramètre de la propriété useDuration pour déterminer le temps de lecture.
La propriété duration est prioritaire sur cette propriété. Si la durée de l’effet n’est pas assez longue pour lire le son au moins une fois, aucun son n’est mis en boucle.
La valeur par défaut est 0.
panEasingFunction | propriété |
public var panEasingFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fonction d’accélération pour l’effet panoramique. Cette fonction permet d’interpoler entre les valeurs des propriétés panFrom et panTo.
panFrom | propriété |
public var panFrom:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Panoramique initial de l’objet Sound. Cette valeur peut être comprise entre -1.0 et 1.0, où -1.0 utilise uniquement le canal gauche, 1.0 utilise uniquement le canal droit et 0.0 équilibre le son entre les deux canaux.
La valeur par défaut est 0.0.
panTo | propriété |
public var panTo:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Panoramique final de l’objet Sound. Cette valeur peut être comprise entre -1.0 et 1.0, où -1.0 utilise uniquement le canal gauche, 1.0 utilise uniquement le canal droit et 0.0 équilibre le son entre les deux canaux.
La valeur par défaut est 0.0.
sound | propriété |
source | propriété |
source:Object| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
URL ou classe du fichier MP3 à lire. Si vous avez déjà incorporé le fichier MP3, vous pouvez, à l’aide du mot de passe Embed, transmettre l’objet Class du fichier MP3 à la propriété source. Sinon, spécifiez l’URL intégral du fichier MP3.
Implémentation
public function get source():Object public function set source(value:Object):voidstartTime | propriété |
public var startTime:Number = 0| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Position de départ dans le fichier MP3, en millisecondes, à laquelle la lecture doit démarrer.
La valeur par défaut est 0.
useDuration | propriété |
public var useDuration:Boolean = true| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Si la valeur est true, arrêtez l’effet à la fin du délai spécifié par la propriété duration Si la valeur estfalse, arrêtez l’effet dès que le MP3 termine sa lecture ou sa mise en boucle.
La valeur par défaut est true.
volumeEasingFunction | propriété |
public var volumeEasingFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fonction d’accélération de l’effet volume. Cette fonction permet d’interpoler entre les valeurs des propriétés volumeFrom et volumeTo.
volumeFrom | propriété |
public var volumeFrom:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Volume initial de l’objet Sound. La valeur peut être comprise entre 0.0 et 1.0.
La valeur par défaut est 1.
volumeTo | propriété |
public var volumeTo:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Volume définitif de l’objet Sound. La valeur peut être comprise entre 0.0 et 1.0.
La valeur par défaut est 1.
SoundEffect | () | Constructeur |
load | () | méthode |
public function load():void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Charge le fichier MP3 si la propriété source indique une URL.
complete | Evénement |
flash.events.Eventpropriété Event.type =
flash.events.Event.COMPLETE| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Envoyé lorsque le fichier audio termine son chargement.
La constanteEvent.COMPLETE définit la valeur de la propriété type d’un objet événement complete.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | Objet réseau dont le chargement est terminé. |
id3 | Evénement |
flash.events.Eventpropriété Event.type =
flash.events.Event.ID3| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Envoyé lorsque les données ID3 sont disponibles pour un fichier audio MP3.
La constanteEvent.ID3 définit la valeur de la propriété type d’un objet événement id3.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | Objet son chargeant le fichier MP3 pour lequel les données ID3 sont maintenant disponibles. La propriété target ne correspond pas toujours à l’objet de la liste d’affichage qui est associé à l’écouteur d’événement. Utilisez la propriété currentTarget pour accéder à l’objet de la liste d’affichage qui traite actuellement l’événement. |
ioError | Evénement |
flash.events.IOErrorEventpropriété IOErrorEvent.type =
flash.events.IOErrorEvent.IO_ERROR| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Distribué lorsqu’une erreur se produit pendant le chargement du fichier audio.
Définit la valeur de la propriététype d’un objet d’événement ioError.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
errorID | Un numéro de référence associé à l’erreur spécifique (AIR uniquement). |
target | Objet réseau sur lequel l’erreur d’entrée/sortie s’est produite. |
text | Texte à afficher en tant que message d’erreur. |
progress | Evénement |
flash.events.ProgressEventpropriété ProgressEvent.type =
flash.events.ProgressEvent.PROGRESS| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Distribué périodiquement au fur et à mesure que le fichier son charge.
Dans l’objet d’événement, vous pouvez accéder au nombre d’octets actuellement chargés et au nombre total d’octets à charger. L’événement n’est pas assuré d’être distribué, ce qui signifie que l’événement complete peut être distribué sans que les événements progress soient distribués.
type d’un objet événement progress.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
bytesLoaded | Nombre d’éléments ou d’octets chargés lors du traitement de l’événement par l’écouteur. |
bytesTotal | Nombre total d’éléments ou d’octets qui seront chargés si le processus de chargement aboutit. |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | Objet indiquant la progression. |
<?xml version="1.0"?>
<!-- Simple example to demonstrate the SoundEffect effect. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Declarations>
<mx:SoundEffect id="mySounds" source="@Embed(source='assets/jazz.mp3')"/>
</fx:Declarations>
<s:Panel title="Sound Effect Example" width="75%" height="75%" >
<s:VGroup left="20" right="20" top="20" bottom="20">
<s:Label width="100%" color="blue"
text="Click on the phone to hear the sound effect."/>
<mx:Image id="flex" source="@Embed(source='assets/Nokia_6630.png')"
mouseDownEffect="{mySounds}"/>
</s:VGroup>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 09:30 AM Z