I16
- Updated2023-02-17
- 4 minute(s) read
I16
Reads 16-bit signed integer numeric data from a .wav file into an array of waveforms.
The Y component of the waveform this node returns is an array of signed 16-bit integers.
Programming Patterns
To create a sound file reference, use the Sound File Open node and wire the absolute path of a .wav file to the sound file input. Then, wire the reference output of Sound File Open to the input of this node.
.gvi.png?_LANG=enus)
number of samples/ch
Number of samples per channel to read from the file.
Default: -1—Specifies all samples.
reference in
Reference to the .wav file in memory.
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
end of file
A Boolean that indicates whether the node has read the entire file.
| True | The node has read the entire file. |
| False | The node did not finish reading the entire file. |
reference out
Reference to the .wav file specified by reference in.
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
Error information.
The node produces this output 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. |