MediaStream

class MediaStream extends EventTarget

Annotations: @SupportedBrowser.new(SupportedBrowser.CHROME), @Native.new("MediaStream")

Inheritance

Object → EventTarget → MediaStream

Constructors

MediaStream() factory

factory MediaStream([dynamic stream_OR_tracks])

Implementation

factory MediaStream([stream_OR_tracks]) {
  if (stream_OR_tracks == null) {
    return MediaStream._create_1();
  }
  if ((stream_OR_tracks is MediaStream)) {
    return MediaStream._create_2(stream_OR_tracks);
  }
  if ((stream_OR_tracks is List<MediaStreamTrack>)) {
    return MediaStream._create_3(stream_OR_tracks);
  }
  throw new ArgumentError("Incorrect number or type of arguments");
}

Properties

active no setter

bool? get active

Implementation

bool? get active native;

hashCode no setter inherited

int get hashCode

Inherited from Interceptor.

Implementation

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

id no setter

String? get id

Implementation

String? get id 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

Events get on => new Events(this);

onAddTrack no setter

Stream<Event> get onAddTrack

Stream of addtrack events handled by this MediaStream.

Implementation

Stream<Event> get onAddTrack => addTrackEvent.forTarget(this);

onRemoveTrack no setter

Stream<Event> get onRemoveTrack

Stream of removetrack events handled by this MediaStream.

Implementation

Stream<Event> get onRemoveTrack => removeTrackEvent.forTarget(this);

runtimeType no setter inherited

Type get runtimeType

Inherited from Interceptor.

Implementation

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

Methods

addEventListener() inherited

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

Inherited from EventTarget.

Implementation

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);
  }
}

addTrack()

void addTrack(MediaStreamTrack track)

Implementation

void addTrack(MediaStreamTrack track) native;

clone()

MediaStream clone()

Implementation

MediaStream clone() native;

dispatchEvent() inherited

bool dispatchEvent(Event event)

Inherited from EventTarget.

Implementation

bool dispatchEvent(Event event) native;

getAudioTracks()

List<MediaStreamTrack> getAudioTracks()

Implementation

@Creates('JSExtendableArray|MediaStreamTrack')
@Returns('JSExtendableArray')
List<MediaStreamTrack> getAudioTracks() native;

getTrackById()

MediaStreamTrack? getTrackById(String trackId)

Implementation

MediaStreamTrack? getTrackById(String trackId) native;

getTracks()

List<MediaStreamTrack> getTracks()

Implementation

List<MediaStreamTrack> getTracks() native;

getVideoTracks()

List<MediaStreamTrack> getVideoTracks()

Implementation

@Creates('JSExtendableArray|MediaStreamTrack')
@Returns('JSExtendableArray')
List<MediaStreamTrack> getVideoTracks() 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:

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:

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

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

void removeEventListener(
  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) {
    _removeEventListener(type, listener, useCapture);
  }
}

removeTrack()

void removeTrack(MediaStreamTrack track)

Implementation

void removeTrack(MediaStreamTrack track) native;

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

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

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

Static Properties

supported no setter

bool get supported

Checks if the MediaStream APIs are supported on the current platform.

See also:

• Navigator.getUserMedia

Implementation

static bool get supported => JS(
  'bool',
  '''!!(#.getUserMedia || #.webkitGetUserMedia ||
      #.mozGetUserMedia || #.msGetUserMedia)''',
  window.navigator,
  window.navigator,
  window.navigator,
  window.navigator,
);

Constants

addTrackEvent

const EventStreamProvider<Event> addTrackEvent

Static factory designed to expose addtrack events to event handlers that are not necessarily instances of MediaStream.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> addTrackEvent =
    const EventStreamProvider<Event>('addtrack');

removeTrackEvent

const EventStreamProvider<Event> removeTrackEvent

Static factory designed to expose removetrack events to event handlers that are not necessarily instances of MediaStream.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> removeTrackEvent =
    const EventStreamProvider<Event>('removetrack');