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.
247 lines
8.2 KiB
247 lines
8.2 KiB
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<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] →
|
|
|
|
<h1>[name]</h1>
|
|
|
|
<p class="desc">
|
|
Cria um objeto de áudio não posicional ( global ).<br /><br />
|
|
|
|
Utiliza a [link:https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API Web Audio API].
|
|
</p>
|
|
|
|
<h2>Exemplo de Código</h2>
|
|
|
|
<code>
|
|
// create an AudioListener and add it to the camera
|
|
const listener = new THREE.AudioListener();
|
|
camera.add( listener );
|
|
|
|
// create a global audio source
|
|
const sound = new THREE.Audio( listener );
|
|
|
|
// load a sound and set it as the Audio object's buffer
|
|
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>Exemplos</h2>
|
|
|
|
<p>
|
|
[example:webaudio_sandbox webaudio / sandbox ]<br />
|
|
[example:webaudio_visualizer webaudio / visualizer ]
|
|
</p>
|
|
|
|
<h2>Construtor</h2>
|
|
|
|
|
|
<h3>[name]( [param:AudioListener listener] )</h3>
|
|
<p>
|
|
listener — (obrigatório) instância [page:AudioListener AudioListener].
|
|
</p>
|
|
|
|
|
|
<h2>Propriedades</h2>
|
|
|
|
<h3>[property:Boolean autoplay]</h3>
|
|
<p>Se deve iniciar a reprodução automaticamente. O padrão é `false`.</p>
|
|
|
|
<h3>[property:AudioContext context]</h3>
|
|
<p>O [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext AudioContext] do [page:AudioListener listener] dado no construtor.</p>
|
|
|
|
<h3>[property:Number detune]</h3>
|
|
<p>Modifica o tom, medido em centenas. +/- 100 é um semitom. +/- 1200 é uma oitava. O padrão é `0`.</p>
|
|
|
|
<h3>[property:Array filters]</h3>
|
|
<p>Representa um array de [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioNode AudioNodes]. Pode ser usado para aplicar uma variedade de filtros de baixa ordem para criar efeitos sonoros mais complexos.
|
|
Na maioria dos casos, o array contém instâncias de [link:https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode BiquadFilterNodes]. Filtros são definidos por [page:Audio.setFilter] ou [page:Audio.setFilters].</p>
|
|
|
|
<h3>[property:GainNode gain]</h3>
|
|
<p>Um [link:https://developer.mozilla.org/en-US/docs/Web/API/GainNode GainNode] criado
|
|
usando [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createGain AudioContext.createGain]().</p>
|
|
|
|
<h3>[property:Boolean hasPlaybackControl]</h3>
|
|
<p>Se a reprodução pode ser controlada usando os métodos [page:Audio.play play](),
|
|
[page:Audio.pause pause]() etc. O padrão é `true`.</p>
|
|
|
|
<h3>[property:Boolean isPlaying]</h3>
|
|
<p>Se o áudio está sendo reproduzido no momento.</p>
|
|
|
|
<h3>[property:AudioListener listener]</h3>
|
|
<p>Uma referência ao objeto ouvinte (listener) deste áudio.</p>
|
|
|
|
<h3>[property:Number playbackRate]</h3>
|
|
<p>Velocidade de reprodução. O padrão é `1`.</p>
|
|
|
|
<h3>[property:Number offset]</h3>
|
|
<p>Um deslocamento para o tempo dentro do buffer de áudio em que a reprodução deve começar. Igual ao parâmetro `offset` do [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start AudioBufferSourceNode.start](). O padrão é `0`.</p>
|
|
|
|
<h3>[property:Number duration]</h3>
|
|
<p>Substitui a duração do áudio. O mesmo que o parâmetro `duration` do [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/start AudioBufferSourceNode.start](). O padrão é `undefined` para reproduzir todo o buffer.</p>
|
|
|
|
<h3>[property:String source]</h3>
|
|
<p>Um [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode AudioBufferSourceNode] criado
|
|
usando [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createBufferSource AudioContext.createBufferSource]().</p>
|
|
|
|
<h3>[property:String sourceType]</h3>
|
|
<p>Tipo da fonte de áudio. O padrão é a string 'empty'.</p>
|
|
|
|
<h3>[property:String type]</h3>
|
|
<p>String que denota o tipo, definido como 'Audio'.</p>
|
|
|
|
|
|
<h2>Métodos</h2>
|
|
|
|
<h3>[method:this connect]()</h3>
|
|
<p>
|
|
Conecta-se ao [page:Audio.source]. Isso é usado internamente na inicialização e quando
|
|
configurar / remover filtros.
|
|
</p>
|
|
|
|
<h3>[method:this disconnect]()</h3>
|
|
<p>
|
|
Desconecta-se do [page:Audio.source]. Isso é usado internamente quando
|
|
configurar / remover filtros.
|
|
</p>
|
|
|
|
<h3>[method:Float getDetune]()</h3>
|
|
<p>
|
|
Retorna a desafinação da oscilação em centenas.
|
|
</p>
|
|
|
|
<h3>[method:BiquadFilterNode getFilter]()</h3>
|
|
<p>
|
|
Retorna o primeiro elemento do array [page:Audio.filters filters].
|
|
</p>
|
|
|
|
<h3>[method:Array getFilters]()</h3>
|
|
<p>
|
|
Retorna o array [page:Audio.filters filters].
|
|
</p>
|
|
|
|
<h3>[method:Boolean getLoop]()</h3>
|
|
<p>
|
|
Retorna o valor do [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop]
|
|
(se a reprodução deve fazer um loop).
|
|
</p>
|
|
|
|
<h3>[method:GainNode getOutput]()</h3>
|
|
<p>
|
|
Retorna o [page:Audio.gain gainNode].
|
|
</p>
|
|
|
|
<h3>[method:Float getPlaybackRate]()</h3>
|
|
<p>
|
|
Retorna o valor do [page:Audio.playbackRate playbackRate].
|
|
</p>
|
|
|
|
<h3>[method:Float getVolume]( value )</h3>
|
|
<p>
|
|
Retorna o volume atual.
|
|
</p>
|
|
|
|
<h3>[method:this play]( delay )</h3>
|
|
<p>
|
|
Se [page:Audio.hasPlaybackControl hasPlaybackControl] é true, começa a reprodução.
|
|
</p>
|
|
|
|
<h3>[method:this pause]()</h3>
|
|
<p>
|
|
Se [page:Audio.hasPlaybackControl hasPlaybackControl] é true, pausa a reprodução.
|
|
</p>
|
|
|
|
<h3>[method:undefined onEnded]()</h3>
|
|
<p>
|
|
Chamado automaticamente quando a reprodução termina.
|
|
</p>
|
|
|
|
<h3>[method:this setBuffer]( audioBuffer )</h3>
|
|
<p>
|
|
Configura a [page:Audio.source source] para o audioBuffer e define [page:Audio.sourceType sourceType] para 'buffer'.<br />
|
|
Se [page:Audio.autoplay autoplay], também inicia a reprodução.
|
|
</p>
|
|
|
|
<h3>[method:this setDetune]( [param:Float value] )</h3>
|
|
<p>
|
|
Define a desafinação da oscilação em centenas.
|
|
</p>
|
|
|
|
<h3>[method:this setFilter]( filter )</h3>
|
|
<p>
|
|
Aplica um único nó de filtro ao áudio.
|
|
</p>
|
|
|
|
<h3>[method:this setFilters]( [param:Array value] )</h3>
|
|
<p>
|
|
value -array de filtros.<br />
|
|
Aplica um array de nós de filtro ao áudio.
|
|
</p>
|
|
|
|
<h3>[method:this setLoop]( [param:Boolean value] )</h3>
|
|
<p>
|
|
Configura [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loop source.loop] para `value`
|
|
(se a reprodução deve fazer um loop).
|
|
</p>
|
|
|
|
<h3>[method:this setLoopStart]( [param:Float value] )</h3>
|
|
<p>
|
|
Configura [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopStart source.loopStart] para `value`.
|
|
</p>
|
|
|
|
<h3>[method:this setLoopEnd]( [param:Float value] )</h3>
|
|
<p>
|
|
Configura [link:https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode/loopEnd source.loopEnd] para `value`.
|
|
</p>
|
|
|
|
<h3>[method:this setMediaElementSource]( mediaElement )</h3>
|
|
<p>
|
|
Aplica o objeto dado do tipo [link:https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement HTMLMediaElement] como a fonte deste áudio.<br />
|
|
Também define [page:Audio.hasPlaybackControl hasPlaybackControl] para false.
|
|
</p>
|
|
|
|
<h3>[method:this setMediaStreamSource]( mediaStream )</h3>
|
|
<p>
|
|
Aplica o objeto dado do tipo [link:https://developer.mozilla.org/en-US/docs/Web/API/MediaStream MediaStream] como a fonte deste áudio.<br />
|
|
Também define [page:Audio.hasPlaybackControl hasPlaybackControl] para false.
|
|
</p>
|
|
|
|
<h3>[method:this setNodeSource]( audioNode )</h3>
|
|
<p>
|
|
Configura o [page:Audio.source source] para o audioBuffer e define [page:Audio.sourceType sourceType] para 'audioNode'.<br />
|
|
Também define [page:Audio.hasPlaybackControl hasPlaybackControl] para false.
|
|
</p>
|
|
|
|
<h3>[method:this setPlaybackRate]( [param:Float value] )</h3>
|
|
<p>
|
|
Se [page:Audio.hasPlaybackControl hasPlaybackControl] está ativado, configura o [page:Audio.playbackRate playbackRate] para `value`.
|
|
</p>
|
|
|
|
<h3>[method:this setVolume]( [param:Float value] )</h3>
|
|
<p>
|
|
Configura o volume.
|
|
</p>
|
|
|
|
<h3>[method:this stop]()</h3>
|
|
<p>
|
|
Se [page:Audio.hasPlaybackControl hasPlaybackControl] está ativado, para a reprodução.
|
|
</p>
|
|
|
|
<h2>Source</h2>
|
|
|
|
<p>
|
|
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
|
|
</p>
|
|
</body>
|
|
</html>
|
|
|