AXptz
Functions
ax_ptz.h File Reference

The main entry to the AXPTZ library and its functions. More...

Go to the source code of this file.

Functions

gboolean ax_ptz_create (GError **error)
 Creates the AX PTZ library. More...
 
gboolean ax_ptz_destroy (GError **error)
 Destroys the AX PTZ library. More...
 
gint ax_ptz_get_num_video_channels (GError **error)
 Retrieves the number of video channels. More...
 

Detailed Description

The main entry to the AXPTZ library and its functions.

AXPTZ Library

AXPTZ is the main entry to the AXPTZ library. It creates and destroys the singleton instance of the AXPTZ library. In the create function singleton instances of the AXPTZControlQueue, AXPTZMovementHandler and AXPTZPresetHandler are created.

AXPTZ is the main entry to the AXPTZ library. It creates and destroys the singleton instance of the AXPTZ library. When the AXPTZ library is initialized, singleton instances of the AXPTZControlQueue, AXPTZMovementHandler and AXPTZPresetHandler are also created.

Function Documentation

◆ ax_ptz_create()

gboolean ax_ptz_create ( GError **  error)

Creates the AX PTZ library.

Parameters
errorReturn location for a GError or NULL.
Returns
TRUE on success, FALSE on failure.

Critical section

Important!!! Future development of the AXPTZ library must continue to follow the same pattern for thread safety:

  1. The ax_ptz_create/ax_ptz_destroy callstacks that creates/destroys the singletons instances of the _AXPTZMovementHandler, _AXPTZPresetHandler and _AXPTZControlQueue must be mutex protected.
  2. Global variables that can be changed in realtime outside the create/destroy callstacks must be mutex protected.
Examples:
axptzexample.c.

◆ ax_ptz_destroy()

gboolean ax_ptz_destroy ( GError **  error)

Destroys the AX PTZ library.

Parameters
errorReturn location for a GError or NULL.
Returns
TRUE on success, FALSE on failure.

Critical section Important!!! See ax_ptz_create for the thread safety rules in this library.

Examples:
axptzexample.c.

◆ ax_ptz_get_num_video_channels()

gint ax_ptz_get_num_video_channels ( GError **  error)

Retrieves the number of video channels.

Parameters
errorReturn location for a GError or NULL.
Returns
The number of video channels.