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

All Known Implementing Classes:: StreamAudioSource

public interface StreamAudioSource extends X3DSoundSourceNode

StreamAudioSource operates as an audio source whose media is received from a MediaStream obtained using the WebRTC or Media Capture and Streams APIs.

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. StreamAudioSource node tooltip: [X3DSoundSourceNode] StreamAudioSource operates as an audio source whose media is received from a MediaStream obtained using the WebRTC or Media Capture and Streams APIs. This media source might originate from a remote microphone or sound-processing channed provided by a remote peer on a WebRTC call.\.

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

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

getChannelCountMode()

Provide String enumeration value (baseType SFString) ["MAX" | "CLAMPED_MAX" | "EXPLICIT"] from inputOutput SFString field named channelCountMode.

String

getChannelInterpretation()

Provide String enumeration value (baseType SFString) ["SPEAKERS" | "DISCRETE"] from inputOutput SFString field named channelInterpretation.

String

getDescription()

Provide String value from inputOutput SFString field named description.

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.

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.

double

getPauseTime()

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

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.

String

getStreamIdentifier()

Provide String value from inputOutput SFString field named streamIdentifier.

StreamAudioSource

setChannelCountMode(String newValue)

Accessor method to assign String enumeration value ("MAX" | "CLAMPED_MAX" | "EXPLICIT") to inputOutput SFString field named channelCountMode.

StreamAudioSource

setChannelInterpretation(String newValue)

Accessor method to assign String enumeration value ("SPEAKERS" | "DISCRETE") to inputOutput SFString field named channelInterpretation.

StreamAudioSource

setDescription(String newValue)

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

StreamAudioSource

setEnabled(boolean newValue)

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

StreamAudioSource

setGain(float newValue)

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

StreamAudioSource

setMetadata(X3DMetadataObject newValue)

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

StreamAudioSource

setPauseTime(double newValue)

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

StreamAudioSource

setResumeTime(double newValue)

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

StreamAudioSource

setStartTime(double newValue)

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

StreamAudioSource

setStopTime(double newValue)

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

StreamAudioSource

setStreamIdentifier(String newValue)

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

Method Details
- getChannelCountMode
  String getChannelCountMode()
  
  Provide String enumeration value (baseType SFString) ["MAX" | "CLAMPED_MAX" | "EXPLICIT"] from inputOutput SFString field named channelCountMode.
  
  Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode
  
  Returns:
  
  value of channelCountMode field
- setChannelCountMode
  StreamAudioSource setChannelCountMode(String newValue)
  
  Accessor method to assign String enumeration value ("MAX" | "CLAMPED_MAX" | "EXPLICIT") to inputOutput SFString field named channelCountMode.
  
  Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode
  
  Parameters:
  
  newValue - is new value for the channelCountMode field.
  
  Returns:
  
  StreamAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getChannelInterpretation
  String getChannelInterpretation()
  
  Provide String enumeration value (baseType SFString) ["SPEAKERS" | "DISCRETE"] from inputOutput SFString field named channelInterpretation.
  
  Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation
  
  Returns:
  
  value of channelInterpretation field
- setChannelInterpretation
  StreamAudioSource setChannelInterpretation(String newValue)
  
  Accessor method to assign String enumeration value ("SPEAKERS" | "DISCRETE") to inputOutput SFString field named channelInterpretation.
  
  Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation
  
  Parameters:
  
  newValue - is new value for the channelInterpretation field.
  
  Returns:
  
  StreamAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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
  StreamAudioSource 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:
  
  StreamAudioSource - 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
  
  StreamAudioSource 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:
  
  StreamAudioSource - 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
  StreamAudioSource 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:
  
  StreamAudioSource - 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
  StreamAudioSource 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:
  
  StreamAudioSource - 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
- 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
  StreamAudioSource 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:
  
  StreamAudioSource - 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
  StreamAudioSource 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:
  
  StreamAudioSource - 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
  StreamAudioSource 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:
  
  StreamAudioSource - 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
  StreamAudioSource 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:
  
  StreamAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getStreamIdentifier
  String getStreamIdentifier()
  
  Provide String value from inputOutput SFString field named streamIdentifier.
  
  Tooltip: Stream identification TBD
  
  Hint: W3C Media Capture and Streams https://www.w3.org/TR/mediacapture-streams
  
  Returns:
  
  value of streamIdentifier field
- setStreamIdentifier
  StreamAudioSource setStreamIdentifier(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named streamIdentifier.
  
  Tooltip: Stream identification TBD
  
  Hint: W3C Media Capture and Streams https://www.w3.org/TR/mediacapture-streams
  
  Parameters:
  
  newValue - is new value for the streamIdentifier field.
  
  Returns:
  
  StreamAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface StreamAudioSource

Method Summary

Method Details

getChannelCountMode

setChannelCountMode

getChannelInterpretation

setChannelInterpretation

getDescription

setDescription

getElapsedTime

getEnabled

setEnabled

getGain

setGain

getIsActive

getIsPaused

getMetadata

setMetadata

getPauseTime

setPauseTime

getResumeTime

setResumeTime

getStartTime

setStartTime

getStopTime

setStopTime

getStreamIdentifier

setStreamIdentifier