Sound Input Configure
- Updated2023-02-17
- 5 minute(s) read
Sound Input Configure
Configures a sound input device to acquire data and then sends the data to a buffer. Use Sound Input Read to read the data.


number of samples/ch
Number of samples per channel in the buffer. Continuous operations require an increased number of samples to improve data quality but require the use of more memory.
Default: 100,000

sample mode
Setting to acquire samples once or continuously.
Name | Value | Description |
---|---|---|
Finite Samples | 0 |
Acquire samples once. In this mode, call this node only until you have written the number of samples specified in number of samples/ch. |
Continuous Samples | 1 |
Acquire samples continuously. In this mode, you can call this node repeatedly as needed. |
Default: 1—Continuous Samples

device ID
The input or output device you access for a sound operation. The value ranges from 0 to n-1, where n is the number of input or output devices on the computer.
Default: 0

sound format
The acquisition rate, the number of channels, and the bits per sample of the sound operation. The values for each of these elements is dependent on your sound card.
Not all operating systems and sound cards support all sample rate (S/s), number of channels, or bits per sample options.
Performance Details
sample rate (S/s) and bits per sample use more computer memory when set to a higher value.

sample rate (S/s)
Sampling rate for the sound operation. Common rates are 44,100 S/s, 22,050 S/s, and 11,025 S/s.
Default: 22,050 S/s

number of channels
Number of channels. This input can accept as many channels as the sound card supports. For most sound cards 1 is mono and 2 is stereo.
Default: 2

bits per sample
Quality of each sample in bits. Available resolutions are 8 bits, 16 bits, and 32 bits.
Default: 16 bits

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

task ID
Reference to the configured sound device. You can pass task ID to other sound operation nodes.

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. |
Where This Node Can Run:
Desktop OS: Windows
FPGA:
Web Server: