akasha.media

Class MediaStreamTrack

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.media.MediaStreamTrack

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

The MediaStreamTrack interface represents a single media track within a stream; typically, these are audio or video tracks, but other track types may exist as well.

See Also:

MediaStreamTrack - MDN, # mediastreamtrack

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enabled The enabled property on the MediaStreamTrack interface is a Boolean value which is true if the track is allowed to render the source stream or false if it is not.
EventHandler	onended The MediaStreamTrack.onended event handler is used to specify a function which serves as an EventHandler to be called when the ended event occurs on the track.
EventHandler	onisolationchange
EventHandler	onmute MediaStreamTrack's onmute event handler is called when the mute event is received.
EventHandler	onunmute MediaStreamTrack's onunmute event handler is called when the unmute event is received.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MediaStreamTrack()

Method Summary

Modifier and Type	Method and Description
void	addEndedListener(EventListener callback)
void	addEndedListener(EventListener callback, AddEventListenerOptions options)
void	addEndedListener(EventListener callback, boolean useCapture)
void	addMuteListener(EventListener callback)
void	addMuteListener(EventListener callback, AddEventListenerOptions options)
void	addMuteListener(EventListener callback, boolean useCapture)
void	addUnmuteListener(EventListener callback)
void	addUnmuteListener(EventListener callback, AddEventListenerOptions options)
void	addUnmuteListener(EventListener callback, boolean useCapture)
Promise<java.lang.Void>	applyConstraints() The applyConstraints() method of the MediaStreamTrack interface applies a set of constraints to the track; these constraints let the Web site or app establish ideal values and acceptable ranges of values for the constrainable properties of the track, such as frame rate, dimensions, echo cancelation, and so forth.
Promise<java.lang.Void>	applyConstraints(MediaTrackConstraints constraints) The applyConstraints() method of the MediaStreamTrack interface applies a set of constraints to the track; these constraints let the Web site or app establish ideal values and acceptable ranges of values for the constrainable properties of the track, such as frame rate, dimensions, echo cancelation, and so forth.
MediaStreamTrack	clone_() The clone() method of the MediaStreamTrack interface creates a duplicate of the MediaStreamTrack.
MediaTrackCapabilities	getCapabilities() The getCapabilities() method of the MediaStreamTrack interface returns a MediaTrackCapabilities object which specifies the values or range of values which each constrainable property, based upon the platform and user agent.
MediaTrackConstraints	getConstraints() The getConstraints() method of the MediaStreamTrack interface returns a MediaTrackConstraints object containing the set of constraints most recently established for the track using a prior call to applyConstraints().
MediaTrackSettings	getSettings() The getSettings() method of the MediaStreamTrack interface returns a MediaTrackSettings object containing the current values of each of the constrainable properties for the current MediaStreamTrack.
java.lang.String	id() The MediaStreamTrack.id read-only property returns a DOMString containing a unique identifier (GUID) for the track, which is generated by the user agent.
boolean	isolated()
java.lang.String	kind() The MediaStreamTrack.kind read-only property returns a DOMString set to "audio" if the track is an audio track and to "video", if it is a video track.
java.lang.String	label() The MediaStreamTrack.label read-only property returns a DOMString containing a user agent-assigned label that identifies the track source, as in "internal microphone".
boolean	muted() The muted read-only property of the MediaStreamTrack interface returns a Boolean value indicating whether or not the track is currently unable to provide media output.
java.lang.String	readyState() The MediaStreamTrack.readyState read-only property returns an enumerated value giving the status of the track.
void	removeEndedListener(EventListener callback)
void	removeEndedListener(EventListener callback, boolean useCapture)
void	removeEndedListener(EventListener callback, EventListenerOptions options)
void	removeMuteListener(EventListener callback)
void	removeMuteListener(EventListener callback, boolean useCapture)
void	removeMuteListener(EventListener callback, EventListenerOptions options)
void	removeUnmuteListener(EventListener callback)
void	removeUnmuteListener(EventListener callback, boolean useCapture)
void	removeUnmuteListener(EventListener callback, EventListenerOptions options)
void	stop() The MediaStreamTrack.stop() method stops the 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, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

