vlcreatepath(3dm)

NAME
     vlCreatePath, vlDestroyPath - manage VL paths

SYNOPSIS
     #include <dmedia/vl.h>

     VLPath vlCreatePath(VLServer svr, VLDev dev, VLNode source, VLNode drain);
     int vlDestroyPath(VLServer svr, VLPath path);

PARAMETERS
     svr        Specifies the server handle.

     vlDev      Specifies the device handle.

     path       Specifies the path handle.

     source     Specifies the source node.

     drain      Specifies the drain node.

DESCRIPTION
     vlCreatePath creates a path for data transfer, or using controls. The
     path will be created on the specified device. If the device is specified
     as VL_ANY, a device which supports the specified source and drain will be
     used, in the case where the two nodes are VL_ANY, it will choose a device
     in a deterministic manner.  vlGetDevice(3dm) can be used to determine the
     device selected. If the source and drain are specified as VL_ANY, the
     path returned will not contain any nodes. Nodes can be added or removed
     later using vlAddNode(3dm), and vlRemoveNode(3dm).

     Once a node is added to a path (via vlCreatePath, or vlAddNode(3dm), that
     node is on the device that the path is on. It cannot later be used on a
     path on a different device.

     Using multiple sources and/or multiple drains implies data interaction
     along the path.  For example, a blender in the path might require two
     sources and one drain.

     The path handle returned is unique only to this server, and not to all
     servers.

     vlDestroyPath destroys the specified path, freeing the resources used by
     the path.

DIAGNOSTICS
     If successful, vlCreatePath returns a path handle.  vlDestroyPath returns
     0 on success. Otherwise, both routines return a value of -1 on error and
     vlGetErrno(3dm) can be called to retrieve the error.
SEE ALSO
     vlSetupPaths(3dm), vlAddNode(3dm), vlRemoveNode(3dm), vlGetErrno(3dm),
     vlGetDevice(3dm)