Package org.web3d.x3d.sai.Sound
Interface StreamAudioDestination
- 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.
X3D node tooltip: (X3D version 4.0 draft) [X3DSoundDestinationNode] StreamAudioDestination node represents the final audio destination via a media stream.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: (X3D version 4.0 draft) [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).
-
Method Summary
Modifier and Type Method Description int
getChannelCount()
Provide int value from outputOnly SFInt32 field named channelCount.java.lang.String
getChannelCountMode()
Provide String enumeration value (baseType SFString) ["max" | "clamped-max" | "explicit"] from inputOutput SFString field named channelCountMode.java.lang.String
getChannelInterpretation()
Provide String enumeration value (baseType SFString) ["speakers" | "discrete"] from inputOutput SFString field named channelInterpretation.java.lang.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.java.lang.String
getId()
Provide String value from outputOnly SFString field named id.boolean
getIsActive()
Provide boolean value from outputOnly SFBool field named isActive.java.lang.String
getMediaDeviceID()
Provide String value from outputOnly SFString field named mediaDeviceID.X3DMetadataObject
getMetadata()
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.StreamAudioDestination
setChannelCountMode(java.lang.String newValue)
Accessor method to assign String enumeration value ("max" | "clamped-max" | "explicit") to inputOutput SFString field named channelCountMode.StreamAudioDestination
setChannelInterpretation(java.lang.String newValue)
Accessor method to assign String enumeration value ("speakers" | "discrete") to inputOutput SFString field named channelInterpretation.StreamAudioDestination
setDescription(java.lang.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
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 interfaceX3DSoundDestinationNode
- Returns:
- value of channelCount field
-
getChannelCountMode
java.lang.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 interfaceX3DSoundDestinationNode
- 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 interfaceX3DSoundDestinationNode
- 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
java.lang.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 interfaceX3DSoundDestinationNode
- 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 interfaceX3DSoundDestinationNode
- 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).
-
getDescription
java.lang.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 interfaceX3DSoundDestinationNode
- 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 interfaceX3DSoundDestinationNode
- Specified by:
setDescription
in interfaceX3DSoundNode
- 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 interfaceX3DSoundDestinationNode
- 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 interfaceX3DSoundDestinationNode
- Specified by:
setEnabled
in interfaceX3DSoundNode
- 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 interfaceX3DSoundDestinationNode
- Specified by:
getGain
in interfaceX3DSoundNode
- 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 interfaceX3DSoundDestinationNode
- Specified by:
setGain
in interfaceX3DSoundNode
- 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).
-
getId
java.lang.String getId()Provide String value from outputOnly SFString field named id.- Specified by:
getId
in interfaceX3DSoundDestinationNode
- Returns:
- value of id field
-
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 interfaceX3DSoundDestinationNode
- Returns:
- value of isActive field
-
getMediaDeviceID
java.lang.String getMediaDeviceID()Provide String value from outputOnly SFString field named mediaDeviceID.
Tooltip: mediaDeviceID field provides ID parameter functionality. (TODO experimental). *- Returns:
- value of mediaDeviceID 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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DSoundDestinationNode
- Specified by:
getMetadata
in interfaceX3DSoundNode
- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DSoundDestinationNode
- Specified by:
setMetadata
in interfaceX3DSoundNode
- 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
-