• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdenetwork API Reference
  • KDE Home
  • Contact Us
 

kopete/libkopete

  • Kopete
  • AV
  • VideoDevicePool
Signals | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
Kopete::AV::VideoDevicePool Class Reference

#include <videodevicepool.h>

Inheritance diagram for Kopete::AV::VideoDevicePool:
Inheritance graph
[legend]

Signals

void deviceRegistered (const QString &udi)
 
void deviceUnregistered (const QString &udi)
 

Public Member Functions

 ~VideoDevicePool ()
 
int close ()
 
int currentDevice ()
 
QString currentDeviceUdi ()
 
int currentInput ()
 
void fillDeviceKComboBox (KComboBox *combobox)
 
void fillInputKComboBox (KComboBox *combobox)
 
void fillStandardKComboBox (KComboBox *combobox)
 
int getControlValue (quint32 ctrl_id, qint32 *value)
 
int getFrame ()
 
int getImage (QImage *qimage)
 
QList< ActionVideoControl > getSupportedActionControls ()
 
QList< BooleanVideoControl > getSupportedBooleanControls ()
 
QList< MenuVideoControl > getSupportedMenuControls ()
 
QList< NumericVideoControl > getSupportedNumericControls ()
 
int height ()
 
int inputs ()
 
bool isOpen ()
 
int maxHeight ()
 
int maxWidth ()
 
int minHeight ()
 
int minWidth ()
 
int open (int device=-1)
 
void saveCurrentDeviceConfig ()
 
int selectInput (int newinput)
 
int setControlValue (quint32 ctrl_id, qint32 value)
 
int setImageSize (int newwidth, int newheight)
 
int size ()
 
int startCapturing ()
 
int stopCapturing ()
 
int width ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Static Public Member Functions

static VideoDevicePool * self ()
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
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)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Protected Slots

void deviceAdded (const QString &udi)
 
void deviceRemoved (const QString &udi)
 

Protected Member Functions

int getSavedDevice ()
 
void loadDeviceConfig ()
 
bool registerDevice (Solid::Device &dev)
 
int showDeviceCapabilities (int device=-1)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

int m_current_device
 
QVector< VideoDevice * > m_videodevices
 

Additional Inherited Members

- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

This class allows kopete to check for the existence, open, configure, test, set parameters, grab frames from and close a given video capture card using the Video4Linux API.

Author
Cláudio da Silveira Pinheiro

Definition at line 46 of file videodevicepool.h.

Constructor & Destructor Documentation

Kopete::AV::VideoDevicePool::~VideoDevicePool ( )

Destructor of class VideoDevicePool.

Definition at line 90 of file videodevicepool.cpp.

Member Function Documentation

int Kopete::AV::VideoDevicePool::close ( )

Closes the device.

Returns
The success of the operation: EXIT_SUCCESS or EXIT_FAILURE

Definition at line 173 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::currentDevice ( )

Returns the index of the current device.

Returns
The index of the current device or -1 if no device available

Definition at line 216 of file videodevicepool.cpp.

QString Kopete::AV::VideoDevicePool::currentDeviceUdi ( )

Returns the unique device identifier (UDI) of the currently selected device.

Returns
The unique device identifier (UDI) of the currently selected device

Definition at line 229 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::currentInput ( )

Returns the index of the currently selected input.

Returns
The index of the currently selected input or -1, if no input is available

Definition at line 255 of file videodevicepool.cpp.

void Kopete::AV::VideoDevicePool::deviceAdded ( const QString &  udi)
protectedslot

Slot called when a new device is added to the system.

Checks the device with the specified UDI and adds to the device pool, if it is a valid video device.

Parameters
udiUnique device identifier (UDI) of the device that has been connected

Definition at line 761 of file videodevicepool.cpp.

void Kopete::AV::VideoDevicePool::deviceRegistered ( const QString &  udi)
signal

Provisional signatures, probably more useful to indicate which device was registered.

void Kopete::AV::VideoDevicePool::deviceRemoved ( const QString &  udi)
protectedslot

Removes the device with the specified UDI from the device pool.

Parameters
udiUnique device identifier (UDI) of the device that has been unplugged

Definition at line 780 of file videodevicepool.cpp.

void Kopete::AV::VideoDevicePool::deviceUnregistered ( const QString &  udi)
signal
void Kopete::AV::VideoDevicePool::fillDeviceKComboBox ( KComboBox *  combobox)

Fills a combobox with the names of all available video devices.

Parameters
comboboxPointer to a KComboBox object

Definition at line 486 of file videodevicepool.cpp.

void Kopete::AV::VideoDevicePool::fillInputKComboBox ( KComboBox *  combobox)

Fills a combobox with the names of all available inputs for the currently selected device.

Parameters
comboboxPointer to a KComboBox object

Definition at line 509 of file videodevicepool.cpp.

void Kopete::AV::VideoDevicePool::fillStandardKComboBox ( KComboBox *  combobox)

Fills a combobox with the names of the available signal standards for the currently selected device.

Parameters
comboboxPointer to a KComboBox object

Definition at line 536 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::getControlValue ( quint32  ctrl_id,
qint32 *  value 
)

Reads the value of a video-control.

Parameters
ctrl_idID of the video-control
valuePointer to the variable, which receives the value of the querried video-control. For boolean controls, the value is 0 or 1. For menu-controls, the value is the index of the currently selected option.
Returns
The result-code, currently EXIT_SUCCESS or EXIT_FAILURE

