setaudio node

Summary

The setaudio node changes the state of an audio node. It is used to start, pause or restart an audio node.

For more information regarding the scripting of this node see the scripting reference entry for setaudio.

Children

This node cannot contain children.

Example B.10. Use of setaudio node

<setaudio audio="myaudio" state="start"/>

Attributes

setaudio attributes
nametypedefaultnotes
audioaudio node idthis attribute must be specifiedthe id of the audio node to change the state of
statestart, pause or restartthis attribute must be specifiedthe state to change the node to

Attributes common to action nodes
nametypedefaultnotes
timesinteger1the number of times to perform this action. Use -1 to repeat indefinitely

Attributes common to nodes
nametypedefaultnotes
visiblebooleantrueIf false, this node (or its children, if it has any) will not be rendered.
colorr g b a (in range 0 to 1)1 1 1 1specifies the color used to modulate this node and its children
idstring an identifier used to refer to this node