akasha.audio

Class AudioParam

java.lang.Object

akasha.core.JsObject

akasha.audio.AudioParam

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

The Web Audio API's AudioParam interface represents an audio-related parameter, usually a parameter of an AudioNode (such as GainNode.gain).

See Also:

AudioParam - MDN, # AudioParam

Field Summary

Fields

Modifier and Type	Field and Description
@JsNonNull java.lang.String	automationRate
float	value The Web Audio API's AudioParam interface property value gets or sets the value of this AudioParam at the current time.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AudioParam()

Method Summary

Modifier and Type	Method and Description
@JsNonNull AudioParam	cancelAndHoldAtTime(double cancelTime) The cancelAndHoldAtTime() property of the AudioParam interface cancels all scheduled future changes to the AudioParam but holds its value at a given time until further changes are made using other methods.
@JsNonNull AudioParam	cancelScheduledValues(double cancelTime) A reference to this AudioParam object.
float	defaultValue() The defaultValue read-only property of the AudioParam interface represents the initial value of the attributes as defined by the specific AudioNode creating the AudioParam.
@JsNonNull AudioParam	exponentialRampToValueAtTime(float value, double endTime) A reference to this AudioParam object.
@JsNonNull AudioParam	linearRampToValueAtTime(float value, double endTime) A reference to this AudioParam object.
float	maxValue() The maxValue read-only property of the AudioParam interface represents the maximum possible value for the parameter's nominal (effective) range.
float	minValue() The minValue read-only property of the AudioParam interface represents the minimum possible value for the parameter's nominal (effective) range.
@JsNonNull AudioParam	setTargetAtTime(float target, double startTime, float timeConstant) The setTargetAtTime() method of the AudioParam interface schedules the start of a gradual change to the AudioParam value.
@JsNonNull AudioParam	setValueAtTime(float value, double startTime) The setValueAtTime() method of the AudioParam interface schedules an instant change to the AudioParam value at a precise time, as measured against AudioContext.currentTime.
@JsNonNull AudioParam	setValueCurveAtTime(double[] values, double startTime, double duration) The setValueCurveAtTime() method of the AudioParam interface schedules the parameter's value to change following a curve defined by a list of values.
@JsNonNull AudioParam	setValueCurveAtTime(JsArray<java.lang.Double> values, double startTime, double duration) The setValueCurveAtTime() method of the AudioParam interface schedules the parameter's value to change following a curve defined by a list of values.

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

Field Detail

automationRate

@AutomationRate
public @JsNonNull java.lang.String automationRate

value

public float value

The Web Audio API's AudioParam interface property value gets or sets the value of this AudioParam at the current time.

See Also:

AudioParam.value - MDN, value - Web Audio API

Constructor Detail

AudioParam

protected AudioParam()

Method Detail

defaultValue

@JsProperty(name="defaultValue")
public float defaultValue()

The defaultValue read-only property of the AudioParam interface represents the initial value of the attributes as defined by the specific AudioNode creating the AudioParam.

See Also:

AudioParam.defaultValue - MDN, defaultValue - Web Audio API

maxValue

@JsProperty(name="maxValue")
public float maxValue()

The maxValue read-only property of the AudioParam interface represents the maximum possible value for the parameter's nominal (effective) range.

See Also:

AudioParam.maxValue - MDN, maxValue - Web Audio API

minValue

@JsProperty(name="minValue")
public float minValue()

The minValue read-only property of the AudioParam interface represents the minimum possible value for the parameter's nominal (effective) range.

See Also:

AudioParam.minValue - MDN, minValue - Web Audio API

cancelAndHoldAtTime

public @JsNonNull AudioParam cancelAndHoldAtTime(double cancelTime)

The cancelAndHoldAtTime() property of the AudioParam interface cancels all scheduled future changes to the AudioParam but holds its value at a given time until further changes are made using other methods.

See Also:

AudioParam.cancelAndHoldAtTime - MDN, cancelAndHoldAtTime() - Web Audio API

cancelScheduledValues

public @JsNonNull AudioParam cancelScheduledValues(double cancelTime)

A reference to this AudioParam object. In some older implementations this method returns void.

See Also:

AudioParam.cancelScheduledValues - MDN

exponentialRampToValueAtTime

public @JsNonNull AudioParam exponentialRampToValueAtTime(float value,
                                                          double endTime)

A reference to this AudioParam object. In some browsers older implementations of this interface return void.

See Also:

AudioParam.exponentialRampToValueAtTime - MDN

linearRampToValueAtTime

public @JsNonNull AudioParam linearRampToValueAtTime(float value,
                                                     double endTime)

A reference to this AudioParam object. In some browsers older implementations of this interface return void.

See Also:

AudioParam.linearRampToValueAtTime - MDN

setTargetAtTime

public @JsNonNull AudioParam setTargetAtTime(float target,
                                             double startTime,
                                             float timeConstant)

The setTargetAtTime() method of the AudioParam interface schedules the start of a gradual change to the AudioParam value. This is useful for decay or release portions of ADSR envelopes.

See Also:

AudioParam.setTargetAtTime - MDN

setValueAtTime

public @JsNonNull AudioParam setValueAtTime(float value,
                                            double startTime)

The setValueAtTime() method of the AudioParam interface schedules an instant change to the AudioParam value at a precise time, as measured against AudioContext.currentTime. The new value is given in the value parameter.

See Also:

AudioParam.setValueAtTime - MDN, setValueAtTime - Web Audio API

setValueCurveAtTime

public @JsNonNull AudioParam setValueCurveAtTime(@Nonnull
                                                 JsArray<java.lang.Double> values,
                                                 double startTime,
                                                 double duration)

The setValueCurveAtTime() method of the AudioParam interface schedules the parameter's value to change following a curve defined by a list of values.

See Also:

AudioParam.setValueCurveAtTime - MDN

setValueCurveAtTime

public @JsNonNull AudioParam setValueCurveAtTime(@Nonnull
                                                 double[] values,
                                                 double startTime,
                                                 double duration)

The setValueCurveAtTime() method of the AudioParam interface schedules the parameter's value to change following a curve defined by a list of values.

See Also:

AudioParam.setValueCurveAtTime - MDN