Table Of Contents

Play Sound File (G Dataflow)

Version:
    Last Modified: March 15, 2017

    Opens a file and starts playing it immediately.

    You must have DirectX 8.0 or later to use this node.

    connector_pane_image
    datatype_icon

    number of samples per iteration

    Specifies the number of samples to read from the sound file per iteration. The default is 10,000.

    datatype_icon

    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. In general, most users should select 0.

    Default: 0

    datatype_icon

    path

    Specifies the absolute path to the file from which you want to play sound 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 node 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.

    Default: 10

    datatype_icon

    task ID

    An identification number associated with the configuration on the specified device. You can pass task ID to other sound operation nodes.

    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