ImageSource

class cscore.ImageSource

Bases: VideoSource

A base class for single image providing sources.

createBooleanProperty(name: str, defaultValue: bool, value: bool) → cscore._cscore.VideoProperty

Create a boolean property.

Parameters:

• name – Property name

• defaultValue – Default value

• value – Current value

Returns:

Property

createIntegerProperty(name: str, minimum: int, maximum: int, step: int, defaultValue: int, value: int) → cscore._cscore.VideoProperty

Create an integer property.

Parameters:

• name – Property name

• minimum – Minimum value

• maximum – Maximum value

• step – Step value

• defaultValue – Default value

• value – Current value

Returns:

Property

createProperty(name: str, kind: cscore._cscore.VideoProperty.Kind, minimum: int, maximum: int, step: int, defaultValue: int, value: int) → cscore._cscore.VideoProperty

Create a property.

Parameters:

• name – Property name

• kind – Property kind

• minimum – Minimum value

• maximum – Maximum value

• step – Step value

• defaultValue – Default value

• value – Current value

Returns:

Property

createStringProperty(name: str, value: str) → cscore._cscore.VideoProperty

Create a string property.

Parameters:

• name – Property name

• value – Current value

Returns:

Property

notifyError(msg: str) → None

Signal sinks that an error has occurred. This should be called instead of NotifyFrame when an error occurs.

Parameters:

msg – Notification message.

setConnected(connected: bool) → None

Set source connection status. Defaults to true.

Parameters:

connected – True for connected, false for disconnected

setDescription(description: str) → None

Set source description.

Parameters:

description – Description

setEnumPropertyChoices(property: cscore._cscore.VideoProperty, choices: List[str]) → None

Configure enum property choices.

Parameters:

• property – Property

• choices – Choices