Table Of Contents

Sound Output Write (G Dataflow)

Version:
Last Modified: August 28, 2017

Writes data to a sound output device. You must use Sound Output Configure to configure the device if you are writing continuously.

spd-note-note
Note  

If the buffer you set using the number of samples/ch input of Sound File Read is full when the node executes, an automatic wait is implemented on Sound Output Write even if you set timeout to 0. This may cause the data flow to hang and return unexpected results.

Programming Patterns

To create a task ID, use the Sound Output Configure node and wire the task ID output to the input of this node.

connector_pane_image
datatype_icon

task ID in

Reference to the configured sound device you want to manipulate or input.

datatype_icon

data

Sound data to write to the .wav file. For multi-channel sound data, data is an array of waveforms where each element of the array is a single channel.

This input accepts the following numeric data types:
  • An array of waveforms, where the Y array contains single-precision, floating-point numeric data
  • An array of waveforms, where the Y array contains double-precision, floating-point numeric data
  • A single waveform of double-precision, floating-point numeric data
  • An array of waveforms, where the Y array contains signed 16-bit integer data
  • An array of waveforms, where the Y array contains signed 32-bit integer data
  • An array of waveforms, where the Y array contains unsigned 8-bit integer data
datatype_icon

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

datatype_icon

timeout

Time, in seconds, that the function waits for the sound operation to complete. This node returns an error if the time elapses. If you set timeout to -1, the node waits indefinitely. If you set timeout to 0, the node returns immediately while the sound continues to play. You can use Sound Output Wait to wait for playback to complete.

Default: 10

datatype_icon

task ID out

Reference to the configured sound device originally passed to the task ID parameter.

datatype_icon

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: This product does not support FPGA devices

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics