Dart API

Appearance

dart:web_audio›Classes›OfflineAudioContext

OfflineAudioContext ​

class OfflineAudioContext extends BaseAudioContext

Annotations: @Native.new("OfflineAudioContext")

Inheritance

Object → EventTarget → BaseAudioContext → OfflineAudioContext

Constructors ​

OfflineAudioContext() factory ​

factory OfflineAudioContext(
  dynamic numberOfChannels_OR_options, [
  int? numberOfFrames,
  num? sampleRate,
])
Implementation
dart
factory OfflineAudioContext(
  numberOfChannels_OR_options, [
  int? numberOfFrames,
  num? sampleRate,
]) {
  if ((sampleRate is num) &&
      (numberOfFrames is int) &&
      (numberOfChannels_OR_options is int)) {
    return OfflineAudioContext._create_1(
      numberOfChannels_OR_options,
      numberOfFrames,
      sampleRate,
    );
  }
  if ((numberOfChannels_OR_options is Map) &&
      numberOfFrames == null &&
      sampleRate == null) {
    var options_1 = convertDartToNative_Dictionary(
      numberOfChannels_OR_options,
    );
    return OfflineAudioContext._create_2(options_1);
  }
  throw new ArgumentError("Incorrect number or type of arguments");
}

Properties ​

currentTime no setter inherited ​

num? get currentTime

Inherited from BaseAudioContext.

Implementation
dart
num? get currentTime native;

destination no setter inherited ​

AudioDestinationNode? get destination

Inherited from BaseAudioContext.

Implementation
dart
AudioDestinationNode? get destination native;

hashCode no setter inherited ​

int get hashCode

Inherited from Interceptor.

Implementation
dart
int get hashCode => Primitives.objectHashCode(this);

length no setter ​

int? get length
Implementation
dart
int? get length native;

listener no setter inherited ​

AudioListener? get listener

Inherited from BaseAudioContext.

Implementation
dart
AudioListener? get listener native;

on no setter inherited ​

Events get on

This is an ease-of-use accessor for event streams which should only be used when an explicit accessor is not available.

Inherited from EventTarget.

Implementation
dart
Events get on => new Events(this);

runtimeType no setter inherited ​

Type get runtimeType

Inherited from Interceptor.

Implementation
dart
Type get runtimeType =>
    getRuntimeTypeOfInterceptorNotArray(getInterceptor(this), this);

sampleRate no setter inherited ​

num? get sampleRate

Inherited from BaseAudioContext.

Implementation
dart
num? get sampleRate native;

state no setter inherited ​

String? get state

Inherited from BaseAudioContext.

Implementation
dart
String? get state native;

Methods ​

addEventListener() inherited ​

void addEventListener(
  String type,
  (dynamic Function(Event event))? listener, [
  bool? useCapture,
])

Inherited from EventTarget.

Implementation
dart
void addEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  // TODO(leafp): This check is avoid a bug in our dispatch code when
  // listener is null.  The browser treats this call as a no-op in this
  // case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _addEventListener(type, listener, useCapture);
  }
}

createAnalyser() inherited ​

AnalyserNode createAnalyser()

Inherited from BaseAudioContext.

Implementation
dart
AnalyserNode createAnalyser() native;

createBiquadFilter() inherited ​

BiquadFilterNode createBiquadFilter()

Inherited from BaseAudioContext.

Implementation
dart
BiquadFilterNode createBiquadFilter() native;

createBuffer() inherited ​

AudioBuffer createBuffer(
  int numberOfChannels,
  int numberOfFrames,
  num sampleRate,
)

Inherited from BaseAudioContext.

Implementation
dart
AudioBuffer createBuffer(
  int numberOfChannels,
  int numberOfFrames,
  num sampleRate,
) native;

createBufferSource() inherited ​

AudioBufferSourceNode createBufferSource()

Inherited from BaseAudioContext.

Implementation
dart
AudioBufferSourceNode createBufferSource() native;

createChannelMerger() inherited ​

ChannelMergerNode createChannelMerger([int? numberOfInputs])

Inherited from BaseAudioContext.

Implementation
dart
ChannelMergerNode createChannelMerger([int? numberOfInputs]) native;

createChannelSplitter() inherited ​

ChannelSplitterNode createChannelSplitter([int? numberOfOutputs])

Inherited from BaseAudioContext.

Implementation
dart
ChannelSplitterNode createChannelSplitter([int? numberOfOutputs]) native;

createConstantSource() inherited ​

ConstantSourceNode createConstantSource()

Inherited from BaseAudioContext.

Implementation
dart
ConstantSourceNode createConstantSource() native;

createConvolver() inherited ​

ConvolverNode createConvolver()

Inherited from BaseAudioContext.

Implementation
dart
ConvolverNode createConvolver() native;

createDelay() inherited ​

DelayNode createDelay([num? maxDelayTime])

Inherited from BaseAudioContext.

Implementation
dart
DelayNode createDelay([num? maxDelayTime]) native;

createDynamicsCompressor() inherited ​

DynamicsCompressorNode createDynamicsCompressor()

Inherited from BaseAudioContext.

Implementation
dart
DynamicsCompressorNode createDynamicsCompressor() native;

createGain() inherited ​

GainNode createGain()

Inherited from BaseAudioContext.

Implementation
dart
GainNode createGain() native;

createIirFilter() inherited ​

IirFilterNode createIirFilter(List<num> feedForward, List<num> feedBack)

Inherited from BaseAudioContext.

Implementation
dart
@JSName('createIIRFilter')
IirFilterNode createIirFilter(
  List<num> feedForward,
  List<num> feedBack,
) native;

createMediaElementSource() inherited ​

MediaElementAudioSourceNode createMediaElementSource(MediaElement mediaElement)

Inherited from BaseAudioContext.

Implementation
dart
MediaElementAudioSourceNode createMediaElementSource(
  MediaElement mediaElement,
) native;

createMediaStreamDestination() inherited ​

MediaStreamAudioDestinationNode createMediaStreamDestination()

Inherited from BaseAudioContext.

Implementation
dart
MediaStreamAudioDestinationNode createMediaStreamDestination() native;

createMediaStreamSource() inherited ​

MediaStreamAudioSourceNode createMediaStreamSource(MediaStream mediaStream)

Inherited from BaseAudioContext.

Implementation
dart
MediaStreamAudioSourceNode createMediaStreamSource(
  MediaStream mediaStream,
) native;

createOscillator() inherited ​

OscillatorNode createOscillator()

Inherited from BaseAudioContext.

Implementation
dart
OscillatorNode createOscillator() native;

createPanner() inherited ​

PannerNode createPanner()

Inherited from BaseAudioContext.

Implementation
dart
PannerNode createPanner() native;

createPeriodicWave() inherited ​

PeriodicWave createPeriodicWave(
  List<num> real,
  List<num> imag, [
  Map<dynamic, dynamic>? options,
])

Inherited from BaseAudioContext.

Implementation
dart
PeriodicWave createPeriodicWave(
  List<num> real,
  List<num> imag, [
  Map? options,
]) {
  if (options != null) {
    var options_1 = convertDartToNative_Dictionary(options);
    return _createPeriodicWave_1(real, imag, options_1);
  }
  return _createPeriodicWave_2(real, imag);
}

createScriptProcessor() inherited ​

ScriptProcessorNode createScriptProcessor([
  int? bufferSize,
  int? numberOfInputChannels,
  int? numberOfOutputChannels,
])

Inherited from BaseAudioContext.

Implementation
dart
ScriptProcessorNode createScriptProcessor([
  int? bufferSize,
  int? numberOfInputChannels,
  int? numberOfOutputChannels,
]) native;

createStereoPanner() inherited ​

StereoPannerNode createStereoPanner()

Inherited from BaseAudioContext.

Implementation
dart
StereoPannerNode createStereoPanner() native;

createWaveShaper() inherited ​

WaveShaperNode createWaveShaper()

Inherited from BaseAudioContext.

Implementation
dart
WaveShaperNode createWaveShaper() native;

decodeAudioData() inherited ​

Future<AudioBuffer> decodeAudioData(
  ByteBuffer audioData, [
  (void Function(AudioBuffer decodedData))? successCallback,
  (void Function(DomException error))? errorCallback,
])

Inherited from BaseAudioContext.

Implementation
dart
Future<AudioBuffer> decodeAudioData(
  ByteBuffer audioData, [
  DecodeSuccessCallback? successCallback,
  DecodeErrorCallback? errorCallback,
]) => promiseToFuture<AudioBuffer>(
  JS(
    "creates:AudioBuffer;",
    "#.decodeAudioData(#, #, #)",
    this,
    audioData,
    successCallback,
    errorCallback,
  ),
);

dispatchEvent() inherited ​

bool dispatchEvent(Event event)

Inherited from EventTarget.

Implementation
dart
bool dispatchEvent(Event event) native;

noSuchMethod() inherited ​

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart
class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Interceptor.

Implementation
dart
dynamic noSuchMethod(Invocation invocation) {
  throw NoSuchMethodError.withInvocation(this, invocation);
}

removeEventListener() inherited ​

void removeEventListener(
  String type,
  (dynamic Function(Event event))? listener, [
  bool? useCapture,
])

Inherited from EventTarget.

Implementation
dart
void removeEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  &#47;&#47; TODO(leafp): This check is avoid a bug in our dispatch code when
  &#47;&#47; listener is null.  The browser treats this call as a no-op in this
  &#47;&#47; case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _removeEventListener(type, listener, useCapture);
  }
}

resume() inherited ​

Future<dynamic> resume()

Inherited from BaseAudioContext.

Implementation
dart
Future resume() => promiseToFuture(JS("", "#.resume()", this));

startRendering() ​

Future<AudioBuffer> startRendering()
Implementation
dart
Future<AudioBuffer> startRendering() => promiseToFuture<AudioBuffer>(
  JS("creates:AudioBuffer;", "#.startRendering()", this),
);

suspendFor() ​

Future<dynamic> suspendFor(num suspendTime)
Implementation
dart
@JSName('suspend')
Future suspendFor(num suspendTime) =>
    promiseToFuture(JS("", "#.suspend(#)", this, suspendTime));

toString() inherited ​

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Interceptor.

Implementation
dart
String toString() => Primitives.objectToHumanReadableString(this);

Operators ​

operator ==() inherited ​

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Interceptor.

Implementation
dart
bool operator ==(Object other) => identical(this, other);