mozilla
Your Search Results

    GainNode.gain

    This article is in need of a technical review.

    The gain property of the GainNode interface is an a-rate AudioParam representing the amount of gain to apply.

    Syntax

    var audioCtx = new AudioContext();
    var gainNode = audioCtx.createGain();
    gainNode.gain.value = 0.5;
    

    Value

    An AudioParam.

    Note: Though the AudioParam returned is read-only, the value it represents is not.

    Example

    The following example shows basic usage of an AudioContext to create a GainNode, which is then used to mute and unmute the audio when a Mute button is clicked by changing the gain property value. For more complete applied examples/information, check out our Voice-change-O-matic demo (view source.)

    <div>
      <a class="mute">Mute button</a>
    </div>
    var audioCtx = new (window.AudioContext || window.webkitAudioContext)();
    var gainNode = audioCtx.createGain();
    var mute = document.querySelector('.mute');
    
    source.connect(gainNode);
    gainNode.connect(audioCtx.destination);
    
      ...
    
    mute.onclick = voiceMute;
    
    function voiceMute() {
      if(mute.id == "") {
        gainNode.gain.value = 0;
        mute.id = "activated";
        mute.innerHTML = "Unmute";
      } else {
        gainNode.gain.value = 1;
        mute.id = "";
        mute.innerHTML = "Mute";
      }
    }

    Specifications

    Specification Status Comment
    Web Audio API
    The definition of 'gain' in that specification.
    Working Draft  

    Browser compatibility

    Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
    Basic support 10.0webkit 25.0 (25.0)  Not supported 15.0webkit
    22 (unprefixed)
    6.0webkit
    Feature Android Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
    Basic support ? 26.0 1.2 ? ? ? 33.0

    See also

    Document Tags and Contributors

    Contributors to this page:
    Last updated by: fscholz,