instantreality 1.0

Component:
Sound
Status:
interface only
Structure type:
concrete
Standard:
Avalon

AudioStream

Receives and plays audio Streams. This node is currently not implemented.

Inheritance

Code

XML encoding
<AudioStream enabled='TRUE'
description=''
loop='FALSE'
pitch='1.0'
startTime='0'
stopTime='0'
pauseTime='0'
resumeTime='0'
triggerName='Sound'
logFeature=''
 />
Classic encoding
AudioStream {
	enabled TRUE
	description ""
	loop FALSE
	pitch 1.0
	startTime 0
	stopTime 0
	pauseTime 0
	resumeTime 0
	triggerName "Sound"
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
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
SFBool enabled SFBool inputOutput TRUE Enables or disables audio sources. A disabled audio source does not produce audio data.
SFBool isActive SFBool outputOnly isActive true/false events are sent when playback starts/stops.
SFBool isPaused SFBool outputOnly isPaused true/false events are sent when TimeSensor is paused/resumed.
SFBool loop SFBool inputOutput FALSE repeat indefinitely when loop=true, repeat only once when loop=false.
SFFloat add_sound SFFloat inputOnly Adds new sample data to existing sample data.
SFFloat fraction_changed SFFloat outputOnly fraction_changed continuously sends value in range [0,1] showing time progress in the current cycle.
SFFloat pitch SFFloat inputOutput 1.0 Multiplier for the rate at which sampled sound is played. changing pitch also changes playback speed.
SFFloat set_sound SFFloat inputOnly Sets sample data.
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
SFString description SFString inputOutput text description to be displayed for action of this node. Hint: many XML tools substitute XML character references automatically if needed.
SFString triggerName SFString initializeOnly Sound name of the dynamic context-slot which is used by the run-time environment (e.g. Jobs) to trigger the node. Life-Nodes will automatically connect the context-eventOutut to the triggerSlot-eventInput Slot.
SFTime cycleTime SFTime outputOnly cycleTime sends a time outputOnly at startTime, and also at the beginning of each new cycle (useful for synchronization with other time-based objects).
SFTime duration_changed SFTime outputOnly duration_changed is length of time in seconds for one cycle of audio.
SFTime elapsedTime SFTime outputOnly Current elapsed time since TimeSensor activated/running, cumulative in seconds, and not counting any paused time.
SFTime pauseTime SFTime inputOutput 0 When time now >= pauseTime, isPaused becomes true and TimeSensor becomes paused. Absolute time: number of seconds since Jan 1, 1970, 00:00:00 GMT. Hint: usually receives a ROUTEd time value.
SFTime ready SFTime outputOnly Sends the current timestamp when audio data is available. Currently not implemented.
SFTime resumeTime SFTime inputOutput 0 When resumeTime becomes less than time now, isPaused becomes false and TimeSensor becomes inactive. Absolute time: number of seconds since Jan 1, 1970, 00:00:00 GMT. Hint: usually receives a ROUTEd time value.
SFTime startTime SFTime inputOutput 0 Absolute time: number of seconds since Jan 1, 1970, 00:00:00 GMT. Hint: usually receives a ROUTEd time value.
SFTime stopTime SFTime inputOutput 0 Absolute time: number of seconds since Jan 1, 1970, 00:00:00 GMT. Hint: usually receives a ROUTEd time value.
SFTime time SFTime outputOnly Time continuously sends the absolute time (since January 1, 1970) for a given simulation tick.
SFTime triggerSlot SFTime inputOnly slot which is used internally to connect a dynamic context-slot which name is set by the triggerName value. Its used automatically to install run-time environment trigger.