Properties

This section describes the properties associated with the HTML5 Web Audio APIs. These APIs conform to the emerging W3C Web Audio standard.

In this section

TopicDescription

attack

Gets the amount of time in seconds required to reduce the gain by 10db.

buffer

An audio asset to be played.

buffer (ConvolverNode)

Sets or gets a single or multi-channel AudioBuffer containing the impulse response for a ConvolverNode.

bufferSize

Gets the buffer size in sample-frames that's set on a ScriptProcessorNode created with createScriptProcessor.

channelCount

Used to help calculate the internal value computedNumberOfChannels for up or down-mixing connections to any inputs of an AudioNode.

channelCountMode

Sets how the internal value computedNumberOfChannels is computed when up or down-mixing connections to AudioNode inputs.

channelInterpretation

Sets how individual channels are treated when up or down-mixing connections to inputs on an AudioNode. This property is ignored on an AudioNode with no inputs.

coneInnerAngle

Gets or sets a directional audio source where there is no volume reduction inside the angle.

coneOuterAngle

Gets or sets a directional audio source where the volume is reduced outside the angle to a constant value of coneOuterGain

coneOuterGain

Gets or sets a directional audio source value for volume reduction outside the coneOuterAngle.

context

Gets the AudioContext that owns the AudioNode.

currentTime

Time in seconds that starts at zero when AudioContext is created.

curve

Gets or sets the an array that defines a curve to use for a waveshaping effect.

defaultValue

Set or get the initial value for the AudioParam value attribute.

delayTime

Gets an AudioParam object that represents the delay in seconds to apply to an AudioNode.

destination

Provides the final destination for all audio input. Typically represents the actual audio hardware.

detune

Gets a detuning value in cents which offsets the frequency attribute to calculate a computed frequency value.

distanceModel

Gets or sets the distance model to be used by PannerNode.

dopplerFactor

A constant multiplier used to set the amount of pitch shift when rendering a Doppler effect.

duration

The duration of Pulse Code Modulation (PCM) audio data for a buffer in seconds.

fftSize

A non-zero power of two value that sets the size of the FFT used for frequency-domain analysis.

frequency

Gets the operating frequency in hertz for a BiquadFilterNode.

frequency (OscillatorNode)

Gets the frequency in hertz of an OscillatorNode's periodic waveform.

frequencyBinCount

The number of data points that the frequency data returns. This value is always fftSize/2.

gain

Gets a factor that is applied to the input signal of a GainNode to calculate gain.

gain (BiquadFilterNode)

Gets the gain value of the BiquadFilterNode.

inputBuffer

An AudioBuffer containing input audio data scoped to the current onaudioprocess event.

knee

Gets a decibel value that represents the range above the threshold where the curve smoothly transitions to the ratio portion.

length

PCM audio data length in sample-frames.

listener

Returns an AudioListener object to use for 3D spatialization.

loop

Gets or sets a flag to specify whether audio data should restart after it completes.

loopEnd

Gets or sets a value in seconds when a loop should end, if the loop flag is set.

loopStart

If the loop flag is set, this gets or sets a value in seconds where a loop should begin.

maxChannelCount

Gets or sets the maximum number of channels that can be set by channelCount on an AudioNode.

maxDecibels

The maximum power value of a scaling range for FFT analysis data.

maxDistance

The maximum distance between the source and the listener where the volume isn't reduced any further.

minDecibels

The minimum power value of a range for FFT analysis data.

normalize

Gets or sets whether the impulse response from the ConvolverNode buffer is scaled by an equal-power normalization when a buffer is set.

numberOfChannels

The number of discrete audio channels on an AudioBuffer.

numberOfInputs

The number of inputs going into an AudioNode. If the value is 0, it's a source node.

numberOfOutputs

The number of outputs coming from an AudioNode. If value is 0, it's an AudioDestinationNode.

outputBuffer

An AudioBuffer containing input audio data scoped to the current onaudioprocess event.

oversample

Gets or sets the type of oversampling (if any) to apply to input with a WaveShaperNode.

pan

Gets position of the input in the output's stereo image.

panningModel

Gets or sets the panning model to use with PannerNode.

playbackRate

Gets or sets the speed for an audio stream to playback. This rate is expressed as a multiple of the normal speed of the audio resource.

playbackTime

Time when audio is played.

Q

Gets the Q or quality factor for a filter.

ratio

Gets the amount of decibel change in input to produce a 1db change in output.

reduction

Gets a decibel value for metering purposes that represents the current amount of gain reduction that is being applied by the compressor.

refDistance

Gets or sets a reference distance value to reduce volume as a source moves away from the listener.

release

Gets the amount of time in seconds required for a 10db increase in gain.

renderedBuffer

Gets the AudioBuffer that contains rendered audio data on an OfflineAudioCompletionEvent.

rolloffFactor

Gets or sets a factor to reduce the volume as the source moves away from the listener.

sampleRate

The sample rate that the audio is handled, in sample-frames per second.

smoothingTimeConstant

A time value used to smooth analyzed data, such as to make a less jumpy meter or visualization.

speedOfSound

Sets a constant speed of sound in meters per second to use when calculating a Doppler effect.

stream

Gets the MediaStream from a MediaStreamAudioDestinationNode.

threshold

Gets the k-rate decibel value above which compression takes effect.

type

Sets or gets the type of filter to use.

type (OscillatorNode)

Gets or sets the periodic waveform to generate with an OscillatorNode, such as sine, square, or triangle.

value

Value parameter for an AudioParam node.

 

 

 

Show: