The following figure lists the API commands and shows the relationship between functional group of commands.


Two tables below list the API functions by functional group and alphabetically.  Designers should consult the referenced topics for detailed descriptions of the API functions.


Click on the figure to go directly to a function.


Grouped By Function


Detect Cameras
PxLGetNumberCameras()
Get the number of Firewire, USB or IP cameras currently connected to the bus. Will only detect IP cameras that have a valid IP address.
PxLGetNumberCamerasEx()
Get the number of cameras connected to the computer, including IP cameras that do not have a valid IP address.


Initialize a Camera
PxLInitialize()
Initialize a camera and return the camera handle.


Camera Identification
PxLGetCameraInfo()
Get Information about the specified camera.
PxLGetCameraInfoEx()
Returns version information about the Pixelink hardware and firmware.   
PxLSetCameraIPAddress()
Set the IP address of a specified IP camera.
PxLSetCameraName()
Set a name for the specified camera.


Camera Features
Enumerate Features
PxLGetCameraFeatures()
Get the list of the features supported by the specified camera.
Get/Set Features on Camera
PxLGetFeature()
Get the current value of the specified feature.
PxLSetFeature()
Set the value of the specified feature.
Load/Save Settings in the Camera's Non-Volatile Memory
PxLLoadSettings()
Load settings from non-volatile memory on the camera.
PxLSaveSettings()
Save the current settings to non-volatile memory on the camera.


Video Stream
PxLSetStreamState()
Set the current state of the video stream to be stopped, started and paused .


Overlay Callback
PxLSetCallback()
Specify a callback function to modify the video data in the preview window or as it is translated into an end-user format.


Preview
PxLSetPreviewSettings()
Set the preview window settings for the specified camera
PxLSetPreviewState()
Set the current state of the preview window to playing, stopped, or paused.
PxLResetPreviewWindow()
Reset the size of the preview window to the size of the streaming video (thereby optimizing display performance).


Image Capture
Image Data Acquisition
PxLGetClip()Get a video clip and save it as a Pixelink data stream (.pds) intermediate file.
PxLGetNextFrame()Get the next image frame from the camera and put it in an image buffer.
Translation to an End-User Format
PxLFormatClip()
Convert a Pixelink data stream (.pds) file to a video file (.avi).
PxLFormatClipEx()
Convert either an uncompressed Pixelink data stream (.pds) file, or a H264 compressed data stream, into a video file (.avi)
PxLFormatImage()
Convert a raw frame residing in an image buffer to an image file (.bmp, .tif, .psd, .jpg).


Error Reporting
PxLGetErrorReport()
Returns details about the last error that occurred.


Uninitialize a Camera
PxLUninitialize()
Uninitialize the specified camera.


Descriptor Control
PxLCreateDescriptor()
Create a descriptor for the specified camera.
PxLUpdateDescriptor()
Set the update mode for the specified descriptor.
PxLRemoveDescriptor()
Remove the descriptor form the specified camera.


Grouped Alphabetically


API Function Name
Description
PxLAssignController()
Initialize a specific controller, and assign it to a specific camera.
PxLCreateDescriptor()
Create a descriptor for the specified camera.
PxLFormatClip()
Convert a Pixelink data stream (.pds) file to a video file (.avi).
PxLFormatClipEx()
Convert either an uncompressed Pixelink data stream (.pds) file, or a H264 compressed data stream, into a video file (.avi)
PxLFormatImage()
Convert a raw frame residing in an image buffer to an image file (.bmp, .tif, .psd, .jpg).
PxLGetCameraFeatures()
Get the list of the features supported by the specified camera.
PxLGetCameraInfo()
Get information about the specified camera.
PxLGetCameraInfoEx()
Returns version information about the Pixelink hardware and firmware.   
PxLGetClip()
Get a video clip and save it as a Pixelink data stream (.pds) intermediate file.
PxLGetCurrentTimeStamp()
Returns the current value of the camera’s ‘clock’ that it uses to timestamp images.
PxLGetEncodedClip()
Saves an encoded (compressed) video clip to a file.
PxLGetErrorReport()
Returns details about the last error that occurred.
PxLGetFeature()
Get the current value of the specified feature.
PxLGetNextFrame()
Get the next image frame from the camera and put it in an image buffer.
PxLGetNumberCameras()
Get the number of cameras currently connected to the bus.
PxLInitialize()
Initialize a camera and return the camera handle.
PxLInitializeEx()
Initialize a camera in its entirety and obtain the camera handle for subsequent API function calls.
PxLLoadSettings()
Load settings from non-volatile memory on the camera.
PxLRemoveDescriptor()
Remove the descriptor from the specified camera.
PxLResetPreviewWindow()
Reset the size of the preview window to the size of the streaming video (thereby optimizing display performance).
PxLSaveSettings()
Save the current settings to non-volatile memory on the camera.
PxLSetCallback()
Specify a callback function to modify the video data in the preview window or as it is translated into an end-user format.
PxLSetCameraName()
Set a name for the specified camera.
PxLSetFeature()
Set the value of the specified feature.
PxLSetPreviewSettings()
Set the preview window settings for the specified camera.
PxLSetPreviewState()
Set the current state of the preview window to playing, stopped, or paused.
PxLSetPreviewStateEx()
Similar to PxLSetPreviewState, but accommodates a callback function, called when certain windows based operations are performed to the preview window.
PxLSetStreamState()
Set the current state of the video stream to stopped, started or paused.
PxLUnassignController()
Releases a particular controller, allowing it to be assigned to another camera.
PxLUninitialize()
Uninitialize the specified camera.
PxLUpdateDescriptor()
Set the update mode for the specified descriptor.