All Superinterfaces:: X3DChildNode, X3DNode, X3DSoundNode, X3DSoundSourceNode, X3DTimeDependentNode

All Known Implementing Classes:: ListenerPointSource

public interface ListenerPointSource extends X3DSoundSourceNode

ListenerPointSource node represents position and orientation of a person listening to virtual sound in the audio scene, and provides single or multiple sound channels as output.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. ListenerPointSource node tooltip: [X3DSoundSourceNode] ListenerPointSource node represents position and orientation of a person listening to virtual sound in the audio scene, and provides single or multiple sound channels as output. Multiple ListenerPointSource nodes can be active for sound processing.

Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#audiolistener

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

Method Summary

Modifier and Type

Method

Description

String

getDescription()

Provide String value from inputOutput SFString field named description.

boolean

getDopplerEnabled()

Provide boolean value from inputOutput SFBool field named dopplerEnabled.

double

getElapsedTime()

Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

float

getGain()

Provide float value from inputOutput SFFloat field named gain.

float

getInterauralDistance()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named interauralDistance.

boolean

getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

boolean

getIsPaused()

Provide boolean value from outputOnly SFBool field named isPaused.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

float[]

getOrientation()

Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.

double

getPauseTime()

Provide double value in seconds from inputOutput SFTime field named pauseTime.

float[]

getPosition()

Provide array of 3-tuple float results from inputOutput SFVec3f field named position.

double

getResumeTime()

Provide double value in seconds from inputOutput SFTime field named resumeTime.

double

getStartTime()

Provide double value in seconds from inputOutput SFTime field named startTime.

double

getStopTime()

Provide double value in seconds from inputOutput SFTime field named stopTime.

boolean

getTrackCurrentView()

Provide boolean value from inputOutput SFBool field named trackCurrentView.

ListenerPointSource

setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

ListenerPointSource

setDopplerEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named dopplerEnabled.

ListenerPointSource

setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

ListenerPointSource

