akasha.audio

Class AudioContext

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.audio.BaseAudioContext

akasha.audio.AudioContext

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class AudioContext
extends BaseAudioContext

The AudioContext interface represents an audio-processing graph built from audio modules linked together, each represented by an AudioNode.

See Also:

AudioContext - MDN, # AudioContext

Field Summary

Fields inherited from class akasha.audio.BaseAudioContext

onstatechange

Constructor Summary

Constructors

Constructor and Description
AudioContext() The AudioContext() constructor creates a new AudioContext object which represents an audio-processing graph, built from audio modules linked together, each represented by an AudioNode.
AudioContext(AudioContextOptions contextOptions) The AudioContext() constructor creates a new AudioContext object which represents an audio-processing graph, built from audio modules linked together, each represented by an AudioNode.

Method Summary

Modifier and Type	Method and Description
double	baseLatency() The baseLatency read-only property of the AudioContext interface returns a double that represents the number of seconds of processing latency incurred by the AudioContext passing an audio buffer from the AudioDestinationNode — i.e.
Promise<java.lang.Void>	close() The close() method of the AudioContext Interface closes the audio context, releasing any system audio resources that it uses.
MediaElementAudioSourceNode	createMediaElementSource(HTMLMediaElement mediaElement) For more details about media element audio source nodes, check out the MediaElementAudioSourceNode reference page.
MediaStreamAudioDestinationNode	createMediaStreamDestination() The MediaStream is created when the node is created and is accessible via the MediaStreamAudioDestinationNode's stream attribute.
MediaStreamAudioSourceNode	createMediaStreamSource(MediaStream mediaStream) For more details about media stream audio source nodes, check out the MediaStreamAudioSourceNode reference page.
MediaStreamTrackAudioSourceNode	createMediaStreamTrackSource(MediaStreamTrack mediaStreamTrack) A MediaStreamTrackAudioSourceNode object which acts as a source for audio data found in the specified audio track.
AudioTimestamp	getOutputTimestamp() The getOutputTimestamp() property of the AudioContext interface returns a new AudioTimestamp object containing two audio timestamp values relating to the current audio context.
double	outputLatency() The outputLatency read-only property of the AudioContext Interface provides an estimation of the output latency of the current audio context.
Promise<java.lang.Void>	resume() The resume() method of the AudioContext interface resumes the progression of time in an audio context that has previously been suspended.
Promise<java.lang.Void>	suspend() The suspend() method of the AudioContext Interface suspends the progression of time in the audio context, temporarily halting audio hardware access and reducing CPU/battery usage in the process — this is useful if you want an application to power down the audio hardware when it will not be using an audio context for a while.

Methods inherited from class akasha.audio.BaseAudioContext

audioWorklet, createAnalyser, createBiquadFilter, createBuffer, createBufferSource, createChannelMerger, createChannelMerger, createChannelSplitter, createChannelSplitter, createConstantSource, createConvolver, createDelay, createDelay, createDynamicsCompressor, createGain, createIIRFilter, createIIRFilter, createIIRFilter, createIIRFilter, createOscillator, createPanner, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createScriptProcessor, createScriptProcessor, createScriptProcessor, createScriptProcessor, createStereoPanner, createWaveShaper, currentTime, decodeAudioData, decodeAudioData, decodeAudioData, destination, listener, sampleRate, state

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AudioContext

public AudioContext(@Nonnull
                    AudioContextOptions contextOptions)

The AudioContext() constructor creates a new AudioContext object which represents an audio-processing graph, built from audio modules linked together, each represented by an AudioNode.

See Also:

AudioContext.AudioContext - MDN, AudioContext() - Web Audio API

AudioContext

public AudioContext()

The AudioContext() constructor creates a new AudioContext object which represents an audio-processing graph, built from audio modules linked together, each represented by an AudioNode.

See Also:

AudioContext.AudioContext - MDN, AudioContext() - Web Audio API

Method Detail

baseLatency

@JsProperty(name="baseLatency")
public double baseLatency()

The baseLatency read-only property of the AudioContext interface returns a double that represents the number of seconds of processing latency incurred by the AudioContext passing an audio buffer from the AudioDestinationNode — i.e. the end of the audio graph — into the host system's audio subsystem ready for playing.

See Also:

AudioContext.baseLatency - MDN, baseLatency - Web Audio API

outputLatency

@JsProperty(name="outputLatency")
public double outputLatency()

The outputLatency read-only property of the AudioContext Interface provides an estimation of the output latency of the current audio context.

See Also:

AudioContext.outputLatency - MDN, outputLatency - Web Audio API

close

@Nonnull
public Promise<java.lang.Void> close()

The close() method of the AudioContext Interface closes the audio context, releasing any system audio resources that it uses.

See Also:

AudioContext.close - MDN, close() - Web Audio API

createMediaElementSource

@Nonnull
public MediaElementAudioSourceNode createMediaElementSource(@Nonnull
                                                                     HTMLMediaElement mediaElement)

For more details about media element audio source nodes, check out the MediaElementAudioSourceNode reference page.

See Also:

AudioContext.createMediaElementSource - MDN, createMediaElementSource() - Web Audio API

createMediaStreamDestination

@Nonnull
public MediaStreamAudioDestinationNode createMediaStreamDestination()

The MediaStream is created when the node is created and is accessible via the MediaStreamAudioDestinationNode's stream attribute. This stream can be used in a similar way as a MediaStream obtained via navigator.getUserMedia — it can, for example, be sent to a remote peer using the RTCPeerConnection addStream() method.

See Also:

AudioContext.createMediaStreamDestination - MDN, createMediaStreamDestination() - Web Audio API

createMediaStreamSource

@Nonnull
public MediaStreamAudioSourceNode createMediaStreamSource(@Nonnull
                                                                   MediaStream mediaStream)

For more details about media stream audio source nodes, check out the MediaStreamAudioSourceNode reference page.

See Also:

AudioContext.createMediaStreamSource - MDN, AudioContext.createMediaStreamSource() - Web Audio API

createMediaStreamTrackSource

@Nonnull
public MediaStreamTrackAudioSourceNode createMediaStreamTrackSource(@Nonnull
                                                                             MediaStreamTrack mediaStreamTrack)

A MediaStreamTrackAudioSourceNode object which acts as a source for audio data found in the specified audio track.

See Also:

AudioContext.createMediaStreamTrackSource - MDN, createMediaStreamTrackSource() - Web Audio API

getOutputTimestamp

@Nonnull
public AudioTimestamp getOutputTimestamp()

The getOutputTimestamp() property of the AudioContext interface returns a new AudioTimestamp object containing two audio timestamp values relating to the current audio context.

See Also:

AudioContext.getOutputTimestamp - MDN, getOutputTimestamp() - Web Audio API

resume

@Nonnull
public Promise<java.lang.Void> resume()

The resume() method of the AudioContext interface resumes the progression of time in an audio context that has previously been suspended.

See Also:

AudioContext.resume - MDN, resume() - Web Audio API

suspend

@Nonnull
public Promise<java.lang.Void> suspend()

The suspend() method of the AudioContext Interface suspends the progression of time in the audio context, temporarily halting audio hardware access and reducing CPU/battery usage in the process — this is useful if you want an application to power down the audio hardware when it will not be using an audio context for a while.

See Also:

AudioContext.suspend - MDN, close() - Web Audio API