FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kCamera Class Reference

Description

Represents camera configuration.

Inheritance diagram for kCamera:
Inheritance graph

Public Member Functions

kCameraAccelerationTestMode kCamera_AccelerationTestMode (kCamera camera)
 Reports acceleration test mode of the camera. More...
 
kStatus kCamera_AccelerationTestModeInfo (kCamera camera, kInfoBits *info)
 Reports constraint and validity information for the Acceleration test mode setting. More...
 
kStatus kCamera_AddExtension (kCamera camera, kType type, kCameraExt *extension)
 Creates and adds a new camera control extension of the specified type. More...
 
kStatus kCamera_AddState (kCamera camera, kCameraState *state)
 Creates and adds a new state with default values. More...
 
kCameraAlgorithm kCamera_Algorithm (kCamera camera)
 Gets the hardware-accelerated algorithm supported by this camera. More...
 
kSize kCamera_AlgorithmBufferSize (kCamera camera)
 Reports the current camera algorithm buffer size. More...
 
kBool kCamera_AlgorithmEnabled (kCamera camera)
 Reports whether algorithm output is enabled, based on the current OutputMode setting. More...
 
kStatus kCamera_Clear (kCamera camera, kSize stateCount)
 Resets camera mode settings to defaults. More...
 
kStatus kCamera_ClearAll (kCamera camera, kSize stateCount)
 Resets camera mode and device settings to defaults. More...
 
kCameraControl kCamera_Control (kCamera camera)
 Reports the control mode of the camera. More...
 
k32u kCamera_ControlId (kCamera camera)
 Gets the control source id for a camera. More...
 
kStatus kCamera_ControlIdInfo (kCamera camera, kInfo *info)
 Reports constraint and validity information for the ControlId setting. More...
 
kStatus kCamera_ControlInfo (kCamera camera, kInfoBits *info)
 Reports constraint and validity information for the Control setting. More...
 
kStatus kCamera_DeleteExtension (kCamera camera, kCameraExt extension)
 Destroys the specified camera control extension and removes it from the camera's extension list. More...
 
kStatus kCamera_DeleteState (kCamera camera, kCameraState state)
 Destroys the specified state and removes it from the camera's state list. More...
 
kStatus kCamera_Enable (kCamera camera, kBool enable)
 Enables or disables the camera. More...
 
kStatus kCamera_EnableFpn (kCamera camera, kBool enabled)
 Specifies whether FPN is enabled. More...
 
kStatus kCamera_EnableFpnCalibration (kCamera camera, kBool enabled)
 Specifies whether FPN calibration is enabled. More...
 
kStatus kCamera_EnableLeadOut (kCamera camera, kBool enable)
 Determines whether estimated imager post-exposure is incorporated into nominal exposure. More...
 
kStatus kCamera_EnablePrnu (kCamera camera, kBool enabled)
 Specifies whether PRNU is enabled. More...
 
kStatus kCamera_EnableRamImage (kCamera camera, kBool enabled)
 Specifies whether the FPGA RAM Image feature is enabled. More...
 
kStatus kCamera_EnableTestPattern (kCamera camera, kBool enabled)
 Specifies whether Test pattern is enabled. More...
 
kCameraExt kCamera_ExtensionAt (kCamera camera, kSize index)
 Gets the control extension at the specified index. More...
 
kSize kCamera_ExtensionCount (kCamera camera)
 Gets the number of control extensions that have been configured. More...
 
kBool kCamera_FpnCalibrationEnabled (kCamera camera)
 Reports whether FPN calibration is currently enabled. More...
 
kBool kCamera_FpnCalibrationEnabledInfo (kCamera camera, kInfoBool *info)
 Reports constraint and validity information for the FpnCalibrationEnabled setting. More...
 
kBool kCamera_FpnEnabled (kCamera camera)
 Reports whether FPN is currently enabled. More...
 
kBool kCamera_FpnEnabledInfo (kCamera camera, kInfoBool *info)
 Reports constraint and validity information for the FpnEnabled setting. More...
 
kSize kCamera_Id (kCamera camera)
 Gets the id of the camera module. More...
 
kCameraInputCounterSource kCamera_InputCounterSource (kCamera camera)
 Retrieves the input counter source. More...
 
