Trait

org.scalajs.dom.raw

AudioParam

Related Doc: package raw

Permalink

trait AudioParam extends EventTarget with AudioNode

The AudioParam interface represents an audio-related parameter, usually a parameter of an AudioNode (such as GainNode.gain). An AudioParam can be set to a specific value or a change in value, and can be scheduled to happen at a specific time and following a specific pattern.

There are two kinds of AudioParam, a-rate and k-rate parameters:

Each AudioNode defines which of its parameters are a-rate or k-rate in the spec.

Each AudioParam has a list of events, initially empty, that define when and how values change. When this list is not empty, changes using the AudioParam.value attributes are ignored. This list of events allows us to schedule changes that have to happen at very precise times, using arbitrary timelime-based automation curves. The time used is the one defined in AudioContext.currentTime.

Annotations
@RawJSType() @native()
Linear Supertypes
AudioNode, EventTarget, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AudioParam
  2. AudioNode
  3. EventTarget
  4. Object
  5. Any
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addEventListener[T <: Event](type: String, listener: Function1[T, _], useCapture: Boolean = js.native): Unit

    Permalink

    The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on.

    The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

    MDN

    Definition Classes
    EventTarget
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def cancelScheduledValues(startTime: Double): Unit

    Permalink

    Cancels all scheduled future changes to the AudioParam.

    Cancels all scheduled future changes to the AudioParam.

    startTime

    A double representing the exact time (in seconds) after the AudioContext was first created after which all scheduled changes will be cancelled.

  7. var channelCount: Int

    Permalink

    Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.

    Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.

    Definition Classes
    AudioNode
  8. var channelCountMode: Int

    Permalink

    Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

    Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

    Definition Classes
    AudioNode
  9. var channelInterpretation: String

    Permalink

    Represents an enumerated value describing the meaning of the channels.

    Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

    The possible values are "speakers" or "discrete".

    Definition Classes
    AudioNode
  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def connect(audioParam: AudioParam): Unit

    Permalink

    Allows us to connect one output of this node to one input of an audio parameter.

    Allows us to connect one output of this node to one input of an audio parameter.

    Definition Classes
    AudioNode
  12. def connect(audioNode: AudioNode): Unit

    Permalink

    Allows us to connect one output of this node to one input of another node.

    Allows us to connect one output of this node to one input of another node.

    Definition Classes
    AudioNode
  13. val context: AudioContext

    Permalink

    Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.

    Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.

    Definition Classes
    AudioNode
  14. val defaultValue: Double

    Permalink

    Represents the initial value of the attributes as defined by the specific AudioNode creating the AudioParam.

  15. def disconnect(output: AudioNode = js.native): Unit

    Permalink

    Allows us to disconnect the current node from another one it is already connected to.

    Allows us to disconnect the current node from another one it is already connected to.

    output

    The index describing which output of the AudioNode is going to be disconnected.

    Definition Classes
    AudioNode
  16. def dispatchEvent(evt: Event): Boolean

    Permalink

    Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order.

    Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

    MDN

    Definition Classes
    EventTarget
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. def exponentialRampToValueAtTime(value: Double, endTime: Double): Unit

    Permalink

    Schedules a gradual exponential change in the value of the AudioParam.

    Schedules a gradual exponential change in the value of the AudioParam. The change starts at the time specified for the previous event, follows an exponential ramp to the new value given in the value parameter, and reaches the new value at the time given in the endTime parameter.

    value

    A floating point number representing the value the AudioParam will ramp up to by the given time.

    endTime

    A double representing the exact time (in seconds) after the ramping starts that the changing of the value will stop.

  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  22. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  26. def linearRampToValueAtTime(value: Double, endTime: Double): Unit

    Permalink

    Schedules a gradual linear change in the value of the AudioParam.

    Schedules a gradual linear change in the value of the AudioParam. The change starts at the time specified for the previous event, follows a linear ramp to the new value given in the value parameter, and reaches the new value at the time given in the endTime parameter.

    value

    A floating point number representing the value the AudioParam will ramp up to by the given time.

    endTime

    A double representing the exact time (in seconds) after the ramping starts that the changing of the value will stop.

  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. val numberOfInputs: Int

    Permalink

    Returns the number of inputs feeding the node.

    Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

    Definition Classes
    AudioNode
  31. val numberOfOutputs: Int

    Permalink

    Returns the number of outputs coming out of the node.

    Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

    Definition Classes
    AudioNode
  32. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  33. def removeEventListener[T <: Event](type: String, listener: Function1[T, _], useCapture: Boolean = js.native): Unit

    Permalink

    Removes the event listener previously registered with EventTarget.addEventListener.

    Removes the event listener previously registered with EventTarget.addEventListener.

    MDN

    Definition Classes
    EventTarget
  34. def setTargetAtTime(target: Double, startTime: Double, timeConstant: Double): Unit

    Permalink

    Schedules the start of a change to the value of the AudioParam.

    Schedules the start of a change to the value of the AudioParam. The change starts at the time specified in startTime and exponentially moves towards the value given by the target parameter. The exponential decay rate is defined by the timeConstant parameter, which is a time measured in seconds.

    target

    The value the parameter will start to transition towards at the given start time.

    startTime

    The time that the exponential transition will begin, which will be relative to AudioContext.currentTime.

    timeConstant

    The time-constant value of first-order filter (exponential) approach to the target value. The larger this value is, the slower the transition will be.

  35. def setValueAtTime(value: Double, startTime: Double): Unit

    Permalink

    Schedules an instant change to the value of the AudioParam at a precise time, as measured against AudioContext.currentTime.

    Schedules an instant change to the value of the AudioParam at a precise time, as measured against AudioContext.currentTime. The new value is given in the value parameter.

    value

    A floating point number representing the value the AudioParam will change to at the given time.

    startTime

    A double representing the exact time (in seconds) after the AudioContext was first created that the change in value will happen.

  36. def setValueCurveAtTime(values: Float32Array, startTime: Double, duration: Double): Unit

    Permalink

    Schedules the values of the AudioParam to follow a set of values, defined by the values Float32Array scaled to fit into the given interval, starting at startTime, and having a specific duration.

    Schedules the values of the AudioParam to follow a set of values, defined by the values Float32Array scaled to fit into the given interval, starting at startTime, and having a specific duration.

    values

    A Float32Array representing the value curve the AudioParam will change through along the duration.

    startTime

    A double representing the exact time (in seconds) after the AudioContext was first created that the change in value will happen.

    duration

    A double representing the exact time (in seconds) during which the values will be changed between. The values are spaced equally along this duration.

  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  38. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  39. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  40. var value: Double

    Permalink

    Represents the parameter's current floating point value; initially set to the value of AudioParam.defaultValue.

    Represents the parameter's current floating point value; initially set to the value of AudioParam.defaultValue. Though it can be set, any modifications happening while there are automation events scheduled — that is events scheduled using the methods of the AudioParam — are ignored, without raising any exception.

  41. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  42. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AudioNode

Inherited from EventTarget

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped