avcap::V4L2_MenuControl Class Reference

#include <avcap/linux/V4L2_MenuControl.h>

Inheritance diagram for avcap::V4L2_MenuControl:

Inheritance graph
[legend]

Detailed Description

A Control for a Video4Linux2 device which has various menu-like items to choose from.


Public Member Functions

 V4L2_MenuControl (V4L2_DeviceDescriptor *dd, struct v4l2_queryctrl *query)
 The constructor.
virtual ~V4L2_MenuControl ()
 The destructor.
virtual int getId () const
 Get the unique identifier of the control.
virtual int getDefaultValue () const
 Get the default value of the control.
virtual const std::string & getName () const
 Get the name of the control.
virtual int setValue (int val)
 Set the new value of the control.
virtual int getValue () const
 Get the current value of the control.
virtual int reset ()
 Set the value of the control to the default value.
virtual const ItemListgetItemList ()
 Returns the STL-list of menu items associated with this control.


Constructor & Destructor Documentation

avcap::V4L2_MenuControl::V4L2_MenuControl ( V4L2_DeviceDescriptor dd,
struct v4l2_queryctrl *  query 
)

The constructor.

virtual avcap::V4L2_MenuControl::~V4L2_MenuControl (  )  [virtual]

The destructor.


Member Function Documentation

virtual int avcap::V4L2_MenuControl::getId (  )  const [inline, virtual]

Get the unique identifier of the control.

Returns:
id

Implements avcap::Control.

virtual int avcap::V4L2_MenuControl::getDefaultValue (  )  const [inline, virtual]

Get the default value of the control.

Returns:
default value

Implements avcap::Control.

virtual const std::string& avcap::V4L2_MenuControl::getName (  )  const [inline, virtual]

Get the name of the control.

Returns:
control name

Implements avcap::Control.

virtual int avcap::V4L2_MenuControl::setValue ( int  val  )  [inline, virtual]

Set the new value of the control.

Parameters:
val : The new value.
Returns:
0, if successful, -1 else

Implements avcap::Control.

virtual int avcap::V4L2_MenuControl::getValue (  )  const [inline, virtual]

Get the current value of the control.

Returns:
the value

Implements avcap::Control.

virtual int avcap::V4L2_MenuControl::reset (  )  [inline, virtual]

Set the value of the control to the default value.

Returns:
0, if successful, -1 else

Implements avcap::Control.

virtual const ItemList& avcap::V4L2_MenuControl::getItemList (  )  [inline, virtual]

Returns the STL-list of menu items associated with this control.

Returns:
the menu items.

Implements avcap::MenuControl.


The documentation for this class was generated from the following file:
Generated on Mon Nov 30 11:10:33 2009 for avcap-0.1 by  doxygen 1.5.1