Table of Contents

Namespace VisioForge.Core.Types.Events

Classes

AFFaceDetectionEventArgs

Provides data for the OnFaceDetected event, containing information about detected faces in a video frame.

AudioEventArgs

Provides data for a detected audio event raised by the audio-event-detection block.

AudioFrameBufferEventArgs

Provides data for events that deliver audio frame buffers. This class encapsulates an VisioForge.Core.Types.AudioFrame and additional metadata, allowing it to be passed as an argument in event handlers.

AudioLevelEventArgs

Provides data for audio level events, containing audio level information for individual channels and overall average values.

AudioScoresEventArgs

Provides the top-K AudioSet class scores for a single processed window, raised by the audio-event block when its scores event is enabled (useful for a live meter). Raised on the inference worker thread.

BDAChannelEventArgs

Provides data for Broadcast Driver Architecture (BDA) channel-related events.

BarcodeEventArgs

Provides data for barcode detection events, containing information about the detected barcode.

CVCarDetectedEventArgs

Provides data for events that indicate the detection of cars in a video frame. This class encapsulates the number of cars detected and the time elapsed during the detection process.

CVFaceDetectedEventArgs

Provides data for events that indicate the detection of faces in a video frame. This class encapsulates an array of VisioForge.Core.Types.VideoProcessing.CVFace objects, each representing a detected face, along with the timestamp of the frame.

CVHandDetectedEventArgs

Provides data for events that indicate the detection of hands in a video frame. This class encapsulates an array of VisioForge.Core.Types.VideoProcessing.CVHand objects, each representing a detected hand.

CVMotionCellsEventArgs

Provides data for events that indicate motion detection based on a grid of cells. This class encapsulates information about which cells have detected motion, along with timing details.

CVPedestrianDetectedEventArgs

Provides data for events that indicate the detection of pedestrians in a video frame. This class encapsulates an array of VisioForge.Core.Types.Rect objects, each representing the bounding box of a detected pedestrian, along with the time elapsed during the detection process.

CVTemplateMatchEventArgs

Provides data for events that indicate the result of a template matching operation. This class encapsulates the bounding rectangle of the matched area and a confidence score.

ClosedCaptionsBufferEventArgs

Provides data for closed captions buffer events, containing raw closed caption data and timing information.

ClosedCaptionsTextEventArgs

Provides data for closed captions text events, containing decoded caption text and timing information.

CustomMixerQueueDropEventArgs

Provides data for CustomMixerSourceBlock queue drop events.

DVDDomainChangedEventArgs

Provides data for the DVD domain changed event.

DVDEventArgs

Provides data for DVD-related events.

DVDParentalLevelChangedEventArgs

Provides data for the DVD parental level changed event.

DVDeviceEventArgs

Provides data for Digital Video (DV) device events.

DataFrameEventArgs

Provides data for events that deliver generic data frames. This class encapsulates a VisioForge.Core.Types.DataFrame, allowing it to be passed as an argument in event handlers.

DeviceRemovedAddedEventArgs

Provides data for device removal and addition events, notifying when media devices are connected or disconnected from the system.

ErrorsEventArgs

Provides data for error events, encapsulating details about an error or warning that occurred within the framework.

FFMPEGInfoEventArgs

Provides data for FFMPEG informational events.

FFMPEGSourceTimestampEventArgs

Provides data for events that deliver timestamp information from an FFmpeg source. This class is used to convey the current playback or processing time for different media types within an FFmpeg stream.

FacesIdentifiedEventArgs

Provides data for events that report faces recognized in a video frame by the face recognition block.

FilterEventArgs

Provides data for filter-related events in DirectShow/Media Foundation pipelines. This event is raised when filters are added, removed, or modified in the media processing pipeline.

FrameEmbeddingEventArgs

Event data raised by the video embedding block for each sampled frame, carrying the frame's presentation timestamp and its L2-normalized CLIP embedding vector.

KLVPacketEventArgs

Provides data for the VideoCaptureCore.OnKLVPacketEmitted event, which fires once per KLV packet after the per-destination reorder buffer has emitted it and immediately before it is written to the destination.

LicenseEventArgs

Carries the SDK edition that the current configuration requires, together with the feature that asks for it. Supplied to the OnLicenseRequired event of the capture, playback, editing and compositor engines.

LicensePlateRecognizedEventArgs

Provides data for events that report license plates recognized in a video frame by the ANPR block.

