Soundbank
- Last UpdatedOct 22, 2025
- 2 minute read
The Soundbank is a bank of sounds. It contains all the sound nodes of bank type.
-
Ensure that the bank can play just one sound a time.
-
Defining another sound as currentSound and then starting it stops the execution of currently played sound.
-
Soundbank nodes must not be instantiated.
-
There is an unique predefined HDR node, called soundbank, to interact with.
Platform support
This node is supported on XR-Windows platform only.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
No support |
No support |
No support |
No support |
|
|
|
|
|
|
Soundbank fields
These are the fields for Soundbank node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > Soundbank
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
currentSound |
sstring |
Optional |
Last loaded bank sound |
Sets the sound to be played. |
|
currentTime |
sfloat |
Optional |
Internally calculated |
Shows current execution time. |
|
isFinished |
sevent |
Optional |
Not set |
Called when reaching the end of currentSound execution. |
|
isPlaying |
sbool |
Read only |
Internally calculated |
Display current bank state. |
|
length |
sfloat |
Read only |
Internally calculated |
Shows currentSound length. |
|
loop |
sbool |
Optional |
false |
Defines whether the sound must be played once or repeated. |
|
pause |
sevent |
Optional |
Not set |
Pauses execution of currentSound. |
|
play |
sevent |
Optional |
Not set |
Starts execution of currentSound. |
|
set_currentTime |
sfloat |
Optional |
Not set |
Sets the currentTime. |
|
stop |
sevent |
Optional |
Not set |
Stops execution of currentSound. |
|
volume |
sfloat |
Optional |
1 |
Sets Soundbank volume. It overrides sound node volume. |