nx_video_source_sdk
1.0
Video Source SDK
|
Relay input/output management. More...
#include <camera_plugin.h>
Public Member Functions | |
virtual int | getRelayOutputList (char **idList, int *idNum) const =0 |
Returns list of IDs of available relay output ports. More... | |
virtual int | getInputPortList (char **idList, int *idNum) const =0 |
Returns list of IDs of available relay input ports. More... | |
virtual int | setRelayOutputState (const char *outputID, int activate, unsigned int autoResetTimeoutMS)=0 |
Change state of relay output port. More... | |
virtual int | startInputPortMonitoring ()=0 |
Starts relay input monitoring or increments internal counter, if already started. More... | |
virtual void | stopInputPortMonitoring ()=0 |
Stops input port monitoring if internal monitoring counter has reached zero. More... | |
virtual void | registerEventHandler (CameraInputEventHandler *handler)=0 |
Registers handler as event receiver. More... | |
virtual void | unregisterEventHandler (CameraInputEventHandler *handler)=0 |
Removes handler from event receiver list. More... | |
virtual void | getLastErrorString (char *errorString) const =0 |
Returns text description of last error. More... | |
![]() | |
virtual void * | queryInterface (const nxpl::NX_GUID &interfaceID)=0 |
Cast to type, specified by interfaceID. More... | |
virtual int | addRef () const =0 |
Increment reference counter. More... | |
virtual int | releaseRef () const =0 |
Decrement reference counter. More... | |
Relay input/output management.
It is implementation defined within which thread event (nxcip::CameraInputEventHandler::inputPortStateChanged) will be delivered to
|
pure virtual |
Returns list of IDs of available relay input ports.
[out] | idList | Array of size MAX_RELAY_PORT_COUNT of MAX_ID_LEN - length strings. All strings MUST be NULL-terminated |
[out] | idNum | Size of returned id list |
Implemented in AxisRelayIOManager.
|
pure virtual |
Returns text description of last error.
[out] | errorString | Buffer of size MAX_TEXT_LEN |
Implemented in AxisRelayIOManager.
|
pure virtual |
Returns list of IDs of available relay output ports.
[out] | idList | Array of size MAX_RELAY_PORT_COUNT of MAX_ID_LEN - length strings. All strings MUST be NULL-terminated |
[out] | idNum | Size of returned id list |
Implemented in AxisRelayIOManager.
|
pure virtual |
Registers handler as event receiver.
Usually, events are delivered (by handler->inputPortStateChanged call) to some plugin internal thread
Implemented in AxisRelayIOManager.
|
pure virtual |
Change state of relay output port.
[in] | outputID | NULL-terminated ID of output port |
[in] | activate | If non-zero, port should be activated (closed circuit), otherwise - deactivated (opened circuit) |
[in] | autoResetTimeoutMS | If non-zero, port MUST return to deactivated state in autoResetTimeoutMS millis |
Implemented in AxisRelayIOManager.
|
pure virtual |
Starts relay input monitoring or increments internal counter, if already started.
Implemented in AxisRelayIOManager.
|
pure virtual |
Stops input port monitoring if internal monitoring counter has reached zero.
Implementation MUST guarantee:
Implemented in AxisRelayIOManager.
|
pure virtual |
Removes handler from event receiver list.
If handler is not registered, nothing is done Implementation MUST guarantee:
Implemented in AxisRelayIOManager.