VideoProperty

class cscore.VideoProperty

Bases: pybind11_object

A source or sink property.

class Kind(value: SupportsInt | SupportsIndex)

Bases: pybind11_object

Members:

NONE : No specific property.

BOOLEAN : Boolean property.

INTEGER : Integer property.

STRING : String property.

ENUM : Enum property.

BOOLEAN = <Kind.BOOLEAN: 1>

ENUM = <Kind.ENUM: 8>

INTEGER = <Kind.INTEGER: 2>

NONE = <Kind.NONE: 0>

STRING = <Kind.STRING: 4>

VideoProperty.Kind.name -> str

property value

get() → int

Returns property value.

Returns:: Property value.

get_choices() → 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.

get_default() → int

Returns property default value.

Returns:: Property default value.

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

Returns property kind.

Returns:: Property kind.

get_last_status() → int

Returns the last status.

Returns:: The last status.

get_max() → int

Returns property maximum value.

Returns:: Property maximum value.

get_min() → int

Returns property minimum value.

Returns:: Property minimum value.

get_name() → str

Returns property name.

Returns:: Property name.

get_step() → int

Returns property step size.

Returns:: Property step size.

get_string(*args, **kwargs)

Overloaded function.

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

Returns the string property value.

This function is string-specific.

Returns:: The string property value.

get_string(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.

is_boolean() → bool

Returns true if property is a boolean.

Returns:: True if property is a boolean.

is_enum() → bool

Returns true if property is an enum.

Returns:: True if property is an enum.

is_integer() → bool

Returns true if property is an integer.

Returns:: True if property is an integer.

is_string() → bool

Returns true if property is a string.

Returns:: True if property is a string.

set(value: SupportsInt | SupportsIndex) → None

Sets property value.

Parameters:: value – Property value.

set_string(value: str) → None

Sets the string property value.

This function is string-specific.

Parameters:: value – String property value.