k32u kCamera_InputCounterSourceId (kCamera camera)
 Gets the input counter source id for a camera. More...
 
kStatus kCamera_InputCounterSourceIdInfo (kCamera camera, kInfo *info)
 Reports constraint and validity information for the InputCounterSourceId setting. More...
 
kStatus kCamera_InputCounterSourceInfo (kCamera camera, kInfoBits *info)
 Reports constraint and validity information for the Input Counter Source setting. More...
 
kBool kCamera_IsConnected (kCamera camera)
 Reports whether a camera device is connected and communicating. More...
 
kBool kCamera_IsEnabled (kCamera camera)
 Reports whether the camera is currently enabled. More...
 
kBool kCamera_LeadOutEnabled (kCamera camera)
 Reports whether camera lead-out is enabled. More...
 
kStatus kCamera_LeadOutEnabledInfo (kCamera camera, kInfoBool *info)
 Reports constraint and validity information for the LeadOutEnabled setting. More...
 
k32u kCamera_LvdsPower (kCamera camera)
 Reports the imager LVDS power setting. More...
 
kStatus kCamera_LvdsPowerInfo (kCamera camera, kInfo32u *info)
 Reports constraint and validity information for imager LVDS power setting. More...
 
k32u kCamera_MaxHeight (kCamera camera)
 Gets the absolute maximum height of the camera. More...
 
k32u kCamera_MaxWidth (kCamera camera)
 Gets the absolute maximum width of the camera. More...
 
k64u kCamera_MinimumPeriod (kCamera camera)
 Reports the time required by this camera to respond to an event. More...
 
kCameraModel kCamera_Model (kCamera camera)
 Gets the model of the camera. More...
 
kSize kCamera_NextAlgorithmBufferSize (kCamera camera)
 Reports the algorithm buffer size that will take effect after reset. More...
 
kSize kCamera_NextVideoBufferSize (kCamera camera)
 Reports the video buffer size that will take effect after reset. More...
 
kSize kCamera_NominalAlgorithmBufferSizeEx (kCamera camera, kSize frameCount)
 Gets required algorithm buffer size that is enough to buffer the desired number of frames. More...
 
kSize kCamera_NominalVideoBufferSize (kCamera camera, kSize frameCount)
 Gets required video buffer size that is enough to buffer the desired number of frames. More...
 
kCameraOutputMode kCamera_OutputMode (kCamera camera)
 Gets the output mode of the camera. More...
 
kStatus kCamera_OutputModeInfo (kCamera camera, kInfoBits *info)
 Reports constraint and validity information for the OutputMode setting. More...
 
kStatus kCamera_Override (kCamera camera, const kCameraOverrideItem *overrides, kSize count)
 Provides a list of configuration overrides to modify live camera behaviour. More...
 
kCameraPortMode kCamera_PortMode (kCamera camera)
 Gets the port mode of the camera. More...
 
kStatus kCamera_PortModeInfo (kCamera camera, kInfoBits *info)
 Reports constraint and validity information for the PortMode setting. More...
 
kBool kCamera_PrnuEnabled (kCamera camera)
 Reports whether PRNU is currently enabled. More...
 
kBool kCamera_PrnuEnabledInfo (kCamera camera, kInfoBool *info)
 Reports constraint and validity information for the PrnuEnabled setting. More...
 
kBool kCamera_RamImageEnabled (kCamera camera)
 Reports whether the FPGA RAM Image feature is currently enabled. More...
 
kBool kCamera_RamImageEnabledInfo (kCamera camera, kInfoBool *info)
 Reports constraint and validity information for the RamImageEnabled setting. More...
 
