Packageatom.helium.media
Classpublic class HeAudio
InheritanceHeAudio Inheritance Object

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 13

Archivage, gestion et lancement d'audios et éléments sonores. Les audios peuvent avoir différents paramètres comme des fadeIn/fadeOut, des callback, des enchaînements, etc. De plus, comme chaque audio lui est rattaché, il permet de les interrompre ou de changer leur volume alors qu'ils sont en court de lecture.


Public Properties
 PropertyDefined By
  debugMode : Boolean
[static] [write-only] Détection des erreurs
HeAudio
  listFadeIn : Object
[static] [read-only] Liste des audios en court de transition de volume
HeAudio
  listFadeOut : Object
[static] [read-only]
HeAudio
  listGroups : Array
[static] [read-only] Liste des noms des groupes
HeAudio
  numberFadeIn : int = 0
[static] Nombre d'audios en FadeIn
HeAudio
  numberFadeOut : int = 0
[static] Nombre d'audios en FadeOut
HeAudio
  pathInit : String
[static] Chemin standard initial d'où partent chaque autres chemins
HeAudio
  volume : Number
[static] Volume
HeAudio
Public Methods
 MethodDefined By
  
HeAudio()
Initialisation Inutile pour ce script
HeAudio
  
add(name:String, group:String, path:*, value:Object = null, param:Object = null):Boolean
[static] Créait et archive un nouvel audio.
HeAudio
  
addEventLoadComplete(call:*):void
[static] Applique une fonction de fin de chargement des audios Cette fonction est nettoyée après être provoquée
HeAudio
  
addEventLoadProgress(call:*):void
[static] addEventLoadProgress Applique une fonction d'avancement de chargement des audios Cette fonction est nettoyée à la fin du chargement
HeAudio
  
addGroup(name:String, value:Object = null, param:Object = null):Boolean
[static] Créait un groupe d'archivage d'audio.
HeAudio
  
addNoise(name:String, group:String, ... list):Boolean
[static] Créait un audio aléatoire.
HeAudio
  
addNoiseGroup(name:String):Boolean
[static] Créait un groupe d'audio aléatoires.
HeAudio
  
applyVolume():void
[static] Réapplique les volumes à chaque audio de chaque groupe
HeAudio
  
defineGlobalLoop():void
[static] Calibre la boucle générale
HeAudio
  
getAudio(name:String, group:String):HeSound
[static] getAudio Récupère l'instance d'un object d'audio pour le lire ou modifier ses paramètres ou valeurs.
HeAudio
  
getGroup(name:String):HeSoundGroup
[static] Récupère l'instance d'un objet groupe pour le lire ou modifier ses paramètres ou valeurs.
HeAudio
  
play(name:String, group:String, value:Object = null, param:Object = null):void
[static] Joue un audio archivé.
HeAudio
  
playNoise(name:String, group:String):void
[static] Joue un audio aléatoire.
HeAudio
  
remove(name:String, group:String):Boolean
[static] Supprime un audio archivé.
HeAudio
  
removeGlobalLoop():void
[static] Retire la boucle générale
HeAudio
  
removeGroup(group:String):Boolean
[static] Supprime un groupe et chacun de ses audios archivés.
HeAudio
  
removeNoise(name:String, group:String):Boolean
[static] Supprime un audio aléatoire.
HeAudio
  
stop(name:String, group:String, param:Object = null):void
[static] Interrompt un audio précédemment lancé.
HeAudio
  
stopGroup(group:String, param:Object = null):void
[static] Interrompt tout les un audios d'un groupe.
HeAudio
Property Detail
debugModeproperty
debugMode:Boolean  [write-only]

Détection des erreurs


Implementation
    public static function set debugMode(value:Boolean):void
listFadeInproperty 
listFadeIn:Object  [read-only]

Liste des audios en court de transition de volume


Implementation
    public static function get listFadeIn():Object
listFadeOutproperty 
listFadeOut:Object  [read-only]


Implementation
    public static function get listFadeOut():Object
listGroupsproperty 
listGroups:Array  [read-only]

Liste des noms des groupes


Implementation
    public static function get listGroups():Array
numberFadeInproperty 
public static var numberFadeIn:int = 0

Nombre d'audios en FadeIn

