Passer au contenu principal

audio

Description

Cette bibliothèque comprend des fonctions qui gèrent la lecture audio.

Audio

PropriétéTypeDéfautDescription
url (Obligatoire)chaîne de caractères''Source URL
volumenombre1Volume de l'audio qui sera joué. Une valeur comprise entre 0 et 1
bouclebooléenfauxSi l'audio redémarre après la fin de l'émission
en pausebooléenfauxMétéo L'audio est actuellement en pause
hauteurnombre1Facteur utilisé pour modifier la hauteur du son. 1 est la hauteur par défaut.
positionnelbooléenfauxsi l'audio est joué de manière positionnelle
refDistancenombre1**La valeur indiquant la distance à laquelle le volume de cette source commencera à diminuer lorsque l'auditeur s'éloignera. Doit être une valeur non négative.
modèle de distancechaîne de caractèresinverse**L'algorithme utilisé pour réduire le volume à mesure que la distance entre cette source audio et l'auditeur augmente. Les valeurs possibles sont "linéaire", "inverse" et "exponentiel".
Facteur d'atténuationnombre1**La vitesse à laquelle le volume est réduit lorsque la distance entre cette source audio et l'auditeur augmente. La plage de valeurs acceptables change en fonction du modèle de distance, comme le montrent les exemples suivants : linéaire : 0 à 1, inverse : 0 à l'infini, exponentiel : 0 à l'infini
maxDistancenombre10000Appliqué uniquement si positional est vrai et si distanceModel est égal à linear. La distance maximale entre cette source audio et l'auditeur. Le volume n'est pas réduit après ce point. Doit être une valeur positive.

Son

PropriétéTypeDescription
ideidL'Aïd du son.
audioNodeAudio / PositionalAudioAudioNode
élémentHTMLAudioElementL'élément HTML audio.
contrôleurAbortControllerLe contrôleur audio AbortController.
urlchaîne de caractèresL'URL source
en pausebooléenIndique si l'audio est en pause ou en cours de lecture.

Propriétés

PropriétéTypeDescription
auditeurAudioListenerUn auditeur virtuel de tous les effets audio positionnels et non positionnels de la scène.

Fonctions

sourdine

Couper le son de la scène.

world.audio.mute() // -> void

unmute

Désactiver le son de la scène.

world.audio.unmute() // -> void

pause

Mettre en pause l'audio de la scène.

world.audio.pause() // -> void

jouer

Lecture de l'audio de la scène.

world.audio.play() // -> void

setVolume

Régler le volume de l'audio de la scène. **Le paramètre doit être une valeur comprise entre 0 et 1.

world.audio.setVolume(newVolume : number) // -> void