akasha.media

Interface MediaTrackSettings.Builder

All Superinterfaces:

MediaTrackSettings

Enclosing interface:

MediaTrackSettings

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="MediaTrackSettings")
public static interface MediaTrackSettings.Builder
extends MediaTrackSettings

The MediaTrackSettings dictionary is used to return the current values configured for each of a MediaStreamTrack's settings. These values will adhere as closely as possible to any constraints previously described using a MediaTrackConstraints object and set using applyConstraints(), and will adhere to the default constraints for any properties whose constraints haven't been changed, or whose customized constraints couldn't be matched.

See Also:

MediaTrackSettings - MDN, # media-track-settings, # extensions-to-mediatracksettings

Nested Class Summary

Nested classes/interfaces inherited from interface akasha.media.MediaTrackSettings

MediaTrackSettings.Builder

Method Summary

Modifier and Type	Method and Description
default MediaTrackSettings.Builder	aspectRatio(double aspectRatio) The MediaTrackSettings dictionary's aspectRatio property is a double-precision floating-point number indicating the aspect ratio of the MediaStreamTrack as currently configured.
default MediaTrackSettings.Builder	autoGainControl(boolean autoGainControl) The MediaTrackSettings dictionary's autoGainControl property is a Boolean value whose value indicates whether or not automatic gain control (AGC) is enabled on an audio track.
default MediaTrackSettings.Builder	channelCount(int channelCount) The MediaTrackSettings dictionary's channelCount property is an integer indicating how many audio channel the MediaStreamTrack is currently configured to have.
default MediaTrackSettings.Builder	cursor(java.lang.String cursor) The MediaTrackSettings dictionary's cursor property indicates whether or not the cursor should be captured as part of the video track included in the MediaStream returned by getDisplayMedia().
default MediaTrackSettings.Builder	deviceId(java.lang.String deviceId) The MediaTrackSettings dictionary's deviceId property is a DOMString which uniquely identifies the source for the corresponding MediaStreamTrack for the origin corresponding to the browsing session.
default MediaTrackSettings.Builder	displaySurface(java.lang.String displaySurface) The MediaTrackSettings dictionary's displaySurface property indicates the type of display surface being captured.
default MediaTrackSettings.Builder	echoCancellation(boolean echoCancellation) The MediaTrackSettings dictionary's echoCancellation property is a Boolean value whose value indicates whether or not echo cancellation is enabled on an audio track.
default MediaTrackSettings.Builder	facingMode(java.lang.String facingMode) The MediaTrackSettings dictionary's facingMode property is a DOMString indicating the direction in which the camera producing the video track represented by the MediaStreamTrack is currently facing.
default MediaTrackSettings.Builder	frameRate(double frameRate) The MediaTrackSettings dictionary's frameRate property is a double-precision floating-point number indicating the frame rate, in frames per second, of the MediaStreamTrack as currently configured.
default MediaTrackSettings.Builder	groupId(java.lang.String groupId) The MediaTrackSettings dictionary's groupId property is a browsing-session unique DOMString which identifies the group of devices which includes the source for the MediaStreamTrack.
default MediaTrackSettings.Builder	height(int height) The MediaTrackSettings dictionary's height property is an integer indicating the number of pixels tall MediaStreamTrack is currently configured to be.
default MediaTrackSettings.Builder	latency(double latency) The MediaTrackSettings dictionary's latency property is a double-precision floating-point number indicating the estimated latency (specified in seconds) of the MediaStreamTrack as currently configured.
default MediaTrackSettings.Builder	logicalSurface(boolean logicalSurface)
default MediaTrackSettings.Builder	noiseSuppression(boolean noiseSuppression) The MediaTrackSettings dictionary's noiseSuppression property is a Boolean value whose value indicates whether or not noise suppression technology is enabled on an audio track.
default MediaTrackSettings.Builder	resizeMode(java.lang.String resizeMode)
default MediaTrackSettings.Builder	restrictOwnAudio(boolean restrictOwnAudio)
default MediaTrackSettings.Builder	sampleRate(int sampleRate) The MediaTrackSettings dictionary's sampleRate property is an integer indicating how many audio samples per second the MediaStreamTrack is currently configured for.
default MediaTrackSettings.Builder	sampleSize(int sampleSize) The MediaTrackSettings dictionary's sampleSize property is an integer indicating the linear sample size (in bits per sample) the MediaStreamTrack is currently configured for.
default MediaTrackSettings.Builder	width(int width) The MediaTrackSettings dictionary's width property is an integer indicating the number of pixels wide MediaStreamTrack is currently configured to be.

Methods inherited from interface akasha.media.MediaTrackSettings

aspectRatio, autoGainControl, channelCount, create, cursor, deviceId, displaySurface, echoCancellation, facingMode, frameRate, groupId, height, latency, logicalSurface, noiseSuppression, resizeMode, restrictOwnAudio, sampleRate, sampleSize, setAspectRatio, setAutoGainControl, setChannelCount, setCursor, setDeviceId, setDisplaySurface, setEchoCancellation, setFacingMode, setFrameRate, setGroupId, setHeight, setLatency, setLogicalSurface, setNoiseSuppression, setResizeMode, setRestrictOwnAudio, setSampleRate, setSampleSize, setWidth, width

Method Detail

