Package org.web3d.x3d.sai.Sound

Interface AudioDestination

All Superinterfaces:
X3DChildNode, X3DNode, X3DSoundDestinationNode, X3DSoundNode
All Known Implementing Classes:
AudioDestination
public interface AudioDestination
extends X3DSoundDestinationNode
AudioDestination node represents the final audio destination and is what user ultimately hears, typically from the speakers of user device.

X3D node tooltip: (X3D version 4.0 draft) [X3DSoundDestinationNode] AudioDestination node represents the final audio destination and is what user ultimately hears, typically from the speakers of user device. An AudioDestinationNode representing the audio hardware end-point (the normal case) can potentially output more than 2 channels of audio if the audio hardware is multi-channel.
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: AudioDestination, X3D Tooltips: AudioDestination, X3D Scene Authoring Hints

  • 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.
    int getMaxChannelCount()
    Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named maxChannelCount.
    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.
    AudioDestination setChannelCountMode​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("max" | "clamped-max" | "explicit") to inputOutput SFString field named channelCountMode.
    AudioDestination setChannelInterpretation​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("speakers" | "discrete") to inputOutput SFString field named channelInterpretation.
    AudioDestination setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    AudioDestination setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    AudioDestination setGain​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named gain.
    AudioDestination setMaxChannelCount​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named maxChannelCount.
    AudioDestination setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.