Definition at line 341 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::getFrame ( )

Definition at line 400 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::getImage ( QImage *  qimage)

Definition at line 412 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::getSavedDevice ( )
protected

Returns the index of the saved device.

Returns
The index of the saved device or -1, if the saved device is not available

Definition at line 568 of file videodevicepool.cpp.

QList< ActionVideoControl > Kopete::AV::VideoDevicePool::getSupportedActionControls ( )

Returns the supported action-controls for the current input.

Returns
A list of all supported action-controls for the current input

Definition at line 324 of file videodevicepool.cpp.

QList< BooleanVideoControl > Kopete::AV::VideoDevicePool::getSupportedBooleanControls ( )

Returns the supported boolean controls for the current input.

Returns
A list of all supported boolean controls for the current input

Definition at line 298 of file videodevicepool.cpp.

QList< MenuVideoControl > Kopete::AV::VideoDevicePool::getSupportedMenuControls ( )

Returns the supported menu-controls for the current input.

Returns
A list of all supported menu-controls for the current input

Definition at line 311 of file videodevicepool.cpp.

QList< NumericVideoControl > Kopete::AV::VideoDevicePool::getSupportedNumericControls ( )

Returns the supported numeric controls for the current input.

Returns
A list of all supported numeric controls for the current input

Definition at line 285 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::height ( )

Definition at line 447 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::inputs ( )

Returns the number of available inputs of the currently selected device.

Returns
The number of inputs of the currently selected device

Definition at line 242 of file videodevicepool.cpp.

bool Kopete::AV::VideoDevicePool::isOpen ( )

Returns true if the currently selected device is open and false othwerise.

Returns
True if the device is open, false otherwise

Definition at line 104 of file videodevicepool.cpp.

void Kopete::AV::VideoDevicePool::loadDeviceConfig ( )
protected

Loads and applies the configuration for the currently selected device.

Loads the input and the values for all video-controls and applies them.

Definition at line 603 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::maxHeight ( )

Definition at line 463 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::maxWidth ( )

Definition at line 439 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::minHeight ( )

Definition at line 455 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::minWidth ( )

Definition at line 431 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::open ( int  device = -1)

Opens the video device with the specified index. The previously opened device is closed before.

Parameters
deviceIndex of the device that should be opened. If a negative index is passed (default), the default device will be opened, which is either the saved device (if available) or alternatively the device with index 0.
Returns
The result-code, EXIT_SUCCESS or EXIT_FAILURE

Definition at line 120 of file videodevicepool.cpp.

bool Kopete::AV::VideoDevicePool::registerDevice ( Solid::Device &  device)
protected

Checks if the given device is a valid video device and adds it do the device list.

Parameters
deviceThe solid device that should be registered
Returns
True, if the device has been registered; otherwise returns false

Definition at line 817 of file videodevicepool.cpp.

void Kopete::AV::VideoDevicePool::saveCurrentDeviceConfig ( )

Saves the current device configuration.

Saves the current device, the current input and the current values for all supported video-controls.

Definition at line 655 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::selectInput ( int  input)

Selects the input of the current video device.

Parameters
inputIndex of input to be selected
Returns
The result-code, EXIT_SUCCESS or EXIT_FAILURE

Definition at line 269 of file videodevicepool.cpp.

VideoDevicePool * Kopete::AV::VideoDevicePool::self ( )
static

Returns pointer to a common instance of the VideoDevicePool.

Returns
Pointer to the VideoDevicePool object

Definition at line 57 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::setControlValue ( quint32  ctrl_id,
qint32  value 
)

Sets the value of a video-control.

Parameters
ctrl_idID of the video-control
valueThe value that should be set. For boolean controls, the value must be 0 or 1. For menu-controls, the value must be the index of the option. For action-controls, the value is ignored.
Returns
The result-code, currently EXIT_SUCCESS or EXIT_FAILURE

Definition at line 359 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::setImageSize ( int  newwidth,
int  newheight 
)

Definition at line 471 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::showDeviceCapabilities ( int  device = -1)
protected

Definition at line 744 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::size ( )

Returns the number of available video devices.

Returns
The number of available video devices

Definition at line 206 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::startCapturing ( )

Starts capturing from the currently selected video device.

Returns
The result-code, EXIT_SUCCESS or EXIT_FAILURE

Definition at line 374 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::stopCapturing ( )

Starts capturing from the currently selected video device.

Returns
The result-code, EXIT_SUCCESS or EXIT_FAILURE

Definition at line 389 of file videodevicepool.cpp.

int Kopete::AV::VideoDevicePool::width ( )

Definition at line 423 of file videodevicepool.cpp.

Member Data Documentation

int Kopete::AV::VideoDevicePool::m_current_device
protected

Definition at line 92 of file videodevicepool.h.

QVector<VideoDevice*> Kopete::AV::VideoDevicePool::m_videodevices
protected

Vector of pointers to the available video devices

Definition at line 93 of file videodevicepool.h.


The documentation for this class was generated from the following files:
  • videodevicepool.h
  • videodevicepool.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:29:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/libkopete

Skip menu "kopete/libkopete"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdenetwork API Reference

Skip menu "kdenetwork API Reference"
  • kget
  • kopete
  •   kopete
  •   libkopete
  • krdc
  • krfb

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal