Table Of Contents

Sound File Read (I32) (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Reads data from a .wav file into an array of waveforms.

    spd-note-note
    Note  

    This node retrieves only uncompressed .wav files. Read .wav files in chunks to avoid using large amounts of memory.

    connector_pane_image
    datatype_icon

    number of samples/ch

    Number of samples per channel to read from the file.

    Default: -1—Specifies all samples.

    datatype_icon

    reference in

    Reference to the sound file.

    This input appears only when you wire a reference to reference in. If you wire a file path to reference in, this input changes to sound path

    datatype_icon

    position mode

    With position offset, where the read operation begins.

    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

    datatype_icon

    position offset

    How far from the location specified by position mode to start reading in units of samples.

    Default: 0

    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

    end of file

    A Boolean that indicates whether the node has reached the end of the file.

    True The node has reached the end of the file.
    False The node has not reached the end of the file while reading data.
    datatype_icon

    reference out

    Reference to the sound file specified by reference in.

    datatype_icon

    data

    Any sound data from the file. For multi-channel sound data, data is an array of waveforms where each element of the array is a single channel.

    datatype_icon

    offset

    The new location of the file mark relative to the beginning of the file in units of samples.

    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


    Recently Viewed Topics