enabled

public boolean enabled

The enabled property on the MediaStreamTrack interface is a Boolean value which is true if the track is allowed to render the source stream or false if it is not. This can be used to intentionally mute a track.

See Also:

MediaStreamTrack.enabled - MDN, enabled - Media Capture and Streams

onended

@Nullable
public EventHandler onended

The MediaStreamTrack.onended event handler is used to specify a function which serves as an EventHandler to be called when the ended event occurs on the track. This event occurs when the track will no longer provide data to the stream for any reason, including the end of the media input being reached, the user revoking needed permissions, the source device being removed, or the remote peer ending a connection.

See Also:

MediaStreamTrack.onended - MDN, MediaStreamTrack.onended - Media Capture and Streams

onisolationchange

@Nullable
public EventHandler onisolationchange

onmute

@Nullable
public EventHandler onmute

MediaStreamTrack's onmute event handler is called when the mute event is received.

See Also:

MediaStreamTrack.onmute - MDN, MediaStreamTrack.onmute - Media Capture and Streams

onunmute

@Nullable
public EventHandler onunmute

MediaStreamTrack's onunmute event handler is called when the unmute event is received. Such an event is sent when the track is again able to send data.

See Also:

MediaStreamTrack.onunmute - MDN, MediaStreamTrack.onunmute - Media Capture and Streams

Constructor Detail

MediaStreamTrack

protected MediaStreamTrack()

Method Detail

id

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

The MediaStreamTrack.id read-only property returns a DOMString containing a unique identifier (GUID) for the track, which is generated by the user agent.

See Also:

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

isolated

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

kind

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

The MediaStreamTrack.kind read-only property returns a DOMString set to "audio" if the track is an audio track and to "video", if it is a video track.

See Also:

MediaStreamTrack.kind - MDN, MediaStreamTrack.kind - Media Capture and Streams

label

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

The MediaStreamTrack.label read-only property returns a DOMString containing a user agent-assigned label that identifies the track source, as in "internal microphone".

See Also:

MediaStreamTrack.label - MDN, MediaStreamTrack.label - Media Capture and Streams

muted

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

The muted read-only property of the MediaStreamTrack interface returns a Boolean value indicating whether or not the track is currently unable to provide media output.

See Also:

MediaStreamTrack.muted - MDN, muted - Media Capture and Streams

readyState

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

The MediaStreamTrack.readyState read-only property returns an enumerated value giving the status of the track.

See Also:

MediaStreamTrack.readyState - MDN, MediaStreamTrack.readyState - Media Capture and Streams

applyConstraints

@Nonnull
public Promise<java.lang.Void> applyConstraints(@Nonnull
                                                         MediaTrackConstraints constraints)

The applyConstraints() method of the MediaStreamTrack interface applies a set of constraints to the track; these constraints let the Web site or app establish ideal values and acceptable ranges of values for the constrainable properties of the track, such as frame rate, dimensions, echo cancelation, and so forth.

See Also:

MediaStreamTrack.applyConstraints - MDN, applyConstraints() - Media Capture and Streams, applyConstraints() - MediaStream Image Capture

applyConstraints

@Nonnull
public Promise<java.lang.Void> applyConstraints()

The applyConstraints() method of the MediaStreamTrack interface applies a set of constraints to the track; these constraints let the Web site or app establish ideal values and acceptable ranges of values for the constrainable properties of the track, such as frame rate, dimensions, echo cancelation, and so forth.

See Also:

MediaStreamTrack.applyConstraints - MDN, applyConstraints() - Media Capture and Streams, applyConstraints() - MediaStream Image Capture

clone_

@JsMethod(name="clone")
 @Nonnull
public MediaStreamTrack clone_()

The clone() method of the MediaStreamTrack interface creates a duplicate of the MediaStreamTrack. This new MediaStreamTrack object is identical except for its unique id.

