This is a platform-agnostic plug-and-play class that notifies a client when AJA devices are attached/detached, powered on/off, sleep/wake, etc.
More...
#include <pnp.h>
This is a platform-agnostic plug-and-play class that notifies a client when AJA devices are attached/detached, powered on/off, sleep/wake, etc.
Definition at line 50 of file pnp.h.
◆ AJAPnp()
Default constructor.
Definition at line 25 of file pnp.cpp.
◆ ~AJAPnp()
Default destructor.
Definition at line 31 of file pnp.cpp.
◆ GetCallback()
- Returns
- the address of the currently-installed callback (NULL if none installed).
Definition at line 52 of file pnp.cpp.
◆ GetPnpDevices()
uint32_t AJAPnp::GetPnpDevices |
( |
| ) |
const |
|
virtual |
- Returns
- the current bit mask that filters which devices to include or ignore (see implementation).
Definition at line 66 of file pnp.cpp.
◆ GetRefCon()
void * AJAPnp::GetRefCon |
( |
| ) |
const |
|
virtual |
- Returns
- the currently installed reference cookie.
Definition at line 59 of file pnp.cpp.
◆ Install()
Installs the given plug & play notification callback function, replacing any callback function that may have been installed earlier.
- Parameters
-
[in] | pInCallback | Specifies a valid (non-NULL) pointer to a client-defined function to be called when AJA devices are attached/detached to/from the host. |
[in] | inRefCon | Optionally specifies a pointer-sized reference value that gets passed to the callback function. Defaults to zero. |
[in] | inDeviceMask | Optionally specifies a bit mask that filters the types of devices to include/ignore (see AJAPnpDevice). Defaults to no filtering (i.e. notify for any/all device types). |
- Note
- On macOS, the callback function is immediately called for each currently-attached matching device.
- Bug:
- macOS: doesn't work on programs that don't provide a run loop.
- Bug:
- Windows: doesn't work if the calling process is a Windows service.
- Returns
- AJA_STATUS_SUCCESS Install succeeded AJA_STATUS_FAIL Install failed
Definition at line 38 of file pnp.cpp.
◆ Uninstall()
Uninstalls any previously-installed callback notifier.
- Returns
- AJA_STATUS_SUCCESS Uninstall succeeded AJA_STATUS_FAIL Uninstall failed
Definition at line 45 of file pnp.cpp.
The documentation for this class was generated from the following files:
- /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajabase/pnp/pnp.h
- /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajabase/pnp/pnp.cpp