Interface IWindowCaptureTrigger<TDetectionResult>
Represents a base interface for all triggers that operate on captured window/screen images, including color search, image search, or machine learning-based object detection.
Inherited Members
Namespace: EyeAuras.OpenCVAuras.Triggers.WindowCapture
Assembly: EyeAuras.OpenCVAuras.Shared.dll
Syntax
public interface IWindowCaptureTrigger<TDetectionResult> : IAuraTrigger, IAuraEntity, IAuraObject, IBindableReactiveObject, IHasId, IHasTypedId<string>, ICanSetContext, IHasContext, IHasErrors, IDisposable, IHasError, IHasErrorProvider, ICanSetName, IHasName, ICanSetDescription, IHasDescription, IHasBoundsWindow, IHasAttachedWindow, INotifyPropertyChanged where TDetectionResult : ICaptureTriggerDetectionResultType Parameters
| Name | Description |
|---|---|
| TDetectionResult | The type of result produced by the trigger. |
Properties
| Name | Description |
|---|---|
| Bounds | Gets or sets the bounding box relative to the top-left corner of the region inside the captured window. |
| BoundsScreen | Gets or sets the bounding box relative to the top-left corner of the screen for the captured region. |
| CaptureCursor | Gets or sets a value indicating whether the cursor should be included in the capture. |
| CaptureSourceId | Gets or sets the unique identifier for the capture source, such as a window or screen. |
| EnablePreview | Gets or sets a value indicating whether to enable a preview of the captured image. |
| MaxFramesPerSecond | Gets or sets the maximum frames per second (FPS) rate for the capture process. |
| MinFramesPerSecond | Gets or sets the minimum frames per second (FPS) rate for the capture process. |
| TargetWindow | Specifies the expression used to identify and target a specific window for capture. |
| WhenImageProcessed | Stream of processing results retrieved by this trigger, providing the output of the capture and analysis process. Images must be processed on the same thread! |
| WindowRegion | Gets the region of the window or screen to be captured, defined in a complex position model format. |
Methods
| Name | Description |
|---|---|
| GetFrameStats() | Gets frame stats for the captured window - fps(expected, actual) |
| Refresh(bool, CancellationToken) | Synchronously forces a refresh of the current image, performing detection and updating the capture to the latest state. |
| Refresh(CancellationToken) | Synchronously forces a refresh of the current image, performing detection and updating the capture to the latest state. |
| RefreshAsync(bool, CancellationToken) | Asynchronously forces a refresh of the current image, performing detection and updating the capture to the latest state. |
| RefreshAsync(CancellationToken) | Asynchronously forces a refresh of the current image, performing detection and updating the capture to the latest state. |