Package org.web3d.x3d.sai.Sound

Interface X3DSoundDestinationNode

All Superinterfaces:

X3DChildNode, X3DNode, X3DSoundNode

All Known Subinterfaces:

AudioDestination, StreamAudioDestination

All Known Implementing Classes:

AudioDestination, StreamAudioDestination

public interface X3DSoundDestinationNode
extends X3DSoundNode

Base type for all sound destination nodes, which represent the final destination of an audio signal and are what the user can ultimately hear.

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.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

• SAI Java Specification
• X3D Abstract Specification
• X3D Tooltips
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
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.
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.
X3DSoundDestinationNode	setChannelCountMode(String newValue)	Accessor method to assign String enumeration value ("MAX" | "CLAMPED_MAX" | "EXPLICIT") to inputOutput SFString field named channelCountMode.
X3DSoundDestinationNode	setChannelInterpretation(String newValue)	Accessor method to assign String enumeration value ("SPEAKERS" | "DISCRETE") to inputOutput SFString field named channelInterpretation.
X3DSoundDestinationNode	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
X3DSoundDestinationNode	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
X3DSoundDestinationNode	setGain(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named gain.
X3DSoundDestinationNode	setMediaDeviceID(String newValue)	Accessor method to assign String value to inputOutput SFString field named mediaDeviceID.
X3DSoundDestinationNode	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.

Returns:

value of channelCount field

getChannelCountMode

String getChannelCountMode()

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

Returns:

value of channelCountMode field

setChannelCountMode

X3DSoundDestinationNode setChannelCountMode(String newValue)

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

Parameters:

newValue - is new value for the channelCountMode field.

Returns:

X3DSoundDestinationNode - 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.

Returns:

value of channelInterpretation field

setChannelInterpretation

X3DSoundDestinationNode setChannelInterpretation(String newValue)

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

Parameters:

newValue - is new value for the channelInterpretation field.

Returns:

X3DSoundDestinationNode - 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.

Specified by:

getDescription in interface X3DSoundNode

Returns:

value of description field

setDescription

X3DSoundDestinationNode setDescription(String newValue)

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

Specified by:

setDescription in interface X3DSoundNode

Parameters:

newValue - is new value for the description field.

Returns:

X3DSoundDestinationNode - 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.

Specified by:

getEnabled in interface X3DSoundNode

Returns:

value of enabled field

setEnabled

X3DSoundDestinationNode setEnabled(boolean newValue)

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

Specified by:

setEnabled in interface X3DSoundNode

Parameters:

newValue - is new value for the enabled field.

Returns:

X3DSoundDestinationNode - 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.

Returns:

value of gain field

setGain

X3DSoundDestinationNode setGain(float newValue)

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

Parameters:

newValue - is new value for the gain field.

Returns:

X3DSoundDestinationNode - 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.

Returns:

value of isActive field

getMediaDeviceID

String getMediaDeviceID()

Provide String value from inputOutput SFString field named mediaDeviceID.

Returns:

value of mediaDeviceID field

setMediaDeviceID

X3DSoundDestinationNode setMediaDeviceID(String newValue)

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

Parameters:

newValue - is new value for the mediaDeviceID field.

Returns:

X3DSoundDestinationNode - 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.

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DSoundNode

Returns:

value of metadata field

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

X3DSoundDestinationNode setMetadata(X3DMetadataObject newValue)

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DSoundNode

Parameters:

newValue - is new value for the metadata field.

Returns:

X3DSoundDestinationNode - 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