Syntax


 PXL_RETURN_CODE PxLGetStreamState (
   HANDLE hCamera,
   U32    pStreamState,
   U32    pNumberFrameBuffers,);

 

Description


This function will return information about the video stream coming from the camera.


  • hCamera is the camera handle.  This value is returned by PxLInitializeEx.
  • pStreamState returns the current state of the video stream. Valid stream flags are: 
    • START_STREAM—The stream is running.
    • PAUSE_STREAM— Resources are allocated for the stream window.  The stream, however, is not running and the host CPU is minimizing CPU cycles on this task.
    • STOP_STREAM—The stream is stopped and no resources are allocated.

                These values are defined in the file PixeLINKTypes.h.

  • pNumberFrameBuffers returns the number of frame buffers currently in use by the API / drivers for this camera. These frame buffers are used in a cyclic fashion between the API and the camera driver. .



Comments, Restrictions and Limitations

If the camera is currently not streaming (*pStreamState == STOP_STREAM), then there will not be any frame buffers assigned to the camera (*pNumberFrameBuffers == 0).

The number of frame buffers assigned to a camera stream, can be influenced via PxLSetFrameBufferPolicy.