imaqregister
Register third-party custom adaptor
Syntax
Description
returns a list of
registered third-party adaptors with their full paths. If there are no registered adaptors,
adaptors
= imaqregisterimaqregister
returns an empty cell array.
Note
The imaqhwinfo
and videoinput
functions use
the adaptor base name, not the full path. For example, if the adaptor full path is
"c:\adaptor.dll"
(Windows®), "/local/adaptors/adaptor.so"
(Linux®), or "/local/adaptors/adaptor.dylib"
(macOS), the adaptor base name is "adaptor"
.
registers the specified third-party adaptor library and returns a list of all registered
adaptors.adaptors
= imaqregister(adaptorpath
)
Registering an adaptor informs Image Acquisition Toolbox™ of the location of a third-party adaptor library. If you query the system for
available image acquisition hardware by using imaqhwinfo
, the toolbox
makes available any previously registered adaptor libraries. The
imaqregister
function saves the name of the registered adaptor in the
MATLAB® preferences directory so that the location persists across MATLAB sessions. Because imaqhwinfo
caches the list of available
adaptors, you might need to call imaqreset
after calling
imaqregister
to make the newly registered adaptor available.
Note
The adaptor shared library (a DLL on Windows) is not the same as the driver shared library supplied by a hardware vendor (also a DLL on Windows). The adaptor shared library is specific to Image Acquisition Toolbox and is specified as such by the hardware vendor.
adds or removes the third-party adaptor from the list of available adaptors, as specified by
adaptors
= imaqregister(adaptorpath
,action
)action
.
Examples
Input Arguments
Tips
Follow these suggestions when you deploy a custom adaptor to a standalone application using MATLAB Compiler™.
Call
imaqregister
in the MATLAB code that you are deploying. This ensures that the deployed application registers the custom adaptor library for the user running the application. For more information, see Creating Custom Adaptors.Package the custom adaptor library with the standalone application. To do this, add the adaptor DLL file in the Files installed for your end user section of the Application Compiler app. For more information about creating a standalone application, see Create Standalone Application from MATLAB Function (MATLAB Compiler).
The first time you run a deployed application that calls
imaqregister
, you might need to execute the application in Run as administrator mode.
Version History
Introduced before R2006a