VideoProperty

class cscore.VideoProperty

Bases: pybind11_object

A source or sink property.

class Kind(value: int)

Bases: pybind11_object

Members:

kNone : No specific property.

kBoolean : Boolean property.

kInteger : Integer property.

kString : String property.

kEnum : Enum property.

kBoolean = <Kind.kBoolean: 1>

kEnum = <Kind.kEnum: 8>

kInteger = <Kind.kInteger: 2>

kNone = <Kind.kNone: 0>

kString = <Kind.kString: 4>

property name

property value

get() → int

Returns property value.

Returns:: Property value.

getChoices() → list[str]

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

Returns property default value.

Returns:: Property default value.

getKind() → cscore._cscore.VideoProperty.Kind

Returns property kind.

Returns:: Property kind.

getLastStatus() → int

Returns the last status.

Returns:: The last status.

getMax() → int

Returns property maximum value.

Returns:: Property maximum value.

getMin() → int

Returns property minimum value.

Returns:: Property minimum value.

getName() → str

Returns property name.

Returns:: Property name.

getStep() → int

Returns property step size.

Returns:: Property step size.

getString(*args, **kwargs)

Overloaded function.

getString(self: cscore._cscore.VideoProperty) -> str

Returns the string property value.

This function is string-specific.

Returns:: The string property value.

getString(self: cscore._cscore.VideoProperty, buf: List[str]) -> str

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

Returns true if property is a boolean.

Returns:: True if property is a boolean.

isEnum() → bool

Returns true if property is an enum.

Returns:: True if property is an enum.

isInteger() → bool

Returns true if property is an integer.

Returns:: True if property is an integer.

isString() → bool

Returns true if property is a string.

Returns:: True if property is a string.

set(value: int) → None

Sets property value.

Parameters:: value – Property value.

setString(value: str) → None

Sets the string property value.

This function is string-specific.

Parameters:: value – String property value.