numberFadeOutproperty 
public static var numberFadeOut:int = 0

Nombre d'audios en FadeOut

pathInitproperty 
public static var pathInit:String

Chemin standard initial d'où partent chaque autres chemins

volumeproperty 
volume:Number

Volume


Implementation
    public static function get volume():Number
    public static function set volume(value:Number):void
Constructor Detail
HeAudio()Constructor
public function HeAudio()

Initialisation Inutile pour ce script

Method Detail
add()method
public static function add(name:String, group:String, path:*, value:Object = null, param:Object = null):Boolean

Créait et archive un nouvel audio.

Parameters

name:String — Le nom de l'audio dans son groupe
 
group:String — Le nom du groupe qui va récupérer l'audio
 
path:* — Le lien de l'audio
  • Si c'est une Class - Récupère l'audio par sa class en Interne
  • Si c'est un String - Charge l'audio par le lien String en Externe
 
value:Object (default = null) — Valeur additives à transmettre au groupe Contrairement aux paramètres, les valeurs se complètent entre celles du groupe, des audio qu'il contient, etc.
  • ( Number ) volume = 100 - Le pourcentage de volume appliqué sur chaque audio
 
param:Object (default = null) — Parametres additifs à transmettre à l'audio
  • ( int ) stack = 50 - Le nombre d'audio issue d'un même fichier jouables au même moment
  • ( int ) loop = 0 - Le nombre de fois où l'audio est rejoué ( -1 pour boucle infinie )
  • ( Number ) position = 0 - Position de l'audio à son lancement
  • ( Number ) fadeIn = 0 - Temps au lancement de l'audio durant lequel le volume va croître progressivement
  • ( Number ) fadeOut = 0 - Temps avant la fin de l'audio durant lequel le volume va décroître progressivement
  • ( Array ) amalgam - Ensemble d'objets aux clés "group,name,param" qui sont des audios lancés à la fin de celui-ci
  • ( Function ou HeFunction ) callPlay - La fonction provoquée quand l'audio est joué
  • ( Function ou HeFunction ) callLoop - La fonction provoquée pendant que l'audio est joué
  • ( Function ou HeFunction ) callStop - La fonction provoquée quand l'audio est interrompue
  • ( Function ou HeFunction ) callEnd - La fonction provoquée quand l'audio arrive à son terme

Returns
Boolean — true Si l'audio n'existait pas déjà false Si l'audio existait déjà
addEventLoadComplete()method 
public static function addEventLoadComplete(call:*):void

Applique une fonction de fin de chargement des audios Cette fonction est nettoyée après être provoquée

Parameters

call:* — Fonction ou HeFonction a provoquer

addEventLoadProgress()method 
public static function addEventLoadProgress(call:*):void

addEventLoadProgress Applique une fonction d'avancement de chargement des audios Cette fonction est nettoyée à la fin du chargement

Parameters

call:* — Fonction ou HeFonction a provoquer

addGroup()method 
public static function addGroup(name:String, value:Object = null, param:Object = null):Boolean

Créait un groupe d'archivage d'audio.

Parameters

name:String — Le nom du groupe
 
value:Object (default = null) — Valeur additives à transmettre au groupe Contrairement aux paramètres, les valeurs se complètent entre celles du groupe, des audio qu'il contient, etc.
  • ( Number ) volume = 100 - Le pourcentage de volume appliqué sur chaque audio
 
param:Object (default = null) — Parametres additifs à transmettre au groupe
  • ( Boolean ) unity = false - Si chaque audio de groupe provoque l'interruption des autres
  • ( int ) stack = 50 - Le nombre d'audio issue d'un même fichier jouables au même moment
  • ( int ) loop = 0 - Le nombre de fois où l'audio est rejoué ( -1 pour boucle infinie )
  • ( Number ) position = 0 - Position de l'audio à son lancement
  • ( Number ) fadeIn = 0 - Temps au lancement de l'audio durant lequel le volume va croître progressivement
  • ( Number ) fadeOut = 0 - Temps avant la fin de l'audio durant lequel le volume va décroître progressivement
  • ( Function ou HeFunction ) callPlay - La fonction provoquée quand l'audio est joué
  • ( Function ou HeFunction ) callLoop - La fonction provoquée pendant que l'audio est joué
  • ( Function ou HeFunction ) callStop - La fonction provoquée quand l'audio est interrompue
  • ( Function ou HeFunction ) callEnd - La fonction provoquée quand l'audio arrive à son terme