See Also:

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

getCapabilities

@Nonnull
public MediaTrackCapabilities getCapabilities()

The getCapabilities() method of the MediaStreamTrack interface returns a MediaTrackCapabilities object which specifies the values or range of values which each constrainable property, based upon the platform and user agent.

See Also:

MediaStreamTrack.getCapabilities - MDN, getCapabilities() - Media Capture and Streams

getConstraints

@Nonnull
public MediaTrackConstraints getConstraints()

The getConstraints() method of the MediaStreamTrack interface returns a MediaTrackConstraints object containing the set of constraints most recently established for the track using a prior call to applyConstraints(). These constraints indicate values and ranges of values that the Web site or application has specified are required or acceptable for the included constrainable properties.

See Also:

MediaStreamTrack.getConstraints - MDN, getConstraints() - Media Capture and Streams

getSettings

@Nonnull
public MediaTrackSettings getSettings()

The getSettings() method of the MediaStreamTrack interface returns a MediaTrackSettings object containing the current values of each of the constrainable properties for the current MediaStreamTrack.

See Also:

MediaStreamTrack.getSettings - MDN, getSettings() - Media Capture and Streams

stop

public void stop()

The MediaStreamTrack.stop() method stops the track.

See Also:

MediaStreamTrack.stop - MDN, MediaStreamTrack.stop() - Media Capture and Streams

addEndedListener

@JsOverlay
public final void addEndedListener(@Nonnull
                                              EventListener callback,
                                              @Nonnull
                                              AddEventListenerOptions options)

addEndedListener

@JsOverlay
public final void addEndedListener(@Nonnull
                                              EventListener callback,
                                              boolean useCapture)

addEndedListener

@JsOverlay
public final void addEndedListener(@Nonnull
                                              EventListener callback)

removeEndedListener

@JsOverlay
public final void removeEndedListener(@Nonnull
                                                 EventListener callback,
                                                 @Nonnull
                                                 EventListenerOptions options)

removeEndedListener

@JsOverlay
public final void removeEndedListener(@Nonnull
                                                 EventListener callback,
                                                 boolean useCapture)

removeEndedListener

@JsOverlay
public final void removeEndedListener(@Nonnull
                                                 EventListener callback)

addMuteListener

@JsOverlay
public final void addMuteListener(@Nonnull
                                             EventListener callback,
                                             @Nonnull
                                             AddEventListenerOptions options)

addMuteListener

@JsOverlay
public final void addMuteListener(@Nonnull
                                             EventListener callback,
                                             boolean useCapture)

addMuteListener

@JsOverlay
public final void addMuteListener(@Nonnull
                                             EventListener callback)

removeMuteListener

@JsOverlay
public final void removeMuteListener(@Nonnull
                                                EventListener callback,
                                                @Nonnull
                                                EventListenerOptions options)

removeMuteListener

@JsOverlay
public final void removeMuteListener(@Nonnull
                                                EventListener callback,
                                                boolean useCapture)

removeMuteListener

@JsOverlay
public final void removeMuteListener(@Nonnull
                                                EventListener callback)

addUnmuteListener

@JsOverlay
public final void addUnmuteListener(@Nonnull
                                               EventListener callback,
                                               @Nonnull
                                               AddEventListenerOptions options)

addUnmuteListener

@JsOverlay
public final void addUnmuteListener(@Nonnull
                                               EventListener callback,
                                               boolean useCapture)

addUnmuteListener

@JsOverlay
public final void addUnmuteListener(@Nonnull
                                               EventListener callback)

removeUnmuteListener

@JsOverlay
public final void removeUnmuteListener(@Nonnull
                                                  EventListener callback,
                                                  @Nonnull
                                                  EventListenerOptions options)

removeUnmuteListener

@JsOverlay
public final void removeUnmuteListener(@Nonnull
                                                  EventListener callback,
                                                  boolean useCapture)

removeUnmuteListener

@JsOverlay
public final void removeUnmuteListener(@Nonnull
                                                  EventListener callback)