akasha.media

Class MediaStream

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.media.MediaStream

All Implemented Interfaces:

MediaProvider

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="MediaStream")
public class MediaStream
extends EventTarget
implements MediaProvider

The MediaStream interface represents a stream of media content. A stream consists of several tracks, such as video or audio tracks. Each track is specified as an instance of MediaStreamTrack.

See Also:

MediaStream - MDN, # mediastream

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable MediaStreamTrackEventHandler	onaddtrack The MediaStream.onaddtrack property is an EventHandler which specifies a function to be called when the addtrack event occurs on a MediaStream instance.
@JsNullable MediaStreamTrackEventHandler	onremovetrack The MediaStream.onremovetrack property is an EventHandler which specifies a function to be called when the removetrack event occurs on a MediaStream instance.

Constructor Summary

Constructors

Constructor and Description
MediaStream() The MediaStream() constructor returns a newly-created MediaStream, which serves as a collection of media tracks, each represented by a MediaStreamTrack object.
MediaStream(JsArray<MediaStreamTrack> tracks) The MediaStream() constructor returns a newly-created MediaStream, which serves as a collection of media tracks, each represented by a MediaStreamTrack object.
MediaStream(MediaStream stream) The MediaStream() constructor returns a newly-created MediaStream, which serves as a collection of media tracks, each represented by a MediaStreamTrack object.
MediaStream(MediaStreamTrack[] tracks) The MediaStream() constructor returns a newly-created MediaStream, which serves as a collection of media tracks, each represented by a MediaStreamTrack object.

Method Summary

Modifier and Type	Method and Description
boolean	active() The active read-only property of the MediaStream interface returns a Boolean value which is true if the stream is currently active; otherwise, it returns false.
void	addAddtrackListener(MediaStreamTrackEventListener callback)
void	addAddtrackListener(MediaStreamTrackEventListener callback, AddEventListenerOptions options)
void	addAddtrackListener(MediaStreamTrackEventListener callback, boolean useCapture)
void	addRemovetrackListener(MediaStreamTrackEventListener callback)
void	addRemovetrackListener(MediaStreamTrackEventListener callback, AddEventListenerOptions options)
void	addRemovetrackListener(MediaStreamTrackEventListener callback, boolean useCapture)
void	addTrack(MediaStreamTrack track) The MediaStream.addTrack() method adds a new track to the stream.
@JsNonNull MediaStream	clone_() The clone() method of the MediaStream interface creates a duplicate of the MediaStream.
@JsNonNull JsArray<MediaStreamTrack>	getAudioTracks() The getAudioTracks() method of the MediaStream interface returns a sequence that represents all the MediaStreamTrack objects in this stream's track set where MediaStreamTrack.kind is audio.
@JsNullable MediaStreamTrack	getTrackById(java.lang.String trackId) The MediaStream.getTrackById() method returns a MediaStreamTrack object representing the track with the specified ID string.
@JsNonNull JsArray<MediaStreamTrack>	getTracks() The getTracks() method of the MediaStream interface returns a sequence that represents all the MediaStreamTrack objects in this stream's track set, regardless of MediaStreamTrack.kind.
@JsNonNull JsArray<MediaStreamTrack>	getVideoTracks() The getVideoTracks() method of the MediaStream interface returns a sequence of MediaStreamTrack objects representing the video tracks in this stream.
java.lang.String	id() The MediaStream.id() read-only property is a DOMString containing 36 characters denoting a unique identifier (GUID) for the object.
void	removeAddtrackListener(MediaStreamTrackEventListener callback)
void	removeAddtrackListener(MediaStreamTrackEventListener callback, boolean useCapture)
void	removeAddtrackListener(MediaStreamTrackEventListener callback, EventListenerOptions options)
void	removeRemovetrackListener(MediaStreamTrackEventListener callback)
void	removeRemovetrackListener(MediaStreamTrackEventListener callback, boolean useCapture)
void	removeRemovetrackListener(MediaStreamTrackEventListener callback, EventListenerOptions options)
void	removeTrack(MediaStreamTrack track)

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

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

onaddtrack

public @JsNullable MediaStreamTrackEventHandler onaddtrack

The MediaStream.onaddtrack property is an EventHandler which specifies a function to be called when the addtrack event occurs on a MediaStream instance. This happens when a new track of any kind is added to the media stream.

See Also:

MediaStream.onaddtrack - MDN, MediaStream.onaddtrack - Media Capture and Streams

onremovetrack

public @JsNullable MediaStreamTrackEventHandler onremovetrack

The MediaStream.onremovetrack property is an EventHandler which specifies a function to be called when the removetrack event occurs on a MediaStream instance. This happens when a track of any kind is removed from the media stream.

See Also:

MediaStream.onremovetrack - MDN, MediaStream.onremovetrack - Media Capture and Streams

Constructor Detail

MediaStream

public MediaStream()

The MediaStream() constructor returns a newly-created MediaStream, which serves as a collection of media tracks, each represented by a MediaStreamTrack object.

See Also:

MediaStream.MediaStream - MDN, MediaStream - Media Capture and Streams

MediaStream

public MediaStream(@Nonnull
                   MediaStream stream)

The MediaStream() constructor returns a newly-created MediaStream, which serves as a collection of media tracks, each represented by a MediaStreamTrack object.

See Also:

MediaStream.MediaStream - MDN, MediaStream - Media Capture and Streams

MediaStream

public MediaStream(@Nonnull
                   JsArray<MediaStreamTrack> tracks)