kStatus kCamera_ReadAccelerationTestResult (kCamera camera, kObject *data, kAlloc allocator)
 Retrieves algorithm (e.g. More...
 
kCameraReadout kCamera_Readout (kCamera camera)
 Gets the readout mode for the camera. More...
 
kStatus kCamera_ReadoutInfo (kCamera camera, kInfoBits *info)
 Reports constraint and validity information for the Readout setting. More...
 
k32u kCamera_ReductionFactor (kCamera camera)
 Reports the bandwidth reduction factor. More...
 
kStatus kCamera_ReductionFactorInfo (kCamera camera, kInfo32u *info)
 Reports constraint and validity information for the bandwidth reduction factor setting. More...
 
k32u kCamera_ReductionWindow (kCamera camera)
 Reports the window size used for bandwidth reduction. More...
 
kStatus kCamera_ReductionWindowInfo (kCamera camera, kInfo32u *info)
 Reports constraint and validity information for the bandwidth reduction window setting. More...
 
kStatus kCamera_SetAccelerationTestMode (kCamera camera, kCameraAccelerationTestMode mode)
 Sets the acceleration test mode of the camera. More...
 
kStatus kCamera_SetControl (kCamera camera, kCameraControl type)
 Sets the control mode of the camera. More...
 
kStatus kCamera_SetControlId (kCamera camera, k32u id)
 Sets the control source id for a camera. More...
 
kStatus kCamera_SetFactoryLvdsPower (kCamera camera)
 Set the imager LVDS power using kFactory default setting. More...
 
kStatus kCamera_SetInputCounterSource (kCamera camera, kCameraInputCounterSource source)
 Sets the input counter source for a camera. More...
 
kStatus kCamera_SetInputCounterSourceId (kCamera camera, k32u id)
 Sets the input counter source id for a camera. More...
 
kStatus kCamera_SetLvdsPower (kCamera camera, k32u power)
 Specifies the imager LVDS power setting. More...
 
kStatus kCamera_SetNextAlgorithmBufferSize (kCamera camera, kSize size)
 Sets the algorithm buffer size that will take effect after reset. More...
 
kStatus kCamera_SetNextVideoBufferSize (kCamera camera, kSize size)
 Sets the video buffer size that will take effect after reset. More...
 
kStatus kCamera_SetOutputMode (kCamera camera, kCameraOutputMode mode)
 Sets the output mode of the camera. More...
 
kStatus kCamera_SetPortMode (kCamera camera, kCameraPortMode mode)
 Sets the port mode of the camera. More...
 
kStatus kCamera_SetReadout (kCamera camera, kCameraReadout readoutMode)
 Sets the readout mode for the camera. More...
 
kStatus kCamera_SetReductionFactor (kCamera camera, k32u factor)
 Specifies the bandwidth reduction factor. More...
 
kStatus kCamera_SetReductionWindow (kCamera camera, k32u window)
 Specifies the window size to be used for bandwidth reduction. More...
 
kCameraState kCamera_StateAt (kCamera camera, kSize index)
 Gets the state at the specified index. More...
 
kSize kCamera_StateCount (kCamera camera)
 Gets the number of states belonging to the camera. More...
 
kStatus kCamera_StateCountInfo (kCamera camera, kInfoSize *info)
 Reports constraint and validity information for the StateCount setting. More...
 
kStatus kCamera_Stats (kCamera camera, kCameraStats *stats)
 Retrieve statistics. More...
 
kStatus kCamera_SwapStates (kCamera camera, kSize index0, kSize index1)
 Swaps the order of two states in the camera's state list. More...
 
kBool kCamera_TestPatternEnabled (kCamera camera)
 Reports whether test pattern is currently enabled. More...
 
kBool kCamera_TestPatternEnabledInfo (kCamera camera, kInfoBool *info)
 Reports constraint and validity information for the TestPatternEnabled setting. More...
 
kStatus kCamera_Trigger (kCamera camera)
 Provides a software trigger to a camera. More...
 
kSize kCamera_VideoBufferSize (kCamera camera)
 Reports the current camera video buffer size. More...
 
kBool kCamera_VideoEnabled (kCamera camera)
 Reports whether video output is enabled, based on the current OutputMode setting. More...
 
kStatus kCamera_WriteAccelerationTestData (kCamera camera, kObject data)
 Writes acceleration test input data. More...
 
kStatus kCamera_WriteFpn (kCamera camera, kImage offsets)
 Writes FPN table. More...
 
kStatus kCamera_WritePrnu (kCamera camera, kImage white, kImage black)
 Writes PRNU table. More...
 
kStatus kCamera_WriteRangeLut (kCamera camera, const kRangeLutParams *params, const kRangeLutArray *xArray, const kRangeLutArray *zArray, const kRangeLutArray *validArray)
 Writes FPGA Range LUT. More...
 

The documentation for this class was generated from the following file: