instantreality 1.0

Component:
Engine
Status:
fully implemented
Structure type:
concrete
Standard:
Avalon

SoundJob

The SoundJob is responsible for connecting internal sound sources with external audio devices.

Inheritance

Code

XML encoding
<SoundJob triggerName='Sound'
backend='default'
ttsBackend='default'
listenerPosition='0 0 0'
listenerOrientation='0 0 1 0'
autoUpdateListener='TRUE'
spatialize='TRUE'
enabled='TRUE'
runTime='0'
logFeature=''
 />
Classic encoding
SoundJob {
	triggerName "Sound"
	backend ["default"]
	ttsBackend ["default"]
	listenerPosition 0 0 0
	listenerOrientation 0 0 1 0
	autoUpdateListener TRUE
	spatialize TRUE
	enabled TRUE
	runTime 0
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
MFString backend MFString initializeOnly default Sound rendering backend
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
MFString ttsBackend MFString initializeOnly default TTS backend
SFBool autoUpdateListener SFBool inputOutput TRUE If TRUE, position and orientation of the listener are updated with the camera position
SFBool enabled SFBool inputOutput TRUE If TRUE, job is ready to receive and process start event
SFBool spatialize SFBool inputOutput TRUE If TRUE, 3D sound is generated
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
SFRotation listenerOrientation SFRotation inputOutput 0 0 1 0 Orientation of the listener
SFString triggerName SFString initializeOnly Sound name of the dynamic context-slot which is used by the run-time the Jobs to trigger Live-nodes. Life-Jobs will automatically connect the triggerSlot-output to the context-slot.
SFTime exec SFTime inputOnly This event is used to exec the job
SFTime post SFTime outputOnly This event is triggered when the job is finished
SFTime pre SFTime outputOnly This event is triggered when the job starts
SFTime runTime SFTime initializeOnly 0 Time when execution was finished
SFVec3f listenerPosition SFVec3f inputOutput 0 0 0 Position of the listener