cs::VideoProperty Class Reference

A source or sink property. More...

#include <cscore_oo.h>

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
Kind	GetKind () const
	operator bool () const
bool	IsBoolean () const
bool	IsInteger () const
bool	IsString () const
bool	IsEnum () const
int	Get () const
void	Set (int value)
int	GetMin () const
int	GetMax () const
int	GetStep () const
int	GetDefault () const
std::string	GetString () const
std::string_view	GetString (wpi::SmallVectorImpl< char > &buf) const
void	SetString (std::string_view value)
std::vector< std::string >	GetChoices () const
CS_Status	GetLastStatus () const

Friends
class	ImageSource
class	VideoEvent
class	VideoSink
class	VideoSource

Detailed Description

A source or sink property.

Member Enumeration Documentation

Kind

enum cs::VideoProperty::Kind

Enumerator
kNone
kBoolean
kInteger
kString
kEnum

Constructor & Destructor Documentation

VideoProperty()

cs::VideoProperty::VideoProperty ( )

default

Member Function Documentation

Get()

int cs::VideoProperty::Get ( ) const

inline

GetChoices()

std::vector< std::string > cs::VideoProperty::GetChoices ( ) const

inline

GetDefault()

int cs::VideoProperty::GetDefault ( ) const

inline

GetKind()

Kind cs::VideoProperty::GetKind ( ) const

inline

GetLastStatus()

CS_Status cs::VideoProperty::GetLastStatus ( ) const

inline

GetMax()

int cs::VideoProperty::GetMax ( ) const

inline

GetMin()

int cs::VideoProperty::GetMin ( ) const

inline

GetName()

std::string cs::VideoProperty::GetName ( ) const

inline

GetStep()

int cs::VideoProperty::GetStep ( ) const

inline

GetString() [1/2]

std::string cs::VideoProperty::GetString ( ) const

inline

GetString() [2/2]

std::string_view cs::VideoProperty::GetString ( wpi::SmallVectorImpl< char > &  buf ) const

inline

IsBoolean()

bool cs::VideoProperty::IsBoolean ( ) const

inline

IsEnum()

bool cs::VideoProperty::IsEnum ( ) const

inline

IsInteger()

bool cs::VideoProperty::IsInteger ( ) const

inline

IsString()

bool cs::VideoProperty::IsString ( ) const

inline

operator bool()

cs::VideoProperty::operator bool ( ) const

inlineexplicit

Set()

void cs::VideoProperty::Set ( int  value )

inline

SetString()

void cs::VideoProperty::SetString ( std::string_view  value )

inline

Friends And Related Function Documentation

ImageSource

friend class ImageSource

friend

VideoEvent

friend class VideoEvent

friend

VideoSink

friend class VideoSink

friend

VideoSource

friend class VideoSource

friend

---

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

• cscore_oo.h
• cscore_oo.inc