instantreality 1.0

Component:
Sound
Status:
fully implemented
Structure type:
concrete
Standard:
X3D2.0

Sound

Sound contains an AudioClip or MovieTexture for sound playback. You can also substitute a type-matched ProtoInstance for content.

Inheritance

Code

XML encoding
<Sound enabled='TRUE'
direction='0 0 1'
intensity='1'
location='0 0 0'
maxBack='10'
maxFront='10'
minBack='1'
minFront='1'
priority='0'
spatialize='TRUE'
visualize='FALSE'
logFeature=''
 />
Classic encoding
Sound {
	enabled TRUE
	direction 0 0 1
	intensity 1
	location 0 0 0
	maxBack 10
	maxFront 10
	minBack 1
	minFront 1
	priority 0
	spatialize TRUE
	visualize FALSE
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFVec3f direction SFVec3f inputOutput 0 0 1 direction of sound axis, relative to local coordinate system.
SFBool enabled SFBool inputOutput TRUE Enables or disables the Sound node. A Sound node that is disabled does not play sounds.
SFFloat intensity SFFloat inputOutput 1 Factor [0..1] adjusting loudness (decibels) of emitted sound.
SFVec3f location SFVec3f inputOutput 0 0 0 Position of sound center, relative to local coordinate system.
MFString logFeature MFString inputOutput state, child, parent, route, eventIn, eventOut controls the logging of changes, state: log state changes (e.g. live), child: log child add/remove, parent: log parent add/remove, route: log route add/remove; eventIn: log receiving of events, eventOut: log sending of events: guiView, runtime system should create node-view, guiEdit: runtime system should create node-editeverything: log everything
SFFloat maxBack SFFloat inputOutput 10 Maximum-attenuation (zero volume) ellipsoid distance, opposite direction ensure minBack is smaller than maxBack.
SFFloat maxFront SFFloat inputOutput 10 Maximum-attenuation (zero volume) ellipsoid distance, along direction ensure minFront is smaller than maxFront.
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
SFFloat minBack SFFloat inputOutput 1 Minimum-attenuation (full volume) ellipsoid distance, opposite direction ensure minBack is smaller than maxBack.
SFFloat minFront SFFloat inputOutput 1 Minimum-attenuation (full volume) ellipsoid distance, along direction ensure minFront is smaller than maxFront.
SFFloat priority SFFloat inputOutput 0 Browser hint [0..1] to choose which sounds to play.
SFNode source SFNode inputOutput AudioSource Contains an AudioClip, AudioTTS or MovieTexture node.
SFBool spatialize SFBool inputOutput TRUE Whether to spatialize sound playback relative to viewer. Hint: only effective between minimum and maximum ellipsoids.
SFBool visualize SFBool inputOutput FALSE Set this field to TRUE get a visual feedback about the Sound node (its position and size) drawn on the screen. This is for debugging purposes.