A source or sink property.
More...
#include <cscore_oo.h>
|
| 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::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.
|
|
A source or sink property.
◆ Kind
Enumerator |
---|
kNone | No specific property.
|
kBoolean | Boolean property.
|
kInteger | Integer property.
|
kString | String property.
|
kEnum | Enum property.
|
◆ VideoProperty()
cs::VideoProperty::VideoProperty |
( |
| ) |
|
|
default |
◆ Get()
int cs::VideoProperty::Get |
( |
| ) |
const |
|
inline |
Returns property value.
- Returns
- Property value.
◆ GetChoices()
std::vector< std::string > cs::VideoProperty::GetChoices |
( |
| ) |
const |
|
inline |
Returns the possible values for the enum property value.
This function is enum-specific.
- Returns
- The possible values for the enum property value.
◆ GetDefault()
int cs::VideoProperty::GetDefault |
( |
| ) |
const |
|
inline |
Returns property default value.
- Returns
- Property default value.
◆ GetKind()
Kind cs::VideoProperty::GetKind |
( |
| ) |
const |
|
inline |
Returns property kind.
- Returns
- Property kind.
◆ GetLastStatus()
CS_Status cs::VideoProperty::GetLastStatus |
( |
| ) |
const |
|
inline |
Returns the last status.
- Returns
- The last status.
◆ GetMax()
int cs::VideoProperty::GetMax |
( |
| ) |
const |
|
inline |
Returns property maximum value.
- Returns
- Property maximum value.
◆ GetMin()
int cs::VideoProperty::GetMin |
( |
| ) |
const |
|
inline |
Returns property minimum value.
- Returns
- Property minimum value.
◆ GetName()
std::string cs::VideoProperty::GetName |
( |
| ) |
const |
|
inline |
Returns property name.
- Returns
- Property name.
◆ GetStep()
int cs::VideoProperty::GetStep |
( |
| ) |
const |
|
inline |
Returns property step size.
- Returns
- Property step size.
◆ GetString() [1/2]
std::string cs::VideoProperty::GetString |
( |
| ) |
const |
|
inline |
Returns the string property value.
This function is string-specific.
- Returns
- The string property value.
◆ GetString() [2/2]
Returns the string property value as a reference to the given buffer.
This function is string-specific.
- Parameters
-
buf | The backing storage to which to write the property value. |
- Returns
- The string property value as a reference to the given buffer.
◆ IsBoolean()
bool cs::VideoProperty::IsBoolean |
( |
| ) |
const |
|
inline |
Returns true if property is a boolean.
- Returns
- True if property is a boolean.
◆ IsEnum()
bool cs::VideoProperty::IsEnum |
( |
| ) |
const |
|
inline |
Returns true if property is an enum.
- Returns
- True if property is an enum.
◆ IsInteger()
bool cs::VideoProperty::IsInteger |
( |
| ) |
const |
|
inline |
Returns true if property is an integer.
- Returns
- True if property is an integer.
◆ IsString()
bool cs::VideoProperty::IsString |
( |
| ) |
const |
|
inline |
Returns true if property is a string.
- Returns
- True if property is a string.
◆ operator bool()
cs::VideoProperty::operator bool |
( |
| ) |
const |
|
inlineexplicit |
Returns true if property is valid.
- Returns
- True if property is valid.
◆ Set()
void cs::VideoProperty::Set |
( |
int | value | ) |
|
|
inline |
Sets property value.
- Parameters
-
◆ SetString()
void cs::VideoProperty::SetString |
( |
std::string_view | value | ) |
|
|
inline |
Sets the string property value.
This function is string-specific.
- Parameters
-
value | String property value. |
◆ ImageSource
◆ VideoEvent
◆ VideoSink
◆ VideoSource
The documentation for this class was generated from the following file: