Xj3D VRML/X3D Code API

org.web3d.vrml.nodes
Interface VRMLAudioClipNodeType

All Superinterfaces:
FrameStateListener, VRMLChildNodeType, VRMLExternalNodeType, VRMLNode, VRMLNodeType, VRMLTimeControlledNodeType, VRMLTimeDependentNodeType
All Known Subinterfaces:
J3DAudioClipNodeType, NRAudioClipNodeType

public interface VRMLAudioClipNodeType
extends VRMLTimeControlledNodeType, VRMLExternalNodeType

A node which can play audio files

Version:
$Revision: 1.10 $
Author:
Alan Hudson

Field Summary
 
Fields inherited from interface org.web3d.vrml.nodes.VRMLExternalNodeType
LOAD_COMPLETE, LOAD_FAILED, LOADING, NOT_LOADED
 
Method Summary
 java.lang.String getDescription()
          Get current value of the description field.
 double getDuration()
          Accessor method to get current value of field duration
 boolean getIsActive()
          Accessor method to get current value of field isActive
 float getPitch()
          Accessor method to get current value of field pitch, default value is 1.
 java.lang.String[] getUrl()
          Accessor method to get current value of field url.
 void setDescription(java.lang.String newDescription)
          Set a new value for the description field.
 void setDuration(double newDuration)
          Accessor method to set a new value for field attribute duration
 void setIsActive(boolean newIsActive)
          Accessor method to set a new value for field attribute isActive
 void setPitch(float newPitch)
          Set a new value for the pitch field.
 void setUrl(java.lang.String[] newUrl, int numValid)
          Accessor method to set a new value for field attribute url
 
Methods inherited from interface org.web3d.vrml.nodes.VRMLTimeControlledNodeType
getLoop, getStartTime, getStopTime, setLoop, setStartTime, setStopTime
 
Methods inherited from interface org.web3d.vrml.nodes.VRMLTimeDependentNodeType
setVRMLClock
 
Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType
addNodeListener, getFieldValue, getMetadataObject, getRefCount, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount
 
Methods inherited from interface org.web3d.vrml.lang.VRMLNode
getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion
 
Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener
allEventsComplete
 
Methods inherited from interface org.web3d.vrml.nodes.VRMLExternalNodeType
addContentStateListener, addUrlListener, getWorldUrl, removeContentStateListener, removeUrlListener, setWorldUrl
 

Method Detail

setDescription

public void setDescription(java.lang.String newDescription)
Set a new value for the description field.

Parameters:
newDescription - The new description

getDescription

public java.lang.String getDescription()
Get current value of the description field.

Returns:
The description

setPitch

public void setPitch(float newPitch)
Set a new value for the pitch field.

Parameters:
newPitch - The pitch

getPitch

public float getPitch()
Accessor method to get current value of field pitch, default value is 1.

Returns:
The Pitch

setUrl

public void setUrl(java.lang.String[] newUrl,
                   int numValid)
Accessor method to set a new value for field attribute url

Parameters:
newUrl - Array of URL strings
numValid - The number of valid items in the array

getUrl

public java.lang.String[] getUrl()
Accessor method to get current value of field url.

Returns:
An Array of URL strings

setDuration

public void setDuration(double newDuration)
Accessor method to set a new value for field attribute duration

Parameters:
newDuration - The new duration

getDuration

public double getDuration()
Accessor method to get current value of field duration

Returns:
The duration

setIsActive

public void setIsActive(boolean newIsActive)
Accessor method to set a new value for field attribute isActive


getIsActive

public boolean getIsActive()
Accessor method to get current value of field isActive

Returns:
The value of isActive

Xj3D VRML/X3D Code API

Copyright © 2001 - 2005 Web3D Consortium