Prison::VideoScanner

Search for usage in LXR

Prison::VideoScanner Class Reference

#include <videoscanner.h>

Inheritance diagram for Prison::VideoScanner:

Properties

Prison::Format::BarcodeFormats formats
 
Prison::ScanResult result
 
QVideoSink * videoSink
 
- Properties inherited from QObject
 objectName
 

Signals

void formatsChanged ()
 
void resultChanged (const Prison::ScanResult &scanResult)
 
void resultContentChanged (const Prison::ScanResult &scanResult)
 
void videoSinkChanged ()
 

Public Member Functions

 VideoScanner (QObject *parent=nullptr)
 
Format::BarcodeFormats formats () const
 
ScanResult result () const
 
void setFormats (Format::BarcodeFormats formats)
 
void setVideoSink (QVideoSink *sink)
 
QVideoSink * videoSink () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Scans a live video feed for barcodes.

In Qt5 this can be added as a video filter to a VideoOutput element. In Qt6 this can be connected to a QVideoSink object.

Since
5.94

Definition at line 29 of file videoscanner.h.

Property Documentation

◆ formats

Prison::Format::BarcodeFormats Prison::VideoScanner::formats
readwrite

Definition at line 33 of file videoscanner.h.

◆ result

Prison::ScanResult Prison::VideoScanner::result
read

Definition at line 32 of file videoscanner.h.

◆ videoSink

QVideoSink * Prison::VideoScanner::videoSink
readwrite

Definition at line 35 of file videoscanner.h.

Constructor & Destructor Documentation

◆ VideoScanner()

VideoScanner::VideoScanner ( QObject * parent = nullptr)
explicit

Definition at line 72 of file videoscanner.cpp.

◆ ~VideoScanner()

VideoScanner::~VideoScanner ( )

Definition at line 90 of file videoscanner.cpp.

Member Function Documentation

◆ formats()

Format::BarcodeFormats VideoScanner::formats ( ) const

The barcode formats the scanner should look for.

By default all supported formats are enabled.

Definition at line 101 of file videoscanner.cpp.

◆ result()

ScanResult VideoScanner::result ( ) const

The latest result of the barcode scan.

Definition at line 96 of file videoscanner.cpp.

◆ resultChanged

void Prison::VideoScanner::resultChanged ( const Prison::ScanResult & scanResult)
signal

Emitted whenever we get a new scan result, as long as any property of the result changes.

On a live video feed this can be very frequently due to the changes of the position of the detected barcode. This is therefore useful e.g. for marking the position of the detected barcode.

See also
resultContentChanged

◆ resultContentChanged

void Prison::VideoScanner::resultContentChanged ( const Prison::ScanResult & scanResult)
signal

Emitted when a barcode with a new content has been detected, but not when merely the position of a barcode changes in the video stream.

This is useful e.g. for continuously scanning multiple codes in one go.

See also
resultChanged

◆ setFormats()

void VideoScanner::setFormats ( Format::BarcodeFormats formats)

Sets the barcode formats to detect.

Parameters
formatscan be OR'ed values from Format::BarcodeFormats.

Definition at line 106 of file videoscanner.cpp.

◆ setVideoSink()

void VideoScanner::setVideoSink ( QVideoSink * sink)

Sets the video sink to scan for barcodes.

Definition at line 121 of file videoscanner.cpp.

◆ videoSink()

QVideoSink * VideoScanner::videoSink ( ) const

The video sink being scanned for barcodes.

Definition at line 116 of file videoscanner.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 21 2024 11:58:06 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.