All Superinterfaces:: X3DChildNode, X3DNode, X3DSoundDestinationNode, X3DSoundNode

All Known Implementing Classes:: StreamAudioDestination

public interface StreamAudioDestination extends X3DSoundDestinationNode

StreamAudioDestination node represents the final audio destination via a media stream.

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. StreamAudioDestination node tooltip: [X3DSoundDestinationNode] StreamAudioDestination node represents the final audio destination via a media stream.

Warning: stream-identification parameters are not fully defined and subject to change.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#mediastreamaudiodestinationnode

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

void

addChildren(X3DNode[] newValue)

Add array of children nodes to array of existing nodes (if any).

int

getChannelCount()

Provide int value from outputOnly SFInt32 field named channelCount.

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.

X3DNode[]

getChildren()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.

String

getDescription()

Provide String value from inputOutput SFString field named description.

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.

String

getMediaDeviceID()

Provide String value from inputOutput SFString field named mediaDeviceID.

X3DMetadataObject

getMetadata()

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

String

getStreamIdentifier()

Provide String value from inputOutput SFString field named streamIdentifier.

StreamAudioDestination

setChannelCountMode(String newValue)

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

StreamAudioDestination

setChannelInterpretation(String newValue)

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

void

setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

StreamAudioDestination

setChildren(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

StreamAudioDestination

setDescription(String newValue)

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

StreamAudioDestination

setEnabled(boolean newValue)

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

StreamAudioDestination

setGain(float newValue)

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

StreamAudioDestination

setMediaDeviceID(String newValue)

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

StreamAudioDestination

setMetadata(X3DMetadataObject newValue)

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

StreamAudioDestination

setStreamIdentifier(String newValue)

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

Method Details
- getChannelCount
  int getChannelCount()
  
  Provide int value from outputOnly SFInt32 field named channelCount.
  
  Tooltip: [0,+infinity) channelCount reports number of channels provided by input nodes.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount
  
  Specified by:
  
  getChannelCount in interface X3DSoundDestinationNode
  
  Returns:
  
  value of channelCount field
- 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
  
  Specified by:
  
  getChannelCountMode in interface X3DSoundDestinationNode
  
  Returns:
  
  value of channelCountMode field
- setChannelCountMode
  StreamAudioDestination 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
  
  Specified by:
  
  setChannelCountMode in interface X3DSoundDestinationNode
  
  Parameters:
  
  newValue - is new value for the channelCountMode field.
  
  Returns:
  
  StreamAudioDestination - 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
  
  Specified by:
  
  getChannelInterpretation in interface X3DSoundDestinationNode
  
  Returns:
  
  value of channelInterpretation field
- setChannelInterpretation
  StreamAudioDestination 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
  
  Specified by:
  
  setChannelInterpretation in interface X3DSoundDestinationNode
  
  Parameters:
  
  newValue - is new value for the channelInterpretation field.
  
  Returns:
  
  StreamAudioDestination - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getChildren
  X3DNode[] getChildren()
  
  Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.
  
  Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.
  
  Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
  
  Hint: can be original (DEF) or referenced (USE) nodes.
  
  Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
  
  Returns:
  
  value of children field
  
  See Also:
  
  Analyser
  
  AudioClip
  
  AudioDestination
  
  BiquadFilter
  
  BufferAudioSource
  
  ChannelMerger
  
  ChannelSelector
  
  ChannelSplitter
  
  Convolver
  
  Delay
  
  DynamicsCompressor
  
  Gain
  
  ListenerPointSource
  
  MicrophoneSource
  
  MovieTexture
  
  OscillatorSource
  
  Sound
  
  SpatialSound
  
  StreamAudioDestination
  
  StreamAudioSource
  
  WaveShaper
- setChildren
  StreamAudioDestination setChildren(X3DNode[] newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
  
  Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.
  
  Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
  
  Hint: can be original (DEF) or referenced (USE) nodes.
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
  
  Parameters:
  
  newValue - is new value for the children field.
  
  Returns:
  
  StreamAudioDestination - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- addChildren
  
  void addChildren(X3DNode[] newValue)
  
  Add array of children nodes to array of existing nodes (if any).
  
  Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
  
  Parameters:
  
  newValue - is new value array to be appended the children field.
- setChildren
  
  void setChildren(X3DNode newValue)
  
  Set single children node, replacing prior array of existing nodes (if any).
  
  Parameters:
  
  newValue - is new node for the children field
- 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 X3DSoundDestinationNode
  
  Specified by:
  
  getDescription in interface X3DSoundNode
  
  Returns:
  
  value of description field
- setDescription
  StreamAudioDestination 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 X3DSoundDestinationNode
  
  Specified by:
  
  setDescription in interface X3DSoundNode
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  StreamAudioDestination - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getEnabled
  
  boolean getEnabled()
  
  Provide boolean value from inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  getEnabled in interface X3DSoundDestinationNode
  
  Specified by:
  
  getEnabled in interface X3DSoundNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  StreamAudioDestination 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 X3DSoundDestinationNode
  
  Specified by:
  
  setEnabled in interface X3DSoundNode
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  StreamAudioDestination - 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 X3DSoundDestinationNode
  
  Returns:
  
  value of gain field
- setGain
  StreamAudioDestination 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 X3DSoundDestinationNode
  
  Parameters:
  
  newValue - is new value for the gain field.
  
  Returns:
  
  StreamAudioDestination - 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 X3DSoundDestinationNode
  
  Returns:
  
  value of isActive field
- getMediaDeviceID
  
  String getMediaDeviceID()
  
  Provide String value from inputOutput SFString field named mediaDeviceID.
  
  Tooltip: mediaDeviceID field provides ID parameter functionality. (TODO experimental). *
  
  Specified by:
  
  getMediaDeviceID in interface X3DSoundDestinationNode
  
  Returns:
  
  value of mediaDeviceID field
- setMediaDeviceID
  
  StreamAudioDestination setMediaDeviceID(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named mediaDeviceID.
  
  Tooltip: mediaDeviceID field provides ID parameter functionality. (TODO experimental). *
  
  Specified by:
  
  setMediaDeviceID in interface X3DSoundDestinationNode
  
  Parameters:
  
  newValue - is new value for the mediaDeviceID field.
  
  Returns:
  
  StreamAudioDestination - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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 X3DSoundDestinationNode
  
  Specified by:
  
  getMetadata in interface X3DSoundNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  StreamAudioDestination 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 X3DSoundDestinationNode
  
  Specified by:
  
  setMetadata in interface X3DSoundNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  StreamAudioDestination - 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
- 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
  StreamAudioDestination 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:
  
  StreamAudioDestination - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface StreamAudioDestination

Method Summary

Method Details

getChannelCount

getChannelCountMode

setChannelCountMode

getChannelInterpretation

setChannelInterpretation

getChildren

setChildren

addChildren

setChildren

getDescription

setDescription

getEnabled

setEnabled

getGain

setGain

getIsActive

getMediaDeviceID

setMediaDeviceID

getMetadata

setMetadata

getStreamIdentifier

setStreamIdentifier