You are here: NI Home > Support > Product Reference > Manuals > LabVIEW 8.5 Help

Writes data to a sound output device. You must use the Sound Output Configure VI to configure the device if you are writing continuously. You must manually select the polymorphic instance you want to use.

(Windows) You must have DirectX 8.0 or later to use this VI. (Linux) You must have the Open Sound System (OSS) driver to use this VI.

Note  The DBL Single instance of this VI writes data from a single waveform that uses double-precision floating point numbers for the sound data. Use the SGL instance to write data from a waveform that uses single-precision floating point numbers for the sound data.

Examples

Use the pull-down menu to select an instance of this VI.

Select an instance Sound Output Write (DBL)Sound Output Write (DBL Single)Sound Output Write (SGL)Sound Output Write (U8)Sound Output Write (I16)Sound Output Write (I32)

Sound Output Write (DBL)

	task ID is the sound operation from the configured device you want to manipulate or input. You generate task ID with the Sound Output Configure VI.
	data writes any sound data to the internal buffers. For multi-channel sound data, data is an array of waveforms where each element of the array is a single channel. t0 is ignored. dt is ignored. The sample rate specified in the Sound Output Configure VI specifies the sample rate. Y is the sound data. You can use elements of 8-bit unsigned, 16-bit signed, or 32-bit integers signed, or single- and double-precision data types to represent the Y array data.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	timeout (sec) specifies the maximum amount of time in seconds to wait for the sound operation to complete. This VI returns an error if the time elapses. The default is 10. If you set timeout (sec) to -1, the VI waits indefinitely. If you set timeout (sec) to 0, the VI returns immediately while the sound continues to play. You can use the Sound Output Wait VI to wait for playback to complete.
	task ID out is the manipulated sound operation originally passed in the task ID parameter.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Sound Output Write (DBL Single)

	task ID is the sound operation from the configured device you want to manipulate or input. You generate task ID with the Sound Output Configure VI.
	data writes any sound data to the internal buffers. t0 is ignored. dt is ignored. The sample rate specified in the Sound Output Configure VI specifies the sample rate. Y is the sound data. You can use elements of 8-bit unsigned, 16-bit signed, or 32-bit integers signed, or single- and double-precision data types to represent the Y array data.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	timeout (sec) specifies the maximum amount of time in seconds to wait for the sound operation to complete. This VI returns an error if the time elapses. The default is 10. If you set timeout (sec) to -1, the VI waits indefinitely. If you set timeout (sec) to 0, the VI returns immediately while the sound continues to play. You can use the Sound Output Wait VI to wait for playback to complete.
	task ID out is the manipulated sound operation originally passed in the task ID parameter.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Sound Output Write (SGL)

	task ID is the sound operation from the configured device you want to manipulate or input. You generate task ID with the Sound Output Configure VI.
	data writes any sound data to the internal buffers. For multi-channel sound data, data is an array of waveforms where each element of the array is a single channel. t0 is ignored. dt is ignored. The sample rate specified in the Sound Output Configure VI specifies the sample rate. Y is the sound data.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	timeout (sec) specifies the maximum amount of time in seconds to wait for the sound operation to complete. This VI returns an error if the time elapses. The default is 10. If you set timeout (sec) to -1, the VI waits indefinitely. If you set timeout (sec) to 0, the VI returns immediately while the sound continues to play. You can use the Sound Output Wait VI to wait for playback to complete.
	task ID out is the manipulated sound operation originally passed in the task ID parameter.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Sound Output Write (U8)

	task ID is the sound operation from the configured device you want to manipulate or input. You generate task ID with the Sound Output Configure VI.
	data writes any sound data to the internal buffers. For multi-channel sound data, data is an array of waveforms where each element of the array is a single channel. t0 is ignored. dt is ignored. The sample rate specified in the Sound Output Configure VI specifies the sample rate. Y is the sound data.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	timeout (sec) specifies the maximum amount of time in seconds to wait for the sound operation to complete. This VI returns an error if the time elapses. The default is 10. If you set timeout (sec) to -1, the VI waits indefinitely. If you set timeout (sec) to 0, the VI returns immediately while the sound continues to play. You can use the Sound Output Wait VI to wait for playback to complete.
	task ID out is the manipulated sound operation originally passed in the task ID parameter.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Sound Output Write (I16)

	task ID is the sound operation from the configured device you want to manipulate or input. You generate task ID with the Sound Output Configure VI.
	data writes any sound data to the internal buffers. For multi-channel sound data, data is an array of waveforms where each element of the array is a single channel. t0 is ignored. dt is ignored. The sample rate specified in the Sound Output Configure VI specifies the sample rate. Y is the sound data.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	timeout (sec) specifies the maximum amount of time in seconds to wait for the sound operation to complete. This VI returns an error if the time elapses. The default is 10. If you set timeout (sec) to -1, the VI waits indefinitely. If you set timeout (sec) to 0, the VI returns immediately while the sound continues to play. You can use the Sound Output Wait VI to wait for playback to complete.
	task ID out is the manipulated sound operation originally passed in the task ID parameter.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Sound Output Write (I32)

	task ID is the sound operation from the configured device you want to manipulate or input. You generate task ID with the Sound Output Configure VI.
	data writes any sound data to the internal buffers. For multi-channel sound data, data is an array of waveforms where each element of the array is a single channel. t0 is ignored. dt is ignored. The sample rate specified in the Sound Output Configure VI specifies the sample rate. Y is the sound data.
	error in describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node. status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE. code is the error or warning code. The default is 0. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source specifies the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.
	timeout (sec) specifies the maximum amount of time in seconds to wait for the sound operation to complete. This VI returns an error if the time elapses. The default is 10. If you set timeout (sec) to -1, the VI waits indefinitely. If you set timeout (sec) to 0, the VI returns immediately while the sound continues to play. You can use the Sound Output Wait VI to wait for playback to complete.
	task ID out is the manipulated sound operation originally passed in the task ID parameter.
	error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error. status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred. code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code. source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning.

Examples

Refer to the following VIs for examples of using the Sound Output Write VI:

• Sound File to Sound Output VI: labview\examples\sound2\sound2.llb
• Generate Sound VI: labview\examples\sound2\sound2.llb
• Simultaneous Sound IO VI: labview\examples\sound2\sound2.llb