DynamicsCompressorNode extension type
The DynamicsCompressorNode interface provides a compression effect, which
lowers the volume of the loudest parts of the signal in order to help
prevent clipping and distortion that can occur when multiple sounds are
played and multiplexed together at once. This is often used in musical
production and game audio. DynamicsCompressorNode is an AudioNode that
has exactly one input and one output.
| Number of inputs | 1 | 
|---|---|
| Number of outputs | 1 | 
| Channel count mode | "clamped-max" | 
| Channel count | 2 | 
| Channel interpretation | "speakers" | 
API documentation sourced from MDN Web Docs.
- on
- Implemented types
- Available extensions
Constructors
- DynamicsCompressorNode(BaseAudioContext context, [DynamicsCompressorOptions options])
- 
          
            factory
Properties
- attack → AudioParam
- 
  The attackproperty of the DynamicsCompressorNode interface is a k-rate AudioParam representing the amount of time, in seconds, required to reduce the gain by 10 dB. It defines how quickly the signal is adapted when its volume is increased.no setter
- channelCount ↔ int
- 
  The channelCountproperty 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.getter/setter pairinherited
- channelCountMode ↔ ChannelCountMode
- 
  The channelCountModeproperty of the AudioNode interface represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.getter/setter pairinherited
- channelInterpretation ↔ ChannelInterpretation
- 
  The channelInterpretationproperty 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.getter/setter pairinherited
- context → BaseAudioContext
- 
  The read-only contextproperty of the AudioNode interface returns the associated BaseAudioContext, that is the object representing the processing graph the node is participating in.no setterinherited
- hashCode → int
- 
  The hash code for this object.
  no setterinherited
- isDefinedAndNotNull → bool
- 
      Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension no setter
- isNull → bool
- 
      Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension Whether this value corresponds to JavaScriptnull.no setter
- isTruthy → JSBoolean
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result of!!in JavaScript.thisno setter
- isUndefined → bool
- 
      Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension Whether this value corresponds to JavaScriptundefined.no setter
- isUndefinedOrNull → bool
- 
      Available on JSAny?, provided by the NullableUndefineableJSAnyExtension extension no setter
- knee → AudioParam
- 
  The kneeproperty of the DynamicsCompressorNode interface is a k-rate AudioParam containing a decibel value representing the range above the threshold where the curve smoothly transitions to the compressed portion.no setter
- not → JSBoolean
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result of!in JavaScript.thisno setter
- numberOfInputs → int
- 
  The numberOfInputsproperty of the AudioNode interface returns the number of inputs feeding the node. Source nodes are defined as nodes having anumberOfInputsproperty with a value of 0.no setterinherited
- numberOfOutputs → int
- 
  The numberOfOutputsproperty 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.no setterinherited
- 
  onEnded
  → Stream<Event> 
- 
      Available on AudioNode, provided by the AutoElementEventGetters extension no setter
- ratio → AudioParam
- 
  The ratioproperty of the DynamicsCompressorNode interface Is a k-rate AudioParam representing the amount of change, in dB, needed in the input for a 1 dB change in the output.no setter
- reduction → double
- 
  The reductionread-only property of the DynamicsCompressorNode interface is a float representing the amount of gain reduction currently applied by the compressor to the signal.no setter
- release → AudioParam
- 
  The releaseproperty of the DynamicsCompressorNode interface Is a k-rate AudioParam representing the amount of time, in seconds, required to increase the gain by 10 dB. It defines how quick the signal is adapted when its volume is reduced.no setter
- runtimeType → Type
- 
  A representation of the runtime type of the object.
  no setterinherited
- threshold → AudioParam
- 
  The thresholdproperty of the DynamicsCompressorNode interface is a k-rate AudioParam representing the decibel value above which the compression will start taking effect.no setter
Methods
- 
  add(JSAny? any) → JSAny 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis+any
- 
  addEventListener(String type, EventListener? callback, [JSAny options]) → void 
- 
  The addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.inherited
- 
  and(JSAny? any) → JSAny? 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis&&any
- 
  callMethod<R extends JSAny?> (JSAny method, [JSAny? arg1, JSAny? arg2, JSAny? arg3, JSAny? arg4]) → R 
- 
      Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension Callsmethodon this JSObject with up to four arguments.
- 
  callMethodVarArgs<R extends JSAny?> (JSAny method, [List< JSAny?> ? arguments]) → R
- 
      Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension Callsmethodon this JSObject with a variable number ofarguments.
- 
  connect(JSObject destinationNodeOrDestinationParam, [int output, int input]) → AudioNode? 
- 
  The connect()method of the AudioNode interface lets you connect one of the node's outputs to a target, which may be either anotherAudioNode(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.inherited
- 
  dartify() → Object? 
- 
      Available on JSAny?, provided by the JSAnyUtilityExtension extension Converts a JavaScript JSON-like value to the Dart equivalent if possible.
- 
  delete(JSAny property) → JSBoolean 
- 
      Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension Deletes the property with keypropertyfrom this JSObject.
- 
  disconnect([JSAny destinationNodeOrDestinationParamOrOutput, int output, int input]) → void 
- 
  The disconnect()method of the AudioNode interface lets you disconnect one or more nodes from the node on which the method is called.inherited
- 
  dispatchEvent(Event event) → bool 
- 
  The dispatchEvent()method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually withdispatchEvent().inherited
- 
  divide(JSAny? any) → JSAny 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis/any
- 
  equals(JSAny? any) → JSBoolean 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis==any
- 
  exponentiate(JSAny? any) → JSAny 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis**any
- 
  getProperty<R extends JSAny?> (JSAny property) → R 
- 
      Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension The value of the property keypropertyof this JSObject.
- 
  greaterThan(JSAny? any) → JSBoolean 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis>any
- 
  greaterThanOrEqualTo(JSAny? any) → JSBoolean 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis>=any
- 
  has(String property) → bool 
- 
      Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension Shorthand helper for hasProperty to check whether this JSObject contains the property keyproperty, but takes and returns a Dart value.
- 
  hasProperty(JSAny property) → JSBoolean 
- 
      Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension Whether or not this JSObject contains the property keyproperty.
- 
  instanceof(JSFunction constructor) → bool 
- 
      Available on JSAny?, provided by the JSAnyUtilityExtension extension Whether thisJSAny?is aninstanceofconstructor.
- 
  instanceOfString(String constructorName) → bool 
- 
      Available on JSAny?, provided by the JSAnyUtilityExtension extension Whether thisJSAny?is aninstanceofthe constructor that is defined byconstructorName, which is looked up in the globalContext.
- 
  isA<T extends JSAny?> () → bool 
- 
      Available on JSAny?, provided by the JSAnyUtilityExtension extension Whether thisJSAny?is an instance of the JavaScript type that is declared byT.
- 
  lessThan(JSAny? any) → JSBoolean 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis<any
- 
  lessThanOrEqualTo(JSAny? any) → JSBoolean 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis<=any
- 
  modulo(JSAny? any) → JSAny 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis%any
- 
  multiply(JSAny? any) → JSAny 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis*any
- 
  noSuchMethod(Invocation invocation) → dynamic 
- 
  Invoked when a nonexistent method or property is accessed.
  inherited
- 
  notEquals(JSAny? any) → JSBoolean 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis!=any
- 
  or(JSAny? any) → JSAny? 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis||any
- 
  removeEventListener(String type, EventListener? callback, [JSAny options]) → void 
- 
  The removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.inherited
- 
  setProperty(JSAny property, JSAny? value) → void 
- 
      Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension Write thevalueof property keypropertyof this JSObject.
- 
  strictEquals(JSAny? any) → JSBoolean 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis===any
- 
  strictNotEquals(JSAny? any) → JSBoolean 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis!==any
- 
  subtract(JSAny? any) → JSAny 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis-any
- 
  toString() → String 
- 
  A string representation of this object.
  inherited
- 
  typeofEquals(String typeString) → bool 
- 
      Available on JSAny?, provided by the JSAnyUtilityExtension extension Whether the result oftypeofon thisJSAny?istypeString.
- 
  unsignedRightShift(JSAny? any) → JSNumber 
- 
      Available on JSAny?, provided by the JSAnyOperatorExtension extension The result ofthis>>>any
Operators
- 
  operator ==(Object other) → bool 
- 
  The equality operator.
  inherited
- 
  operator [](String property) → JSAny? 
- 
      Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension Shorthand helper for getProperty to get the value of the property keypropertyof this JSObject, but takes a Dart value.
- 
  operator []=(String property, JSAny? value) → void 
- 
      Available on JSObject, provided by the JSObjectUnsafeUtilExtension extension Shorthand helper for setProperty to write thevalueof the property keypropertyof this JSObject, but takes a Dart value.