aspectRatio

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder aspectRatio(double aspectRatio)

The MediaTrackSettings dictionary's aspectRatio property is a double-precision floating-point number indicating the aspect ratio of the MediaStreamTrack as currently configured. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.aspectRatio property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.aspectRatio - MDN, aspectRatio - Media Capture and Streams

autoGainControl

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder autoGainControl(boolean autoGainControl)

The MediaTrackSettings dictionary's autoGainControl property is a Boolean value whose value indicates whether or not automatic gain control (AGC) is enabled on an audio track. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.autoGainControl property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.autoGainControl - MDN, autoGainControl - Media Capture and Streams

channelCount

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder channelCount(int channelCount)

The MediaTrackSettings dictionary's channelCount property is an integer indicating how many audio channel the MediaStreamTrack is currently configured to have. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.channelCount property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.channelCount - MDN, channelCount - Media Capture and Streams

deviceId

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder deviceId(@Nonnull
                                                                 java.lang.String deviceId)

The MediaTrackSettings dictionary's deviceId property is a DOMString which uniquely identifies the source for the corresponding MediaStreamTrack for the origin corresponding to the browsing session. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.deviceId property you provided when calling either getUserMedia().

See Also:

MediaTrackSettings.deviceId - MDN, deviceId - Media Capture and Streams

echoCancellation

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder echoCancellation(boolean echoCancellation)

The MediaTrackSettings dictionary's echoCancellation property is a Boolean value whose value indicates whether or not echo cancellation is enabled on an audio track. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.echoCancellation property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.echoCancellation - MDN, echoCancellation - Media Capture and Streams

facingMode

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder facingMode(@Nonnull
                                                                   java.lang.String facingMode)

The MediaTrackSettings dictionary's facingMode property is a DOMString indicating the direction in which the camera producing the video track represented by the MediaStreamTrack is currently facing. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.facingMode property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.facingMode - MDN, facingMode - Media Capture and Streams

frameRate

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder frameRate(double frameRate)

The MediaTrackSettings dictionary's frameRate property is a double-precision floating-point number indicating the frame rate, in frames per second, of the MediaStreamTrack as currently configured. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.frameRate property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.frameRate - MDN, frameRate - Media Capture and Streams

groupId

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder groupId(@Nonnull
                                                                java.lang.String groupId)

The MediaTrackSettings dictionary's groupId property is a browsing-session unique DOMString which identifies the group of devices which includes the source for the MediaStreamTrack. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.groupId property you provided when calling either getUserMedia().

See Also:

MediaTrackSettings.groupId - MDN, groupId - Media Capture and Streams

height

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder height(int height)

The MediaTrackSettings dictionary's height property is an integer indicating the number of pixels tall MediaStreamTrack is currently configured to be. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.height property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.height - MDN, height - Media Capture and Streams

latency

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder latency(double latency)

The MediaTrackSettings dictionary's latency property is a double-precision floating-point number indicating the estimated latency (specified in seconds) of the MediaStreamTrack as currently configured. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.latency property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.latency - MDN, latency - Media Capture and Streams

noiseSuppression

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder noiseSuppression(boolean noiseSuppression)

The MediaTrackSettings dictionary's noiseSuppression property is a Boolean value whose value indicates whether or not noise suppression technology is enabled on an audio track. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.noiseSuppression property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.noiseSuppression - MDN, noiseSuppression - Media Capture and Streams

resizeMode

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder resizeMode(@Nonnull
                                                                   java.lang.String resizeMode)

sampleRate

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder sampleRate(int sampleRate)

The MediaTrackSettings dictionary's sampleRate property is an integer indicating how many audio samples per second the MediaStreamTrack is currently configured for. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.sampleRate property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.sampleRate - MDN, sampleRate - Media Capture and Streams

sampleSize

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder sampleSize(int sampleSize)

The MediaTrackSettings dictionary's sampleSize property is an integer indicating the linear sample size (in bits per sample) the MediaStreamTrack is currently configured for. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.sampleSize property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.sampleSize - MDN, sampleSize - Media Capture and Streams

width

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder width(int width)

The MediaTrackSettings dictionary's width property is an integer indicating the number of pixels wide MediaStreamTrack is currently configured to be. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the MediaTrackConstraints.width property you provided when calling either getUserMedia() or MediaStreamTrack.applyConstraints().

See Also:

MediaTrackSettings.width - MDN, width - Media Capture and Streams

cursor

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder cursor(@Nonnull
                                                               java.lang.String cursor)

The MediaTrackSettings dictionary's cursor property indicates whether or not the cursor should be captured as part of the video track included in the MediaStream returned by getDisplayMedia().

See Also:

MediaTrackSettings.cursor - MDN, MediaTrackSettings.cursor - Screen Capture

displaySurface

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder displaySurface(@Nonnull
                                                                       java.lang.String displaySurface)

The MediaTrackSettings dictionary's displaySurface property indicates the type of display surface being captured.

See Also:

MediaTrackSettings.displaySurface - MDN, MediaTrackSettings.displaySurface - Screen Capture

logicalSurface

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder logicalSurface(boolean logicalSurface)

restrictOwnAudio

@JsOverlay
 @Nonnull
default MediaTrackSettings.Builder restrictOwnAudio(boolean restrictOwnAudio)