GainNode

open class GainNode(context: BaseAudioContext, options: GainOptions = definedExternally) : AudioNode(source)

The GainNode interface represents a change in volume. It is an AudioNode audio-processing module that causes a given gain to be applied to the input data before its propagation to the output. A GainNode always has exactly one input and one output, both with the same number of channels.

MDN Reference

Constructors

GainNode

constructor(context: BaseAudioContext, options: GainOptions = definedExternally)

Properties

channelCount

var channelCount: Int

The channelCount property of the AudioNode interface represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.

channelCountMode

var channelCountMode: ChannelCountMode

The channelCountMode property of the AudioNode interface represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

channelInterpretation

var channelInterpretation: ChannelInterpretation

The channelInterpretation property of the AudioNode interface represents an enumerated value describing how input channels are mapped to output channels when the number of inputs/outputs is different. For example, this setting defines how a mono input will be up-mixed to a stereo or 5.1 channel output, or how a quad channel input will be down-mixed to a stereo or mono output.

context

val context: BaseAudioContext

The read-only context property of the AudioNode interface returns the associated BaseAudioContext, that is the object representing the processing graph the node is participating in.

gain

val gain: AudioParam

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

numberOfInputs

val numberOfInputs: Int

The numberOfInputs property of the AudioNode interface returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

numberOfOutputs

val numberOfOutputs: Int

The numberOfOutputs property of the AudioNode interface returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

Functions

connect

fun connect(destinationParam: AudioParam, output: Int = definedExternally)

fun connect(destinationNode: AudioNode, output: Int = definedExternally, input: Int = definedExternally): AudioNode

The connect() method of the AudioNode interface lets you connect one of the node's outputs to a target, which may be either another AudioNode (thereby directing the sound data to the specified node) or an AudioParam, so that the node's output data is automatically used to change the value of that parameter over time.

disconnect

fun disconnect()

The disconnect() method of the AudioNode interface lets you disconnect one or more nodes from the node on which the method is called.

fun disconnect(output: Int)

fun disconnect(destinationNode: AudioNode)

fun disconnect(destinationParam: AudioParam)

fun disconnect(destinationNode: AudioNode, output: Int)

fun disconnect(destinationParam: AudioParam, output: Int)

fun disconnect(destinationNode: AudioNode, output: Int, input: Int)

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>