The MediaStream() constructor returns a newly-created MediaStream, which serves as a collection of media tracks, each represented by a MediaStreamTrack object.

See Also:

MediaStream.MediaStream - MDN, MediaStream - Media Capture and Streams

MediaStream

public MediaStream(@Nonnull
                   MediaStreamTrack[] tracks)

The MediaStream() constructor returns a newly-created MediaStream, which serves as a collection of media tracks, each represented by a MediaStreamTrack object.

See Also:

MediaStream.MediaStream - MDN, MediaStream - Media Capture and Streams

Method Detail

active

@JsProperty(name="active")
public boolean active()

The active read-only property of the MediaStream interface returns a Boolean value which is true if the stream is currently active; otherwise, it returns false. A stream is considered active if at least one of its MediaStreamTracks is not in the MediaStreamTrack.ended state. Once every track has ended, the stream's active property becomes false.

See Also:

MediaStream.active - MDN, active - Media Capture and Streams

id

@JsProperty(name="id")
 @Nonnull
public java.lang.String id()

The MediaStream.id() read-only property is a DOMString containing 36 characters denoting a unique identifier (GUID) for the object.

See Also:

MediaStream.id - MDN, MediaStream.id - Media Capture and Streams

addTrack

public void addTrack(@Nonnull
                     MediaStreamTrack track)

The MediaStream.addTrack() method adds a new track to the stream. The track is specified as a parameter of type MediaStreamTrack.

See Also:

MediaStream.addTrack - MDN, addTrack() - Media Capture and Streams

clone_

@JsMethod(name="clone")
public @JsNonNull MediaStream clone_()

The clone() method of the MediaStream interface creates a duplicate of the MediaStream. This new MediaStream object has a new unique id and contains clones of every MediaStreamTrack contained by the MediaStream on which clone() was called.

See Also:

MediaStream.clone - MDN, MediaStream.clone() - Media Capture and Streams

getAudioTracks

public @JsNonNull JsArray<MediaStreamTrack> getAudioTracks()

The getAudioTracks() method of the MediaStream interface returns a sequence that represents all the MediaStreamTrack objects in this stream's track set where MediaStreamTrack.kind is audio.

See Also:

MediaStream.getAudioTracks - MDN, getAudioTracks() - Media Capture and Streams

getTrackById

public @JsNullable MediaStreamTrack getTrackById(@Nonnull
                                                 java.lang.String trackId)

The MediaStream.getTrackById() method returns a MediaStreamTrack object representing the track with the specified ID string. If there is no track with the specified ID, this method returns null.

See Also:

MediaStream.getTrackById - MDN, getTrackById() - Media Capture and Streams

getTracks

public @JsNonNull JsArray<MediaStreamTrack> getTracks()

The getTracks() method of the MediaStream interface returns a sequence that represents all the MediaStreamTrack objects in this stream's track set, regardless of MediaStreamTrack.kind.

See Also:

MediaStream.getTracks - MDN, getTracks() - Media Capture and Streams

getVideoTracks

public @JsNonNull JsArray<MediaStreamTrack> getVideoTracks()

The getVideoTracks() method of the MediaStream interface returns a sequence of MediaStreamTrack objects representing the video tracks in this stream.

See Also:

MediaStream.getVideoTracks - MDN, getVideoTracks() - Media Capture and Streams

removeTrack

public void removeTrack(@Nonnull
                        MediaStreamTrack track)

addAddtrackListener

@JsOverlay
public final void addAddtrackListener(@Nonnull
                                                 MediaStreamTrackEventListener callback,
                                                 @Nonnull
                                                 AddEventListenerOptions options)

addAddtrackListener

@JsOverlay
public final void addAddtrackListener(@Nonnull
                                                 MediaStreamTrackEventListener callback,
                                                 boolean useCapture)

addAddtrackListener

@JsOverlay
public final void addAddtrackListener(@Nonnull
                                                 MediaStreamTrackEventListener callback)

removeAddtrackListener

@JsOverlay
public final void removeAddtrackListener(@Nonnull
                                                    MediaStreamTrackEventListener callback,
                                                    @Nonnull
                                                    EventListenerOptions options)

removeAddtrackListener

@JsOverlay
public final void removeAddtrackListener(@Nonnull
                                                    MediaStreamTrackEventListener callback,
                                                    boolean useCapture)

removeAddtrackListener

@JsOverlay
public final void removeAddtrackListener(@Nonnull
                                                    MediaStreamTrackEventListener callback)

addRemovetrackListener

@JsOverlay
public final void addRemovetrackListener(@Nonnull
                                                    MediaStreamTrackEventListener callback,
                                                    @Nonnull
                                                    AddEventListenerOptions options)

addRemovetrackListener

@JsOverlay
public final void addRemovetrackListener(@Nonnull
                                                    MediaStreamTrackEventListener callback,
                                                    boolean useCapture)

addRemovetrackListener

@JsOverlay
public final void addRemovetrackListener(@Nonnull
                                                    MediaStreamTrackEventListener callback)

removeRemovetrackListener

@JsOverlay
public final void removeRemovetrackListener(@Nonnull
                                                       MediaStreamTrackEventListener callback,
                                                       @Nonnull
                                                       EventListenerOptions options)

removeRemovetrackListener

@JsOverlay
public final void removeRemovetrackListener(@Nonnull
                                                       MediaStreamTrackEventListener callback,
                                                       boolean useCapture)

removeRemovetrackListener

@JsOverlay
public final void removeRemovetrackListener(@Nonnull
                                                       MediaStreamTrackEventListener callback)