wpi::cs::VideoProperty Class Reference

A source or sink property. More...

#include <wpi/cs/VideoProperty.hpp>

Public Types
enum	Kind {   kNone = CS_PROP_NONE , kBoolean = CS_PROP_BOOLEAN , kInteger = CS_PROP_INTEGER , kString = CS_PROP_STRING ,   kEnum = CS_PROP_ENUM }

Public Member Functions
	VideoProperty ()=default
std::string	GetName () const
	Returns property name.
Kind	GetKind () const
	Returns property kind.
	operator bool () const
	Returns true if property is valid.
bool	IsBoolean () const
	Returns true if property is a boolean.
bool	IsInteger () const
	Returns true if property is an integer.
bool	IsString () const
	Returns true if property is a string.
bool	IsEnum () const
	Returns true if property is an enum.
int	Get () const
	Returns property value.
void	Set (int value)
	Sets property value.
int	GetMin () const
	Returns property minimum value.
int	GetMax () const
	Returns property maximum value.
int	GetStep () const
	Returns property step size.
int	GetDefault () const
	Returns property default value.
std::string	GetString () const
	Returns the string property value.
std::string_view	GetString (wpi::util::SmallVectorImpl< char > &buf) const
	Returns the string property value as a reference to the given buffer.
void	SetString (std::string_view value)
	Sets the string property value.
std::vector< std::string >	GetChoices () const
	Returns the possible values for the enum property value.
CS_Status	GetLastStatus () const
	Returns the last status.

Friends
class	ImageSource
class	VideoEvent
class	VideoSink
class	VideoSource

Detailed Description

A source or sink property.

---

The documentation for this class was generated from the following file:

• wpi/cs/VideoProperty.hpp