Returns
Boolean — true Si le groupe n'existait pas déjà false Si le groupe existait déjà
addNoise()method 
public static function addNoise(name:String, group:String, ... list):Boolean

Créait un audio aléatoire.

Parameters

name:String — Nom de l'Audio
 
group:String — Nom du groupe
 
... list — Suite d'éléments pour le noise sous forme d'objet avec les clés : group, name, value, param

Returns
Boolean
addNoiseGroup()method 
public static function addNoiseGroup(name:String):Boolean

Créait un groupe d'audio aléatoires.

Parameters

name:String — Nom du groupe

Returns
Boolean
applyVolume()method 
public static function applyVolume():void

Réapplique les volumes à chaque audio de chaque groupe

defineGlobalLoop()method 
public static function defineGlobalLoop():void

Calibre la boucle générale

getAudio()method 
public static function getAudio(name:String, group:String):HeSound

getAudio Récupère l'instance d'un object d'audio pour le lire ou modifier ses paramètres ou valeurs.

Parameters

name:String — Nom de l'audio
 
group:String — Nom du groupe

Returns
HeSound — Objet de cet audio
getGroup()method 
public static function getGroup(name:String):HeSoundGroup

Récupère l'instance d'un objet groupe pour le lire ou modifier ses paramètres ou valeurs.

Parameters

name:String — Nom du groupe

Returns
HeSoundGroup — Objet de ce groupe
play()method 
public static function play(name:String, group:String, value:Object = null, param:Object = null):void

Joue un audio archivé.

Parameters

name:String — Nom de l'audio à jouer
 
group:String — Groupe de l'audio
 
value:Object (default = null) — Valeurs additives, elles sont les mêmes qu'à la création de l'audio
 
param:Object (default = null) — Paramètres additifs, ils sont les mêmes qu'à la création de l'audio avec, en plus :
  • ( String ) id - Nom de channel de l'audio ( Numero par rapport à cet audio par défaut )
  • ( Boolean ) hasCall = true - Si cet audio provoquera ses différents call

playNoise()method 
public static function playNoise(name:String, group:String):void

Joue un audio aléatoire.

Parameters

name:String — Nom de l'Audio
 
group:String — Nom du groupe

remove()method 
public static function remove(name:String, group:String):Boolean

Supprime un audio archivé.

Parameters

name:String — Le nom de l'audio à supprimer
 
group:String — Le nom du groupe

Returns
Boolean — true Si l'audio existait false Si l'audio n'existait pas
removeGlobalLoop()method 
public static function removeGlobalLoop():void

Retire la boucle générale

removeGroup()method 
public static function removeGroup(group:String):Boolean

Supprime un groupe et chacun de ses audios archivés.

Parameters

group:String — Le nom du groupe à supprimer, si rien, il supprimera tout les groupes d'audio

Returns
Boolean — true Si le groupe existait false Si le groupe n'existait pas
removeNoise()method 
public static function removeNoise(name:String, group:String):Boolean

Supprime un audio aléatoire.

Parameters

name:String — Nom de l'Audio
 
group:String — Nom du groupe

Returns
Boolean
stop()method 
public static function stop(name:String, group:String, param:Object = null):void

Interrompt un audio précédemment lancé.

Parameters

name:String — Nom de l'audio à jouer
 
group:String — Groupe de l'audio
 
param:Object (default = null) — Paramètres additifs
  • ( Boolean ) hasCall = true - Si l'interruption provoque le callStop de l'audio
  • ( Boolean ) isForced = false - Si l'interruption est immédiate et ignore les autres effets de type fadeOut

stopGroup()method 
public static function stopGroup(group:String, param:Object = null):void

Interrompt tout les un audios d'un groupe.

Parameters

group:String — Nom du groupe à interrompre ( Si rien, interrompt tout )
 
param:Object (default = null) — Paramètres additifs
  • ( Boolean ) isCall = true - Si l'interruption provoque le callStop des audios




Copyright @ Ockam Razor
www.mediatools.com

Vendredi Août 29 2014, 03:22 PM +02:00