class xorax.player

base

Class Information

Author
Xorax
Version
20080523
Description
fournit les fonctions nécéssaires à la lecture de fichier audio.
class xorax.player.base
Constructors
base() constructeur de la classe
Properties
src source du son (fichier mp3, flux...)
streaming Le son doit-il être traité comme un flux. si oui la lecture démarre dés que possible. (par défaut : true)
volumeStage cran d'incrémentation du volume (par default: 10)
auto si = true, alors le constructor cherchera les variables passées en paramètre à l'animation (_root.*)
Methods
duration() Permet de connaitre la durée du son en millisecond. Si le chargement du son est en cour, la durée est approximative.
position() Si msec est défni, la tête de lecture se déplacera à msec milliseconde (ou plutôt à msec/1000 seconde) et commencera la lecture. Sinon, renovi la postion de la tête de lecture en milliseconde.
isOnPlaying() renvoi si oui ou non le son est en cour de lecture.
isOnLoading() renvoi si oui ou non le son est en cour de chargement
isOnPause() renvoi si oui ou non le son est en pause
getBytesLoaded() renvoi le nombre de Bytes télécharger pour le son en cour
getBytesTotal() renvoi la taille en Bytes du son en cour
play() joue le son, redémarre un son qui était en pause
pause() met le son en pause
stop() arrète la lecture (le son reprendra au début)
volumeSet() défini le volume audio
volumeGet() renvoi le volume du son / 100
volumeInc() incrémente le volume de volumeStage point (par défaut 10/100)
volumeDec() décrémente le voolume de volumeStage poin (par défaut 10/100)t
positionSet() déplace la tête de lecture à la position pos. méthode utilisé pour les appels javascript
positionGet() méthode utilisé pour les appels javascript.
initExternalMethod() initialize les fonctions javascript qui seront disponible dans l'object flash de la page web. les fonctions suivante de cette class seront exportées : play, pause, stop, volumeDec, volumeInc, volumeSet, volumeGet, positionSet, positionGet, isOnPlaying, isOnLoading, isOnPause

Constructors

base()

function base ()
constructeur de la classe
Parameters:
autoautoconfigure le lecteur en fonction de flashvars (variables disponibles sur _root) il existe 3 variables de configuration : - callable : exporte certaines fonctions pour qu'elle soit disponible en javascript dans la page html - src : url de la source audio. permet de préconfigurer le son (mp3, stream ou autre) à jouer. - auto : démarre automatiquement la lecture lorsque l'animation est chargé. exemple : _root.src = 'son.mp3'; var myPlayer = new xorax.player.base(true); //myPlayer a préenregistré la valeur _root.src en tant que source audio. myPlayer.play(); // va démarrer la lecture de 'son.mp3'

Properties

src

public var src:String
source du son (fichier mp3, flux...)

streaming

public var streaming:Boolean
Le son doit-il être traité comme un flux. si oui la lecture démarre dés que possible. (par défaut : true)

volumeStage

public var volumeStage:Number
cran d'incrémentation du volume (par default: 10)

auto

public static var auto:Boolean
si = true, alors le constructor cherchera les variables passées en paramètre à l'animation (_root.*)

Methods

duration()

public function duration ():Number
Permet de connaitre la durée du son en millisecond. Si le chargement du son est en cour, la durée est approximative.
Returns:
int la durée du son chargé en millisecond

position()

function position (msec:Number):Number
Si msec est défni, la tête de lecture se déplacera à msec milliseconde (ou plutôt à msec/1000 seconde) et commencera la lecture. Sinon, renovi la postion de la tête de lecture en milliseconde.
Parameters:
msecen milliseconde (arrondie plus tard à la second). (optionnel)

isOnPlaying()

public function isOnPlaying ():Boolean
renvoi si oui ou non le son est en cour de lecture.

isOnLoading()

public function isOnLoading():Boolean
renvoi si oui ou non le son est en cour de chargement

isOnPause()

public function isOnPause():Boolean
renvoi si oui ou non le son est en pause

getBytesLoaded()

public function getBytesLoaded():Number
renvoi le nombre de Bytes télécharger pour le son en cour

getBytesTotal()

public function getBytesTotal():Number
renvoi la taille en Bytes du son en cour

play()

public function play (src:String):Void
joue le son, redémarre un son qui était en pause
Parameters:
srcnouvelle source du son (optionnel)

pause()

public function pause ():Void
met le son en pause

stop()

public function stop ():Void
arrète la lecture (le son reprendra au début)

volumeSet()

public function volumeSet(v:Number):Number
défini le volume audio
Parameters:
vvolume du son / 100

volumeGet()

public function volumeGet():Number
renvoi le volume du son / 100

volumeInc()

public function volumeInc ():Number
incrémente le volume de volumeStage point (par défaut 10/100)

volumeDec()

public function volumeDec ():Number
décrémente le voolume de volumeStage poin (par défaut 10/100)t

positionSet()

public function positionSet (pos):Void
déplace la tête de lecture à la position pos. méthode utilisé pour les appels javascript
Parameters:
posrapport de position de la tête de lecture (0 à 1)

positionGet()

public function positionGet ():Number
méthode utilisé pour les appels javascript.
Returns:
numbre entre 0 et 1 : position de la tête de lecture par rapport à la durée du son

initExternalMethod()

public function initExternalMethod()
initialize les fonctions javascript qui seront disponible dans l'object flash de la page web. les fonctions suivante de cette class seront exportées : play, pause, stop, volumeDec, volumeInc, volumeSet, volumeGet, positionSet, positionGet, isOnPlaying, isOnLoading, isOnPause

Page generated: 4:27 am on May 31, 2008