setGain(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named gain.

ListenerPointSource

setInterauralDistance(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named interauralDistance.

ListenerPointSource

setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

ListenerPointSource

setOrientation(float[] newValue)

Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.

ListenerPointSource

setPauseTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.

ListenerPointSource

setPosition(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.

ListenerPointSource

setResumeTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.

ListenerPointSource

setStartTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.

ListenerPointSource

setStopTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

ListenerPointSource

setTrackCurrentView(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named trackCurrentView.

Method Details
- getDescription
  String getDescription()
  
  Provide String value from inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose of the url asset.
  
  Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
  
  Specified by:
  
  getDescription in interface X3DSoundNode
  
  Specified by:
  
  getDescription in interface X3DSoundSourceNode
  
  Specified by:
  
  getDescription in interface X3DTimeDependentNode
  
  Returns:
  
  value of description field
- setDescription
  ListenerPointSource setDescription(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named description.
  
  Tooltip: Author-provided prose that describes intended purpose of the url asset.
  
  Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
  
  Specified by:
  
  setDescription in interface X3DSoundNode
  
  Specified by:
  
  setDescription in interface X3DSoundSourceNode
  
  Specified by:
  
  setDescription in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDopplerEnabled
  boolean getDopplerEnabled()
  
  Provide boolean value from inputOutput SFBool field named dopplerEnabled.
  
  Tooltip: dopplerEnabled enables/disables whether real-time Doppler effects (due to relation motion between sources and listeners) are computed by browser between virtual sound sources and active listening locations, then applied to received frequency at active listening locations.
  
  Hint: functional support requires player support for Sound component level 3.
  
  Hint: Wikipedia Doppler effect https://en.wikipedia.org/wiki/Doppler_effect
  
  Returns:
  
  value of dopplerEnabled field
- setDopplerEnabled
  ListenerPointSource setDopplerEnabled(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named dopplerEnabled.
  
  Tooltip: dopplerEnabled enables/disables whether real-time Doppler effects (due to relation motion between sources and listeners) are computed by browser between virtual sound sources and active listening locations, then applied to received frequency at active listening locations.
  
  Hint: functional support requires player support for Sound component level 3.
  
  Hint: Wikipedia Doppler effect https://en.wikipedia.org/wiki/Doppler_effect
  
  Parameters:
  
  newValue - is new value for the dopplerEnabled field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getElapsedTime
  double getElapsedTime()
  
  Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
  
  Tooltip: [0,+infinity) Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
  
  Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
  
  Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.
  
  Specified by:
  
  getElapsedTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getElapsedTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of elapsedTime field
- getEnabled
  
  boolean getEnabled()
  
  Provide boolean value from inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  getEnabled in interface X3DSoundNode
  
  Specified by:
  
  getEnabled in interface X3DSoundSourceNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  ListenerPointSource setEnabled(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  setEnabled in interface X3DSoundNode
  
  Specified by:
  
  setEnabled in interface X3DSoundSourceNode
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getGain
  float getGain()
  
  Provide float value from inputOutput SFFloat field named gain.
  
  Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.
  
  Warning: Decibel values shall not be used.
  
  Hint: Negative gain factors negate the input signal.
  
  Specified by:
  
  getGain in interface X3DSoundSourceNode
  
  Returns:
  
  value of gain field
- setGain
  ListenerPointSource setGain(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named gain.
  
  Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.
  
  Warning: Decibel values shall not be used.
  
  Hint: Negative gain factors negate the input signal.
  
  Specified by:
  
  setGain in interface X3DSoundSourceNode
  
  Parameters:
  
  newValue - is new value for the gain field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getInterauralDistance
  
  float getInterauralDistance()
  
  Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named interauralDistance.
  
  Tooltip: [0,+infinity) The interauralDistance field is . *
  
  Returns:
  
  value of interauralDistance field
- setInterauralDistance
  
  ListenerPointSource setInterauralDistance(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named interauralDistance.
  
  Tooltip: [0,+infinity) The interauralDistance field is . *
  
  Parameters:
  
  newValue - is new value for the interauralDistance field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getIsActive
  boolean getIsActive()
  
  Provide boolean value from outputOnly SFBool field named isActive.
  
  Tooltip: isActive true/false events are sent when playback starts/stops.
  
  Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
  
  Specified by:
  
  getIsActive in interface X3DSoundSourceNode
  
  Specified by:
  
  getIsActive in interface X3DTimeDependentNode
  
  Returns:
  
  value of isActive field
- getIsPaused
  boolean getIsPaused()
  
  Provide boolean value from outputOnly SFBool field named isPaused.
  
  Tooltip: isPaused true/false events are sent when AudioClip is paused/resumed.
  
  Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
  
  Specified by:
  
  getIsPaused in interface X3DSoundSourceNode
  
  Specified by:
  
  getIsPaused in interface X3DTimeDependentNode
  
  Returns:
  
  value of isPaused field
- getMetadata
  X3DMetadataObject getMetadata()
  
  Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Specified by:
  
  getMetadata in interface X3DSoundNode
  
  Specified by:
  
  getMetadata in interface X3DSoundSourceNode
  
  Specified by:
  
  getMetadata in interface X3DTimeDependentNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  ListenerPointSource setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DSoundNode
  
  Specified by:
  
  setMetadata in interface X3DSoundSourceNode
  
  Specified by:
  
  setMetadata in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- getOrientation
  float[] getOrientation()
  
  Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named orientation.
  
  Tooltip: Rotation (axis, angle in radians) of listening point direction relative to default -Z axis direction in local coordinate system.
  
  Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness.
  
  Hint: this is orientation _change_ from default direction (0 0 -1).
  
  Hint: complex rotations can be accomplished axis-by-axis using parent Transforms.
  
  Returns:
  
  value of orientation field
- setOrientation
  ListenerPointSource setOrientation(float[] newValue)
  
  Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named orientation.
  
  Tooltip: Rotation (axis, angle in radians) of listening point direction relative to default -Z axis direction in local coordinate system.
  
  Warning: for VR/AR/MAR users wearing a head-mounted display (HMD), animating this field may induce motion sickness.
  
  Hint: this is orientation _change_ from default direction (0 0 -1).
  
  Hint: complex rotations can be accomplished axis-by-axis using parent Transforms.
  
  Parameters:
  
  newValue - is new value for the orientation field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getPauseTime
  double getPauseTime()
  
  Provide double value in seconds from inputOutput SFTime field named pauseTime.
  
  Tooltip: When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
  
  Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
  
  Specified by:
  
  getPauseTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getPauseTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of pauseTime field
- setPauseTime
  ListenerPointSource setPauseTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
  
  Tooltip: When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
  
  Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
  
  Specified by:
  
  setPauseTime in interface X3DSoundSourceNode
  
  Specified by:
  
  setPauseTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the pauseTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getPosition
  
  float[] getPosition()
  
  Provide array of 3-tuple float results from inputOutput SFVec3f field named position.
  
  Tooltip: position (x, y, z in meters) relative to local coordinate system. *
  
  Returns:
  
  value of position field
- setPosition
  
  ListenerPointSource setPosition(float[] newValue)
  
  Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named position.
  
  Tooltip: position (x, y, z in meters) relative to local coordinate system. *
  
  Parameters:
  
  newValue - is new value for the position field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getResumeTime
  double getResumeTime()
  
  Provide double value in seconds from inputOutput SFTime field named resumeTime.
  
  Tooltip: When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
  
  Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
  
  Specified by:
  
  getResumeTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getResumeTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of resumeTime field
- setResumeTime
  ListenerPointSource setResumeTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
  
  Tooltip: When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
  
  Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
  
  Specified by:
  
  setResumeTime in interface X3DSoundSourceNode
  
  Specified by:
  
  setResumeTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the resumeTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getStartTime
  double getStartTime()
  
  Provide double value in seconds from inputOutput SFTime field named startTime.
  
  Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
  
  Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
  
  Specified by:
  
  getStartTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getStartTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of startTime field
- setStartTime
  ListenerPointSource setStartTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
  
  Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
  
  Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
  
  Specified by:
  
  setStartTime in interface X3DSoundSourceNode
  
  Specified by:
  
  setStartTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the startTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getStopTime
  double getStopTime()
  
  Provide double value in seconds from inputOutput SFTime field named stopTime.
  
  Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
  
  Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
  
  Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
  
  Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
  
  Specified by:
  
  getStopTime in interface X3DSoundSourceNode
  
  Specified by:
  
  getStopTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of stopTime field
- setStopTime
  ListenerPointSource setStopTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
  
  Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
  
  Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
  
  Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
  
  Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
  
  Specified by:
  
  setStopTime in interface X3DSoundSourceNode
  
  Specified by:
  
  setStopTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the stopTime field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getTrackCurrentView
  
  boolean getTrackCurrentView()
  
  Provide boolean value from inputOutput SFBool field named trackCurrentView.
  
  Tooltip: If trackCurrentView field is true then position and orientation match avatar's (user's) current view. *
  
  Returns:
  
  value of trackCurrentView field
- setTrackCurrentView
  
  ListenerPointSource setTrackCurrentView(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named trackCurrentView.
  
  Tooltip: If trackCurrentView field is true then position and orientation match avatar's (user's) current view. *
  
  Parameters:
  
  newValue - is new value for the trackCurrentView field.
  
  Returns:
  
  ListenerPointSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface ListenerPointSource

Method Summary

Method Details

getDescription

setDescription

getDopplerEnabled

setDopplerEnabled

getElapsedTime

getEnabled

setEnabled

getGain

setGain

getInterauralDistance

setInterauralDistance

getIsActive

getIsPaused

getMetadata

setMetadata

getOrientation

setOrientation

getPauseTime

setPauseTime

getPosition

setPosition

getResumeTime

setResumeTime

getStartTime

setStartTime

getStopTime

setStopTime

getTrackCurrentView

setTrackCurrentView