You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

268 lines
8.8 KiB

2 years ago
<!DOCTYPE html>
<html lang="it">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
[page:Object3D] &rarr;
<h1>[name]</h1>
<p class="desc">
Crea un oggetto audio non posizionale (globale).<br /><br />
Utilizza le [link:https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API API Web Audio].
</p>
<h2>Codice di Esempio</h2>
<code>
// crea un AudioListener e aggiungilo alla camera
const listener = new THREE.AudioListener();
camera.add( listener );
// crea una sorgente audio globale
const sound = new THREE.Audio( listener );
// carica un suono e impostalo come buffer dell'oggetto audio
const audioLoader = new THREE.AudioLoader();
audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
sound.setBuffer( buffer );
sound.setLoop( true );
sound.setVolume( 0.5 );
sound.play();
});
</code>
<h2>Esempi</h2>
<p>
[example:webaudio_sandbox webaudio / sandbox ]<br />
[example:webaudio_visualizer webaudio / visualizer ]
</p>
<h2>Costruttore</h2>
<h3>[name]( [param:AudioListener listener] )</h3>
<p>
listener — (obbligatorio) istanza [page:AudioListener AudioListener].
</p>
<h2>Proprietà</h2>
<h3>[property:Boolean autoplay]</h3>
<p>Indica se avviare la riproduzione automaticamente. Il valore predefinito è `false`.</p>
<h3>[property:AudioContext context]</h3>
<p>L'[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext AudioContext] del [page:AudioListener listener] passato nel costruttore.</p>
<h3>[property:Number detune]</h3>
<p>Modifica l'intonazione, misurata in centesimi. +/- 100 è un semitono. +/- 1200 è un'ottava. Il valore predefinito è `0`.</p>
<h3>[property:Array filters]</h3>
<p>
Rappresenta un'array di [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioNode AudioNode]. Può essere usato per applicare una varietà di
filtri low-order per creare effetti sonori più complessi. In molti casi, l'array contiene istanze di
[link:https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode BiquadFilterNode]. I filtri sono impostati tramite
[page:Audio.setFilter] o [page:Audio.setFilters].
</p>
<h3>[property:GainNode gain]</h3>
<p>
Un [link:https://developer.mozilla.org/en-US/docs/Web/API/GainNode GainNode] creato usando
[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createGain AudioContext.createGain]().
</p>
<h3>[property:Boolean hasPlaybackControl]</h3>
<p>
Indica se la riproduzione può essere controllata usando i metodi [page:Audio.play play](),
[page:Audio.pause pause]() etc. Il valore di default è `true`.
</p>
<h3>[property:Boolean isPlaying]</h3>
<p>Indica se l'audio è attualmente in riproduzione.</p>
<h3>[property:AudioListener listener]</h3>
<p>Un riferimento all'oggetto listener di questo audio.</p>
<h3>[property:Number playbackRate]</h3>
<p>Velocità di riproduzione. Il valore predefinito è `1`.</p>
<h3>[property:Number offset]</h3>
<p>
Un offset al momento in cui deve iniziare la riproduzione all'interno del buffer audio.
È uguale al parametro audio di [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start AudioBufferSourceNode.start]().
Il valore predefinito è `0`.
</p>
<h3>[property:Number duration]</h3>
<p>
Sovrascrive la durata dell'audio. È uguale al parametro `duration` di
[link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start AudioBufferSourceNode.start]().
Il valore predefinito è `undefined` per riprodurre l'intero buffer.
</p>
<h3>[property:String source]</h3>
<p>
Un [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode AudioBufferSourceNode] creato
usando [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createBufferSource AudioContext.createBufferSource]().
</p>
<h3>[property:String sourceType]</h3>
<p>Il tipo di sorgente audio. Il valore predefinito è la stringa 'empty'.</p>
<h3>[property:String type]</h3>
<p>Stringa che denota il tipo, impostato ad 'Audio'.</p>
<h2>Metodi</h2>
<h3>[method:this connect]()</h3>
<p>
Permette di collegarsi all'[page:Audio.source]. Questo metodo viene utilizzato internamente
durante l'inizializzazione e durante l'impostazione/eliminazione dei filtri.
</p>
<h3>[method:this disconnect]()</h3>
<p>
Permette di scollegarsi dall'[page:Audio.source]. Questo metodo viene utilizzato internamente
durante l'impostazione/eliminazione dei filtri.
</p>
<h3>[method:Float getDetune]()</h3>
<p>
Restituisce il detuning dell'oscillazione in centesimi.
</p>
<h3>[method:BiquadFilterNode getFilter]()</h3>
<p>
Restituisce il primo elemento dell'array [page:Audio.filters filters].
</p>
<h3>[method:Array getFilters]()</h3>
<p>
Restituisce l'array [page:Audio.filters filters].
</p>
<h3>[method:Boolean getLoop]()</h3>
<p>
Restituisce il valore di [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop]
(se la riproduzione deve essere ripetuta).
</p>
<h3>[method:GainNode getOutput]()</h3>
<p>
Restituisce il [page:Audio.gain gainNode].
</p>
<h3>[method:Float getPlaybackRate]()</h3>
<p>
Restituisce il valore di [page:Audio.playbackRate playbackRate].
</p>
<h3>[method:Float getVolume]( value )</h3>
<p>
Restituisce il volume corrente.
</p>
<h3>[method:this play]( delay )</h3>
<p>
Se [page:Audio.hasPlaybackControl hasPlaybackControl] è impostato a true, inizia la riproduzione.
</p>
<h3>[method:this pause]()</h3>
<p>
Se [page:Audio.hasPlaybackControl hasPlaybackControl] è impostato a true, mette in pausa la riproduzione.
</p>
<h3>[method:undefined onEnded]()</h3>
<p>
Viene chiamato automaticamente quando la riproduzione termina.
</p>
<h3>[method:this setBuffer]( audioBuffer )</h3>
<p>
Imposta la [page:Audio.source sorgente] su audioBuffer, e imposta il [page:Audio.sourceType sourceType] a 'buffer'.<br />
Se la riproduzione è in [page:Audio.autoplay autoplay], avvia anche la riproduzione.
</p>
<h3>[method:this setDetune]( [param:Float value] )</h3>
<p>
Definisce il detuning dell'oscillazione in centesimi.
</p>
<h3>[method:this setFilter]( filter )</h3>
<p>
Applica un singolo filtro all'audio.
</p>
<h3>[method:this setFilters]( [param:Array value] )</h3>
<p>
value - array di filtri.<br />
Applica un array di filtri all'audio.
</p>
<h3>[method:this setLoop]( [param:Boolean value] )</h3>
<p>
Imposta [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop] a `value`
(se la riproduzione deve andare in loop).
</p>
<h3>[method:this setLoopStart]( [param:Float value] )</h3>
<p>
Imposta [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart source.loopStart] a `value`.
</p>
<h3>[method:this setLoopEnd]( [param:Float value] )</h3>
<p>
Imposta [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd source.loopEnd] a `value`.
</p>
<h3>[method:this setMediaElementSource]( mediaElement )</h3>
<p>
Applica l'oggetto passato come parametro, di tipo [link:https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement HTMLMediaElement],
come sorgente di questo audio.<br />
Inoltre imposta [page:Audio.hasPlaybackControl hasPlaybackControl] a false.
</p>
<h3>[method:this setMediaStreamSource]( mediaStream )</h3>
<p>
Applica l'oggetto passato come parametro, di tipo [link:https://developer.mozilla.org/en-US/docs/Web/API/MediaStream MediaStream],
come sorgente di questo audio.<br />
Inoltre imposta [page:Audio.hasPlaybackControl hasPlaybackControl] a false.
</p>
<h3>[method:this setNodeSource]( audioNode )</h3>
<p>
Imposta la [page:Audio.source sorgente] dell'audioBuffer, e imposta [page:Audio.sourceType sourceType] a 'audioNode'.<br />
Inoltre imposta [page:Audio.hasPlaybackControl hasPlaybackControl] a false.
</p>
<h3>[method:this setPlaybackRate]( [param:Float value] )</h3>
<p>
Se [page:Audio.hasPlaybackControl hasPlaybackControl] è abilitato, imposta il [page:Audio.playbackRate playbackRate] a `value`.
</p>
<h3>[method:this setVolume]( [param:Float value] )</h3>
<p>
Imposta il volume.
</p>
<h3>[method:this stop]()</h3>
<p>
Se [page:Audio.hasPlaybackControl hasPlaybackControl] è abilitato, ferma la riproduzione.
</p>
<h2>Source</h2>
<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>