Sound File Read Simple
- Updated2023-02-17
- 4 minute(s) read
Sound File Read Simple
Reads data from a .wav file into an array of waveforms. This node automatically opens, reads, and closes the .wav file.
number of samples/ch
Number of samples per channel to read from the file.
Default: -1—Specifies all samples.
sound file
Absolute path to the .wav file.
If the path is empty or invalid, the node returns an error in error out.
position mode
The position at which the read operation begins, together with position offset.
| Name | Value | Description |
|---|---|---|
| Absolute | 0 |
Starts the operation at the beginning of the file plus position offset, so the offset is relative to the beginning of the file. |
| Relative | 1 |
Starts the operation at the current location of the file mark plus position offset. |
Default: Relative
position offset
The position at which the read operation begins away from position mode, in units of samples.
Default: 0
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
| error in does not contain an error | error in contains an error |
|---|---|
| If no error occurred before the node runs, the node begins execution normally.
If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out. | If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out. |
Default: No error
data
Any sound data read from the file. For multi-channel sound data, data is an array of waveforms where each element of the array is a single channel.
offset
The new location of the file marker relative to the beginning of the file, in units of samples.
error out
The node produces this output according to standard error behavior.
This node can return the following error codes.
| 4805 | Could not find the sound file. |
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
| error in does not contain an error | error in contains an error |
|---|---|
| If no error occurred before the node runs, the node begins execution normally.
If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out. | If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out. |