Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
mx.effects.effectClasses 

SoundEffectInstance  - AS3 Flex

Packagemx.effects.effectClasses
Classepublic class SoundEffectInstance
HéritageSoundEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object

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 SoundEffectInstance implémente la classe d’instances de l’effet SoundEffect. Flex crée une instance de cette classe lorsqu’un effet SoundEffect est exécuté. Vous ne devez pas la créer manuellement.

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
  bufferTime : Number = 1000
La classe SoundEffect utilise un objet Sound interne pour contrôler le fichier MP3.
SoundEffectInstance
 InheritedclassName : String
[lecture seule] Nom de la classe d’effet, tel que « FadeInstance ».
EffectInstance
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
 Inheritedduration : Number
Durée de l’effet, en millisecondes.
EffectInstance
 Inheritedeffect : IEffect
Objet IEffect qui a créé cet objet IEffectInstance.
EffectInstance
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
Propriété qui permet d’accéder au contrôle à base de liste de la cible d’un effet data.
EffectInstance
 InheritedhideFocusRing : Boolean
Détermine si l’effet doit masquer l’anneau de focus lors du démarrage.
EffectInstance
  isLoading : Boolean
[lecture seule] Cette propriété est définie sur true si le fichier MP3 a été chargé.
SoundEffectInstance
  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.
SoundEffectInstance
  panEasingFunction : Function
Fonction d’accélération de l’effet panoramique.
SoundEffectInstance
  panFrom : Number
Panoramique de départ de l’objet Sound.
SoundEffectInstance
  panTo : Number
Panoramique final de l’objet Sound.
SoundEffectInstance
 InheritedplayheadTime : Number
Temps de position actuelle de l’effet.
EffectInstance
 InheritedpropertyChanges : PropertyChanges
Spécifie l’objet PropertyChanges contenant les valeurs de départ et d’arrivée de l’ensemble des propriétés correspondant aux cibles de l’effet.
EffectInstance
 InheritedrepeatCount : int
Nombre de fois que l’effet doit être répété.
EffectInstance
 InheritedrepeatDelay : int
Intervalle (en millisecondes), qui s’écoule avant de répéter l’effet.
EffectInstance
  sound : Sound
Référence à l’objet Sound interne.
SoundEffectInstance
  soundChannel : SoundChannel
[lecture seule] Objet SoundChannel dans lequel le fichier MP3 a été chargé.
SoundEffectInstance
  source : Object
URL ou classe du fichier MP3 à lire.
SoundEffectInstance
 InheritedstartDelay : int
Intervalle (en millisecondes), qui s’écoule avant de commencer l’effet.
EffectInstance
  startTime : Number = 0
Position de départ dans le fichier MP3, en millisecondes, à laquelle la lecture doit démarrer.
SoundEffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
Si la valeur est true, elle bloque tout le traitement en arrière-plan pendant l’exécution de l’effet.
EffectInstance
 Inheritedtarget : Object
Objet UIComponent sur lequel cet effet est appliqué.
EffectInstance
 InheritedtriggerEvent : Event
L’événement, le cas échéant, qui a déclenché la lecture de l’effet.
EffectInstance
  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é.
SoundEffectInstance
  volumeEasingFunction : Function
Fonction d’accélération de l’effet du volume.
SoundEffectInstance
  volumeFrom : Number
Volume de départ de l’objet Sound.
SoundEffectInstance
  volumeTo : Number
Volume définitif de l’objet Sound.
SoundEffectInstance
Propriétés protégées
 PropriétéDéfini par
 InheritedplayCount : int = 0
Nombre de fois que l’instance a été exécutée.
EffectInstance
Méthodes publiques
 MéthodeDéfini par
  
Constructeur.
SoundEffectInstance
 Inherited
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
 Inherited
Distribue un événement dans le flux d’événements.
EventDispatcher
 Inherited
Interrompt une instance d’effet en cours de lecture et passe immédiatement à la fin de l’effet.
EffectInstance
 Inherited
Appelée par la méthode end() à la fin de la lecture de l’effet.
EffectInstance
 Inherited
Appelé à la fin de la lecture de chaque itération d’un effet répété.
EffectInstance
 Inherited
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.
EventDispatcher
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
Cette méthode est appelée si l’effet a été déclenché par le gestionnaire EffectManager.
EffectInstance
 Inherited
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
 Inherited
Interrompt momentanément l’effet jusqu’à un appel de la méthode resume().
EffectInstance
 Inherited
Exécute l’instance d’effet sur la cible.
EffectInstance
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l’objet EventDispatcher.
EventDispatcher
 Inherited
Reprend l’effet après une interruption demandée par un appel de la méthode pause().
EffectInstance
 Inherited
Exécute l’effet en sens inverse, à partir de sa position actuelle.
EffectInstance
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Exécute l’instance d’effet sur la cible, au terme de la période startDelay.
EffectInstance
 Inherited
Arrête l’effet, en laissant la cible dans son état actuel.
EffectInstance
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
 Inherited
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énements
 Evénement Synthèse Défini par
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.EventDispatcher
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.EventDispatcher
Détails de la propriété

bufferTime

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é 
isLoading:Boolean  [lecture seule]

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Cette propriété est définie sur true si le fichier MP3 a été chargé.



Implémentation
    public function get isLoading():Boolean

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 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.

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.

sound

propriété 
public var sound:Sound

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Référence à l’objet Sound interne. La classe SoundEffect utilise cette instance pour lire le fichier MP3.

soundChannel

propriété 
soundChannel:SoundChannel  [lecture seule]

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Objet SoundChannel dans lequel le fichier MP3 a été chargé.



Implémentation
    public function get soundChannel():SoundChannel

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

startTime

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 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.0.

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.0.

Détails du constructeur

SoundEffectInstance

()Constructeur
public function SoundEffectInstance(target:Object)

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Constructeur.

Paramètres
target:Object — Objet à animer à l’aide de cet effet.




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.