Class StreamAudioSource

All Implemented Interfaces:
X3DChildNode, X3DNode, StreamAudioSource, X3DSoundNode, X3DSoundSourceNode, X3DTimeDependentNode

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

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.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
  • Field Details

    • CHANNELCOUNTMODE_MAX

      public static final String CHANNELCOUNTMODE_MAX
      Tooltip: X3D version of "max" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "MAX" (Java syntax) or MAX (XML syntax).
      See Also:
    • CHANNELCOUNTMODE_MAX_ALIAS

      public static final String CHANNELCOUNTMODE_MAX_ALIAS
      SFString SFString enumeration value "MAX" has alias "max"
      See Also:
    • CHANNELCOUNTMODE_CLAMPED_MAX

      public static final String CHANNELCOUNTMODE_CLAMPED_MAX
      Tooltip: X3D version of "clamped-max" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "CLAMPED_MAX" (Java syntax) or CLAMPED_MAX (XML syntax).
      See Also:
    • CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS

      public static final String CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS
      SFString SFString enumeration value "CLAMPED_MAX" has alias "clamped-max"
      See Also:
    • CHANNELCOUNTMODE_EXPLICIT

      public static final String CHANNELCOUNTMODE_EXPLICIT
      Tooltip: X3D version of "explicit" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "EXPLICIT" (Java syntax) or EXPLICIT (XML syntax).
      See Also:
    • CHANNELCOUNTMODE_EXPLICIT_ALIAS

      public static final String CHANNELCOUNTMODE_EXPLICIT_ALIAS
      SFString SFString enumeration value "EXPLICIT" has alias "explicit"
      See Also:
    • CHANNELINTERPRETATION_SPEAKERS

      public static final String CHANNELINTERPRETATION_SPEAKERS
      Tooltip: X3D version of "speakers" in Web Audio API. SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "SPEAKERS" (Java syntax) or SPEAKERS (XML syntax).
      See Also:
    • CHANNELINTERPRETATION_DISCRETE

      public static final String CHANNELINTERPRETATION_DISCRETE
      Tooltip: X3D version of "discrete" in Web Audio API. SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "DISCRETE" (Java syntax) or DISCRETE (XML syntax).
      See Also:
    • NAME

      public static final String NAME
      String constant NAME provides name of this element: StreamAudioSource.
      See Also:
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the StreamAudioSource element: Sound
      See Also:
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Sound component level for this element: 2
      See Also:
    • CHANNELCOUNTMODE_DEFAULT_VALUE

      public static final String CHANNELCOUNTMODE_DEFAULT_VALUE
      SFString field named channelCountMode has default value "MAX" (Java syntax) or MAX (XML syntax).
      See Also:
    • CHANNELINTERPRETATION_DEFAULT_VALUE

      public static final String CHANNELINTERPRETATION_DEFAULT_VALUE
      SFString field named channelInterpretation has default value "SPEAKERS" (Java syntax) or SPEAKERS (XML syntax).
      See Also:
    • DESCRIPTION_DEFAULT_VALUE

      public static final String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:
    • ENABLED_DEFAULT_VALUE

      public static final boolean ENABLED_DEFAULT_VALUE
      SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
      See Also:
    • GAIN_DEFAULT_VALUE

      public static final float GAIN_DEFAULT_VALUE
      SFFloat field named gain has default value 1f (Java syntax) or 1 (XML syntax).
      See Also:
    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • PAUSETIME_DEFAULT_VALUE

      public static final double PAUSETIME_DEFAULT_VALUE
      SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
    • RESUMETIME_DEFAULT_VALUE

      public static final double RESUMETIME_DEFAULT_VALUE
      SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
    • STARTTIME_DEFAULT_VALUE

      public static final double STARTTIME_DEFAULT_VALUE
      SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
    • STOPTIME_DEFAULT_VALUE

      public static final double STOPTIME_DEFAULT_VALUE
      SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
      containerField_DEFAULT_VALUE = "children";
      containerField_ALLOWED_VALUES = {"children" }; type X3DUOM containerFieldChoicesSoundSource
      See Also:
    • fromField_CHANNELCOUNTMODE

      public static final String fromField_CHANNELCOUNTMODE
      fromField ROUTE name for SFString field named channelCountMode.
      See Also:
    • toField_CHANNELCOUNTMODE

      public static final String toField_CHANNELCOUNTMODE
      toField ROUTE name for SFString field named channelCountMode.
      See Also:
    • fromField_CHANNELINTERPRETATION

      public static final String fromField_CHANNELINTERPRETATION
      fromField ROUTE name for SFString field named channelInterpretation.
      See Also:
    • toField_CHANNELINTERPRETATION

      public static final String toField_CHANNELINTERPRETATION
      toField ROUTE name for SFString field named channelInterpretation.
      See Also:
    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:
    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:
    • fromField_ELAPSEDTIME

      public static final String fromField_ELAPSEDTIME
      fromField ROUTE name for SFTime field named elapsedTime.
      See Also:
    • fromField_ENABLED

      public static final String fromField_ENABLED
      fromField ROUTE name for SFBool field named enabled.
      See Also:
    • toField_ENABLED

      public static final String toField_ENABLED
      toField ROUTE name for SFBool field named enabled.
      See Also:
    • fromField_GAIN

      public static final String fromField_GAIN
      fromField ROUTE name for SFFloat field named gain.
      See Also:
    • toField_GAIN

      public static final String toField_GAIN
      toField ROUTE name for SFFloat field named gain.
      See Also:
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
    • fromField_ISACTIVE

      public static final String fromField_ISACTIVE
      fromField ROUTE name for SFBool field named isActive.
      See Also:
    • fromField_ISPAUSED

      public static final String fromField_ISPAUSED
      fromField ROUTE name for SFBool field named isPaused.
      See Also:
    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
    • fromField_PAUSETIME

      public static final String fromField_PAUSETIME
      fromField ROUTE name for SFTime field named pauseTime.
      See Also:
    • toField_PAUSETIME

      public static final String toField_PAUSETIME
      toField ROUTE name for SFTime field named pauseTime.
      See Also:
    • fromField_RESUMETIME

      public static final String fromField_RESUMETIME
      fromField ROUTE name for SFTime field named resumeTime.
      See Also:
    • toField_RESUMETIME

      public static final String toField_RESUMETIME
      toField ROUTE name for SFTime field named resumeTime.
      See Also:
    • fromField_STARTTIME

      public static final String fromField_STARTTIME
      fromField ROUTE name for SFTime field named startTime.
      See Also:
    • toField_STARTTIME

      public static final String toField_STARTTIME
      toField ROUTE name for SFTime field named startTime.
      See Also:
    • fromField_STOPTIME

      public static final String fromField_STOPTIME
      fromField ROUTE name for SFTime field named stopTime.
      See Also:
    • toField_STOPTIME

      public static final String toField_STOPTIME
      toField ROUTE name for SFTime field named stopTime.
      See Also:
    • fromField_STREAMIDENTIFIER

      public static final String fromField_STREAMIDENTIFIER
      fromField ROUTE name for MFString field named streamIdentifier.
      See Also:
    • toField_STREAMIDENTIFIER

      public static final String toField_STREAMIDENTIFIER
      toField ROUTE name for MFString field named streamIdentifier.
      See Also:
  • Constructor Details

    • StreamAudioSource

      public StreamAudioSource()
      Constructor for StreamAudioSource to initialize member variables with default values.
    • StreamAudioSource

      public StreamAudioSource(String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details