Package org.web3d.x3d.sai.Sound
Interface ChannelSelector
- All Superinterfaces:
X3DChildNode
,X3DNode
,X3DSoundChannelNode
,X3DSoundNode
- All Known Implementing Classes:
ChannelSelector
ChannelSelector selects a single channel output from all input channels.
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
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
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.
ChannelSelector node tooltip: [X3DSoundChannelNode] ChannelSelector selects a single channel output from all input channels.
- Hint: ChannelSelector is a utility node to complement ChannelSplitter.
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 TypeMethodDescriptionvoid
addChildren
(X3DNode[] newValue) Add array of children nodes to array of existing nodes (if any).int
Provide int value from outputOnly SFInt32 field named channelCount.Provide String enumeration value (baseType SFString) ["MAX" | "CLAMPED_MAX" | "EXPLICIT"] from inputOutput SFString field named channelCountMode.Provide String enumeration value (baseType SFString) ["SPEAKERS" | "DISCRETE"] from inputOutput SFString field named channelInterpretation.int
Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named channelSelection.X3DNode[]
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.Provide String value from inputOutput SFString field named description.boolean
Provide boolean value from inputOutput SFBool field named enabled.float
getGain()
Provide float value from inputOutput SFFloat field named gain.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.setChannelCountMode
(String newValue) Accessor method to assign String enumeration value ("MAX" | "CLAMPED_MAX" | "EXPLICIT") to inputOutput SFString field named channelCountMode.setChannelInterpretation
(String newValue) Accessor method to assign String enumeration value ("SPEAKERS" | "DISCRETE") to inputOutput SFString field named channelInterpretation.setChannelSelection
(int newValue) Accessor method to assign int value to inputOutput SFInt32 field named channelSelection.void
setChildren
(X3DNode newValue) Set single children node, replacing prior array of existing nodes (if any).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.setDescription
(String newValue) Accessor method to assign String value to inputOutput SFString field named description.setEnabled
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named enabled.setGain
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named gain.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
-
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 interfaceX3DSoundChannelNode
- 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 interfaceX3DSoundChannelNode
- Returns:
- value of channelCountMode field
-
setChannelCountMode
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 interfaceX3DSoundChannelNode
- Parameters:
newValue
- is new value for the channelCountMode field.- Returns:
ChannelSelector
- 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 interfaceX3DSoundChannelNode
- Returns:
- value of channelInterpretation field
-
setChannelInterpretation
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 interfaceX3DSoundChannelNode
- Parameters:
newValue
- is new value for the channelInterpretation field.- Returns:
ChannelSelector
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getChannelSelection
int getChannelSelection()Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named channelSelection.
Tooltip: [0,+infinity) channelSelection is single channel of interest from those provided by input nodes. *- Returns:
- value of channelSelection field
-
setChannelSelection
Accessor method to assign int value to inputOutput SFInt32 field named channelSelection.
Tooltip: [0,+infinity) channelSelection is single channel of interest from those provided by input nodes. *- Parameters:
newValue
- is new value for the channelSelection field.- Returns:
ChannelSelector
- 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:
-
setChildren
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:
ChannelSelector
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addChildren
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
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 interfaceX3DSoundChannelNode
- Specified by:
getDescription
in interfaceX3DSoundNode
- Returns:
- value of description field
-
setDescription
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 interfaceX3DSoundChannelNode
- Specified by:
setDescription
in interfaceX3DSoundNode
- Parameters:
newValue
- is new value for the description field.- Returns:
ChannelSelector
- 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 interfaceX3DSoundChannelNode
- Specified by:
getEnabled
in interfaceX3DSoundNode
- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
setEnabled
in interfaceX3DSoundChannelNode
- Specified by:
setEnabled
in interfaceX3DSoundNode
- Parameters:
newValue
- is new value for the enabled field.- Returns:
ChannelSelector
- 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 interfaceX3DSoundChannelNode
- Returns:
- value of gain field
-
setGain
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 interfaceX3DSoundChannelNode
- Parameters:
newValue
- is new value for the gain field.- Returns:
ChannelSelector
- 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 interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DSoundChannelNode
- Specified by:
getMetadata
in interfaceX3DSoundNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
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 interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DSoundChannelNode
- Specified by:
setMetadata
in interfaceX3DSoundNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
ChannelSelector
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-