reference_sound

Logic Nodes Reference: Sound nodes

This reference was generated automatically. Please do not edit the page directly, instead change the docstrings of the nodes in their Python files or the generator script and open a pull request. Thank you for contributing!

This reference was built for Armory 2023.11.

Node Categories

Basic
- Logic
- Event
- Input
- Native
Data
- Camera
- Material
- Light
- Object
- Scene
- Trait
- Network
Motion
- Animation
- Navmesh
- Transform
- Physics
Values
- Array
- Map
- Math
- Random
- String
- Variable
Graphics
- Draw
- Canvas
- Postprocess
- Renderpath
Sound
- Sound
Misc
- Miscellaneous
- Layout

Sound

Pause Speaker

Pauses playback of the given speaker object. The playback will be resumed at the paused position.

See also:

Play Speaker
Stop Speaker

Pause Speaker node

Sources: Python | Haxe

Play Sound

Plays the given sound.

Play Sound node

Inputs:

Play: Plays the sound, or if paused, resumes the playback. The exact behaviour depends on the Retrigger option (see below).
Pause: Pauses the playing sound. If no sound is playing, nothing happens.
Stop: Stops the playing sound. If the playback is paused, this will reset the playback position to the start of the sound.
Update Volume: Updates the volume of the current playback.
Volume: Volume of the playback. Typically ranges from 0 to 1.

Outputs:

Out: activated once when Play is activated.
Running: activated while the playback is active.
Done: activated when the playback has finished or was stopped manually.

Options:

Sound: The sound that will be played.
Loop: Whether to loop the playback.
Retrigger: If true, the playback position will be reset to the beginning on each activation of Play. If false, the playback will continue at the current position.
Sample Rate: Manually override the sample rate of the sound (this controls the pitch and the playback speed).

Sources: Python | Haxe