akasha.audio

Class PannerNode

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.audio.AudioNode

akasha.audio.PannerNode

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

The PannerNode interface represents the position and behavior of an audio source signal in space. It is an AudioNode audio-processing module describing its position with right-hand Cartesian coordinates, its movement using a velocity vector and its directionality using a directionality cone.

See Also:

PannerNode - MDN, # PannerNode

Field Summary

Fields

Modifier and Type	Field and Description
double	coneInnerAngle A double.
double	coneOuterAngle A double.
double	coneOuterGain The coneOuterGain property of the PannerNode interface is a double value, describing the amount of volume reduction outside the cone, defined by the coneOuterAngle attribute.
@JsNonNull java.lang.String	distanceModel A enum — see DistanceModelType.
double	maxDistance A double.
@JsNonNull java.lang.String	panningModel A enum — see PanningModelType.
double	refDistance A non-negative number.
double	rolloffFactor A number whose range depends on the distanceModel of the panner as follows (negative values are not allowed):

Fields inherited from class akasha.audio.AudioNode

channelCount, channelCountMode, channelInterpretation

Constructor Summary

Constructors

Constructor and Description
PannerNode(BaseAudioContext context) The PannerNode() constructor of the Web Audio API creates a new PannerNode object instance.
PannerNode(BaseAudioContext context, PannerOptions options) The PannerNode() constructor of the Web Audio API creates a new PannerNode object instance.

Method Summary

Modifier and Type	Method and Description
AudioParam	orientationX() An AudioParam whose value is the X component of the direction in which the audio source is facing, in 3D Cartesian coordinate space.
AudioParam	orientationY() An AudioParam whose value is the Y component of the direction the audio source is facing, in 3D Cartesian coordinate space.
AudioParam	orientationZ() An AudioParam whose value is the Z component of the direction the audio source is facing, in 3D Cartesian coordinate space.
AudioParam	positionX() An AudioParam whose value is the X coordinate of the audio source's position, in 3D Cartesian coordinates.
AudioParam	positionY() An AudioParam whose value is the Y coordinate of the audio source's position, in 3D Cartesian coordinates.
AudioParam	positionZ() An AudioParam whose value is the Z coordinate of the audio source's position, in 3D Cartesian coordinates.
void	setOrientation(float x, float y, float z) Void.
void	setPosition(float x, float y, float z) Void.

Methods inherited from class akasha.audio.AudioNode

connect, connect, connect, connect, connect, context, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, numberOfInputs, numberOfOutputs

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

coneInnerAngle

public double coneInnerAngle

A double.

See Also:

PannerNode.coneInnerAngle - MDN, coneInnerAngle - Web Audio API

coneOuterAngle

public double coneOuterAngle

A double.

See Also:

PannerNode.coneOuterAngle - MDN, coneOuterAngle - Web Audio API

coneOuterGain

public double coneOuterGain

The coneOuterGain property of the PannerNode interface is a double value, describing the amount of volume reduction outside the cone, defined by the coneOuterAngle attribute.

See Also:

PannerNode.coneOuterGain - MDN, coneOuterGain - Web Audio API

distanceModel

@DistanceModelType
public @JsNonNull java.lang.String distanceModel

A enum — see DistanceModelType.

See Also:

PannerNode.distanceModel - MDN, distanceModel - Web Audio API

maxDistance

public double maxDistance

A double. The default is 10000, and non-positive values are not allowed.

See Also:

PannerNode.maxDistance - MDN, maxDistance - Web Audio API

panningModel

@PanningModelType
public @JsNonNull java.lang.String panningModel

A enum — see PanningModelType.

See Also:

PannerNode.panningModel - MDN, panningModel - Web Audio API

refDistance

public double refDistance

A non-negative number. If the value is set to less than 0, a RangeError is thrown.

See Also:

PannerNode.refDistance - MDN, refDistance - Web Audio API

rolloffFactor

public double rolloffFactor

A number whose range depends on the distanceModel of the panner as follows (negative values are not allowed):

See Also:

PannerNode.rolloffFactor - MDN, rolloffFactor - Web Audio API

Constructor Detail

PannerNode

public PannerNode(@Nonnull
                  BaseAudioContext context,
                  @Nonnull
                  PannerOptions options)

The PannerNode() constructor of the Web Audio API creates a new PannerNode object instance.

See Also:

PannerNode.PannerNode - MDN, PannerNode() - Web Audio API

PannerNode

public PannerNode(@Nonnull
                  BaseAudioContext context)

The PannerNode() constructor of the Web Audio API creates a new PannerNode object instance.

See Also:

PannerNode.PannerNode - MDN, PannerNode() - Web Audio API

Method Detail

orientationX

@JsProperty(name="orientationX")
 @Nonnull
public AudioParam orientationX()

An AudioParam whose value is the X component of the direction in which the audio source is facing, in 3D Cartesian coordinate space.

See Also:

PannerNode.orientationX - MDN, orientationX - Web Audio API

orientationY

@JsProperty(name="orientationY")
 @Nonnull
public AudioParam orientationY()

An AudioParam whose value is the Y component of the direction the audio source is facing, in 3D Cartesian coordinate space.

See Also:

PannerNode.orientationY - MDN, orientationY - Web Audio API

orientationZ

@JsProperty(name="orientationZ")
 @Nonnull
public AudioParam orientationZ()

An AudioParam whose value is the Z component of the direction the audio source is facing, in 3D Cartesian coordinate space.

See Also:

PannerNode.orientationZ - MDN, orientationZ - Web Audio API

positionX

@JsProperty(name="positionX")
 @Nonnull
public AudioParam positionX()

An AudioParam whose value is the X coordinate of the audio source's position, in 3D Cartesian coordinates. The default value is 0.

See Also:

PannerNode.positionX - MDN, positionX - Web Audio API

positionY

@JsProperty(name="positionY")
 @Nonnull
public AudioParam positionY()

An AudioParam whose value is the Y coordinate of the audio source's position, in 3D Cartesian coordinates.

See Also:

PannerNode.positionY - MDN, positionY - Web Audio API

positionZ

@JsProperty(name="positionZ")
 @Nonnull
public AudioParam positionZ()

An AudioParam whose value is the Z coordinate of the audio source's position, in 3D Cartesian coordinates.

See Also:

PannerNode.positionZ - MDN, positionZ - Web Audio API

setOrientation

public void setOrientation(float x,
                           float y,
                           float z)

Void.

See Also:

PannerNode.setOrientation - MDN, setOrientation() - Web Audio API

setPosition

public void setPosition(float x,
                        float y,
                        float z)

Void.

See Also:

PannerNode.setPosition - MDN, setPosition() - Web Audio API