The read-only offset
property of the ConstantSourceNode
interface returns a AudioParam
object indicating the numeric a-rate value which is always returned by the source when asked for the next sample.
While the AudioParam
named offset
is read-only, the value
property within is not. So you can change the value of offset
by setting the value of ConstantSourceNode.offset.value
:
myConstantSourceNode.offset.value = newValue;
Syntax
let offsetParameter = ConstantAudioNode.offset; let offset = ConstantSourceNode.offset.value; ConstantSourceNode.offset.value = newValue;
Value
An AudioParam
object indicating the a-rate value returned for every sample by this node. The default value is 1.0.
To access the offset
parameter's current value, access the parameter's value
property, as shown in the syntax box above.
Example
This example shows how to set up a ConstantSourceNode
so its offset
is used as the input to a pair of GainNode
s; this snippet is derived from the complete example you can find in Controlling multiple parameters with ConstantSourcenode.
gainNode2 = context.createGain();
gainNode3 = context.createGain();
gainNode2.gain.value = gainNode3.gain.value = 0.5;
volumeSliderControl.value = gainNode2.gain.value;
constantSource = context.createConstantSource();
constantSource.connect(gainNode2.gain);
constantSource.connect(gainNode3.gain);
First, the gain nodes are created and configured, and a slider control's value is set to match the gain on the two nodes. Then we create a new ConstantSourceNode
and make it the source for the two gain nodes' GainNode.gain
values. Each of those values is also an AudioParam
.
Let's say we have an event handler (for click
events, in this case) which needs to respond by altering the value of the two gain nodes. With the linkage above in place, that can be done using this simple event handler:
function handleClickEvent(event) {
constantSource.offset.value = volumeSliderControl.value;
}
All this function has to do is fetch the current value of the slider control we're using to control the paired nodes' gains, then store that value into the ConstantSourceNode
's offset
parameter. That's done by simply changing the contents of its AudioParam.value
property. The two gain nodes quickly adopt the new volume level.
Specifications
Specification | Status | Comment |
Web Audio APIThe definition of 'offset' in that specification. | Working Draft |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
offset
|
Chrome
Full support 56 |
Edge
Full support 79 |
Firefox No support 52 — 53 No support 52 — 53 Notes' This property is still available, but via the inheritance of |
IE
No support No |
Opera
No support No |
Safari
No support No |
WebView Android
No support No |
Chrome Android
No support No |
Firefox Android No support 52 — 53 No support 52 — 53 Notes' This property is still available, but via the inheritance of |
Opera Android
No support No |
Safari iOS
No support No |
Samsung Internet Android
No support No |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.'
- See implementation notes.
See also
ConstantSourceNode.offset by Mozilla Contributors is licensed under CC-BY-SA 2.5.