PLCameraInstance Class#
Inheritance Hierarchy#
System.Object
Basler.Pylon.PLCameraInstance
Properties#
| Name | Description | |
|---|---|---|
  | AcquisitionStartStopExecutionEnable | If set, this will automatically execute AcquisitionStart when calling StartGrabbing and AcquisitionStop when calling StopGrabbing. This option is enabled by default. Visibility: Guru |
| BufferHandlingMode | Determines whether the number of available buffers is limited and when they are allocated. Visibility: Expert |
| ChunkNodeMapsEnable | Enables/disables the use of a chunk node map for each grab result. Grab result chunk node maps can be disabled to save resources. Visibility: Guru |
| ClearBufferModeEnable | If set, all buffers will be cleared (set to 0) before grabbing an image. Note that this requires additional processing time per frame. Visibility: Guru |
| GrabCameraEvents | Enables/disables the grabbing of camera events while images are grabbed. Is writable when the camera object is closed. Visibility: Expert |
| GrabLoopThreadPriority | This value sets the absolute thread priority for the grab loop thread. Visibility: Guru |
| GrabLoopThreadPriorityOverride | If enabled, the user can set a custom priority for the grab loop thread. Otherwise, the priority of the newly created thread is not changed. Visibility: Guru |
| GrabLoopThreadTimeout | A custom timeout for the grab loop thread's call to RetrieveResult. RetrieveResult is configured to throw an exception on timeout, which will stop the grab session. Visibility: Beginner |
| GrabLoopThreadUseTimeout | If enabled, the user can set a custom timeout for the grab loop thread's call to RetrieveResult. RetrieveResult is configured to throw an exception on timeout, which will stop the grab session. Visibility: Guru |
| InternalGrabEngineThreadPriority | This value sets the absolute thread priority for the internal grab engine thread operating the stream grabber. Visibility: Guru |
| InternalGrabEngineThreadPriorityOverride | If enabled, the user can set a custom priority for the internal grab engine thread operating the stream grabber. Otherwise the priority defaults to 25. Visibility: Guru |
| MaxNumBuffer | The maximum number of buffers that are allocated and used for grabbing. Visibility: Beginner |
| MaxNumGrabResults | The maximum number of grab results available at any time during a grab session. This value can be limited to save resources. Furthermore, it can be used to check that the grab results are returned correctly. Visibility: Beginner |
| MaxNumQueuedBuffer | The maximum number of buffers that are queued in the stream grabber input queue. Visibility: Beginner |
| MigrationModeActive | The migration mode is set up according to this setting at defined points e.g., when the camera is opened. Visibility: Guru |
| MonitorModeActive | The camera object is set to monitor mode when enabled, e.g. when using the GigE multicast feature. Is writable when the camera object is closed. Visibility: Guru |
| NumEmptyBuffers | The number of empty buffers that are not used for grabbing yet. Visibility: Expert |
| NumQueuedBuffers | This is the number of buffers that are queued for grabbing in the stream grabber. The number is influenced by the number of available free buffers and the maximum number of buffers that can be queued. See also the MaxNumBuffer and MaxNumQueuedBuffer parameters. This parameter can be used to check whether the number of buffers ready for grabbing is stable, which means that the image processing is fast enough to keep up with the rate of incoming images when using the GrabStrategy_OneByOne grab strategy. Visibility: Expert |
| NumReadyBuffers | The number of grab result buffers in the output queue that are ready for retrieval. Visibility: Expert |
| OutputQueueSize | The size of the grab result buffer output queue. Visibility: Expert |
| StaticChunkNodeMapPoolSize | If larger than 0, a static chunk node map pool is used instead of dynamic chunk node map creation. Visibility: Guru |
| UseExtendedIdIfAvailable | Enabling this setting will use Extended ID if it is supported by the camera and driver. If it is not supported, it will not be used and this setting has no negative side effects. Visibility: Guru |
PLCameraInstance.AcquisitionStartStopExecutionEnable Property#
If set, this will automatically execute AcquisitionStart when calling StartGrabbing and AcquisitionStop when calling StopGrabbing. This option is enabled by default.
Visibility: Guru
PLCameraInstance.BufferHandlingMode Property#
Determines whether the number of available buffers is limited and when they are allocated.
Visibility: Expert
PLCameraInstance.ChunkNodeMapsEnable Property#
Enables/disables the use of a chunk node map for each grab result. Grab result chunk node maps can be disabled to save resources.
Visibility: Guru
PLCameraInstance.ClearBufferModeEnable Property#
If set, all buffers will be cleared (set to 0) before grabbing an image. Note that this requires additional processing time per frame.
Visibility: Guru
PLCameraInstance.GrabCameraEvents Property#
Enables/disables the grabbing of camera events while images are grabbed. Is writable when the camera object is closed.
Visibility: Expert
PLCameraInstance.GrabLoopThreadPriority Property#
This value sets the absolute thread priority for the grab loop thread.
Visibility: Guru
PLCameraInstance.GrabLoopThreadPriorityOverride Property#
If enabled, the user can set a custom priority for the grab loop thread. Otherwise, the priority of the newly created thread is not changed.
Visibility: Guru
PLCameraInstance.GrabLoopThreadTimeout Property#
A custom timeout for the grab loop thread's call to RetrieveResult. RetrieveResult is configured to throw an exception on timeout, which will stop the grab session.
Visibility: Beginner
PLCameraInstance.GrabLoopThreadUseTimeout Property#
If enabled, the user can set a custom timeout for the grab loop thread's call to RetrieveResult. RetrieveResult is configured to throw an exception on timeout, which will stop the grab session.
Visibility: Guru
PLCameraInstance.InternalGrabEngineThreadPriority Property#
This value sets the absolute thread priority for the internal grab engine thread operating the stream grabber.
Visibility: Guru
PLCameraInstance.InternalGrabEngineThreadPriorityOverride Property#
If enabled, the user can set a custom priority for the internal grab engine thread operating the stream grabber. Otherwise the priority defaults to 25.
Visibility: Guru
PLCameraInstance.MaxNumBuffer Property#
The maximum number of buffers that are allocated and used for grabbing.
Visibility: Beginner
PLCameraInstance.MaxNumGrabResults Property#
The maximum number of grab results available at any time during a grab session. This value can be limited to save resources. Furthermore, it can be used to check that the grab results are returned correctly.
Visibility: Beginner
PLCameraInstance.MaxNumQueuedBuffer Property#
The maximum number of buffers that are queued in the stream grabber input queue.
Visibility: Beginner
PLCameraInstance.MigrationModeActive Property#
The migration mode is set up according to this setting at defined points e.g., when the camera is opened.
Visibility: Guru
PLCameraInstance.MonitorModeActive Property#
The camera object is set to monitor mode when enabled, e.g. when using the GigE multicast feature. Is writable when the camera object is closed.
Visibility: Guru
PLCameraInstance.NumEmptyBuffers Property#
The number of empty buffers that are not used for grabbing yet.
Visibility: Expert
PLCameraInstance.NumQueuedBuffers Property#
This is the number of buffers that are queued for grabbing in the stream grabber. The number is influenced by the number of available free buffers and the maximum number of buffers that can be queued. See also the MaxNumBuffer and MaxNumQueuedBuffer parameters. This parameter can be used to check whether the number of buffers ready for grabbing is stable, which means that the image processing is fast enough to keep up with the rate of incoming images when using the GrabStrategy_OneByOne grab strategy.
Visibility: Expert
PLCameraInstance.NumReadyBuffers Property#
The number of grab result buffers in the output queue that are ready for retrieval.
Visibility: Expert
PLCameraInstance.OutputQueueSize Property#
The size of the grab result buffer output queue.
Visibility: Expert
PLCameraInstance.StaticChunkNodeMapPoolSize Property#
If larger than 0, a static chunk node map pool is used instead of dynamic chunk node map creation.
Visibility: Guru
PLCameraInstance.UseExtendedIdIfAvailable Property#
Enabling this setting will use Extended ID if it is supported by the camera and driver. If it is not supported, it will not be used and this setting has no negative side effects.
Visibility: Guru