AudioSource
The abstract base class of all nodes that provide audio data.
Inheritance
Code
XML encoding
<AudioSource enabled='TRUE' description='' loop='FALSE' pitch='1.0' startTime='0' stopTime='0' pauseTime='0' resumeTime='0' triggerName='Sound' logFeature='' />
Classic encoding
AudioSource { 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 |
---|---|---|---|---|---|---|
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 | ||
enabled | SFBool | inputOutput | TRUE | Enables or disables audio sources. A disabled audio source does not produce audio data. | ||
isActive | SFBool | outputOnly | isActive true/false events are sent when playback starts/stops. | |||
isPaused | SFBool | outputOnly | isPaused true/false events are sent when TimeSensor is paused/resumed. | |||
loop | SFBool | inputOutput | FALSE | repeat indefinitely when loop=true, repeat only once when loop=false. | ||
fraction_changed | SFFloat | outputOnly | fraction_changed continuously sends value in range [0,1] showing time progress in the current cycle. | |||
pitch | SFFloat | inputOutput | 1.0 | Multiplier for the rate at which sampled sound is played. changing pitch also changes playback speed. | ||
metadata | SFNode | inputOutput | MetadataObject | container for payload metadata inside MetadataSet element | ||
description | SFString | inputOutput | text description to be displayed for action of this node. Hint: many XML tools substitute XML character references automatically if needed. | |||
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. | ||
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). | |||
duration_changed | SFTime | outputOnly | duration_changed is length of time in seconds for one cycle of audio. | |||
elapsedTime | SFTime | outputOnly | Current elapsed time since TimeSensor activated/running, cumulative in seconds, and not counting any paused time. | |||
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. | ||
ready | SFTime | outputOnly | Sends the current timestamp when audio data is available. Currently not implemented. | |||
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. | ||
startTime | SFTime | inputOutput | 0 | Absolute time: number of seconds since Jan 1, 1970, 00:00:00 GMT. Hint: usually receives a ROUTEd time value. | ||
stopTime | SFTime | inputOutput | 0 | Absolute time: number of seconds since Jan 1, 1970, 00:00:00 GMT. Hint: usually receives a ROUTEd time value. | ||
time | SFTime | outputOnly | Time continuously sends the absolute time (since January 1, 1970) for a given simulation tick. |