MIDIInfoEventArgs

Provides data for MIDI file information events. This event is raised when MIDI file metadata is read or updated during playback.

MotionDetectionEventArgs

Provides data for motion detection events, indicating the level of motion and a matrix representing motion areas.

MotionDetectionExEventArgs

Provides data for extended motion and object detection events. This class offers more detailed information about detected motion, including an overall motion level, detected objects, and a motion grid.

MouseClickEventArgs

Event arguments for mouse click events providing screen coordinates.

MouseEventArgsEx

Provides extended data for mouse events within video views and media controls. This event args class includes information about mouse position, button state, and keyboard modifiers.

NetworkSourceDisconnectEventArgs

Provides data for events that indicate a network source has disconnected or encountered a connection error. This class encapsulates information about the disconnected source, including the element name, error details, and the source URI when available.

NewFilePlaybackEventArgs

Provides data for the new file playback event. This event is raised when a media player starts playing a new file, typically in playlist scenarios.

ObjectAnalyticsEventArgs

Event arguments for the ObjectAnalyticsBlock.OnAnalyticsUpdated event, carrying the processed objects, line crossings, zone snapshots, and source frame timestamp.

ObjectsDetectedEventArgs

Provides data for events that report objects detected in a video frame by an ONNX-based detector.

OcrTextDetectedEventArgs

Provides data for events that report text recognized in a video frame by the OCR block.

OnDeviceCanStartEventArgs

Provides data for the device startup validation event. This event allows applications to control whether a device should be allowed to start.

PIIRegionsRedactedEventArgs

Provides data for events that report PII regions detected (and redacted) in a video frame.

ProgressEventArgs

Provides data for progress update events, indicating the completion percentage of an operation.

ReframeEventArgs

Event arguments for the AutoReframeBlock.OnReframeUpdated event, carrying the crop window applied to the source frame, the subject being followed (if any), and the source frame timestamp.

RenderStatisticsEventArgs

Provides data for periodic render-statistics events emitted by a real-time video compositor.

SeparateCaptureFileEventArgs

Provides data for the separate capture file event that occurs when a new segment is created during multi-segment recording or when a secondary capture file is created.

SilenceDetectionEventArgs

Event arguments for silence detection events that are raised when silence starts or ends in an audio stream. Provides detailed information about the timing and characteristics of the detected silence period, enabling applications to respond to audio level changes in real-time for recording, streaming, or analysis purposes.

SourceConnectedEventArgs

Provides data for the source connected event that occurs when a media source (camera, file, stream, etc.) successfully connects and provides its media properties.

SpeakerSegmentEventArgs

Provides data for the speaker-segment event raised by the speaker-diarization block as each turn finalizes.

SpeechRecognizedEventArgs

Provides data for the speech-recognized event raised by the speech-to-text block.

StopEventArgs

Provides data for events that indicate a media operation has stopped. This class encapsulates information about the success of the operation and the final position reached.

SubtitlesSettingsEventArgs

Provides data for the subtitles settings event that occurs when DirectVobSub subtitle filter is initialized and ready for configuration.

TVTunerTuneChannelsEventArgs

Provides data for the TV tuner channel scanning event that occurs during automatic channel discovery or manual frequency tuning operations.

TimeshiftFileEventArgs

Provides data for the timeshift file event that occurs when a new timeshift buffer file is created during live TV/stream viewing with pause capabilities.

VLMResultGeneratedEventArgs

Provides data for the event raised when the Florence-2 VLM block finishes an inference on a frame.

VideoFrameBitmapEventArgs

Provides data for video frame bitmap events, including the frame image, timestamp, and stream information.

VideoFrameBufferEventArgs

Provides data for events that deliver video frame buffers. This class encapsulates a VisioForge.Core.Types.VideoFrame and additional metadata, allowing it to be passed as an argument in event handlers.

VideoFrameXBufferEventArgs

Video frame buffer event args (for X engines). Implements the EventArgs.

Enums

FFMPEGSourceMediaType

Defines the types of media streams that can be found in an FFmpeg source. This enumeration helps categorize different tracks within a multimedia file or stream.

KLVDestinationKind

Identifies which KLV destination emitted a VisioForge.Core.Types.Events.KLVPacketEventArgs. A single capture session can have several destinations active at once (e.g. file recording AND network restream); subscribers distinguish them via VisioForge.Core.Types.Events.KLVPacketEventArgs.Destination.