 |
WPILibC++ 2024.3.2
|
|
WPILibC++ 2024.3.2
|
A base class for single image reading sinks. More...
#include <cscore_oo.h>
Public Member Functions | |
| void | SetDescription (std::string_view description) |
| Set sink description. More... | |
| std::string | GetError () const |
| Get error string. More... | |
| void | SetEnabled (bool enabled) |
| Enable or disable getting new frames. More... | |
 Public Member Functions inherited from cs::VideoSink | |
| VideoSink () noexcept=default | |
| VideoSink (const VideoSink &sink) | |
| VideoSink (VideoSink &&sink) noexcept | |
| VideoSink & | operator= (VideoSink other) noexcept |
| ~VideoSink () | |
| operator bool () const | |
| Returns true if the VideoSink is valid. More... | |
| int | GetHandle () const |
| Returns the VideoSink handle. More... | |
| bool | operator== (const VideoSink &other) const |
| Kind | GetKind () const |
| Get the kind of the sink. More... | |
| std::string | GetName () const |
| Get the name of the sink. More... | |
| std::string | GetDescription () const |
| Get the sink description. More... | |
| VideoProperty | GetProperty (std::string_view name) |
| Get a property of the sink. More... | |
| std::vector< VideoProperty > | EnumerateProperties () const |
| Enumerate all properties of this sink. More... | |
| bool | SetConfigJson (std::string_view config) |
| Set properties from a JSON configuration string. More... | |
| bool | SetConfigJson (const wpi::json &config) |
| Set properties from a JSON configuration object. More... | |
| std::string | GetConfigJson () const |
| Get a JSON configuration string. More... | |
| wpi::json | GetConfigJsonObject () const |
| Get a JSON configuration object. More... | |
| void | SetSource (VideoSource source) |
| Configure which source should provide frames to this sink. More... | |
| VideoSource | GetSource () const |
| Get the connected source. More... | |
| VideoProperty | GetSourceProperty (std::string_view name) |
| Get a property of the associated source. More... | |
| CS_Status | GetLastStatus () const |
Protected Member Functions | |
| ImageSink ()=default | |
| Protected Member Functions inherited from cs::VideoSink | |
| VideoSink (CS_Sink handle) | |
Additional Inherited Members | |
| Public Types inherited from cs::VideoSink | |
| enum | Kind { kUnknown = CS_SINK_UNKNOWN , kMjpeg = CS_SINK_MJPEG , kCv = CS_SINK_CV } |
| Static Public Member Functions inherited from cs::VideoSink | |
| static std::vector< VideoSink > | EnumerateSinks () |
| Enumerate all existing sinks. More... | |
| Protected Attributes inherited from cs::VideoSink | |
| CS_Status | m_status = 0 |
| CS_Sink | m_handle {0} |
A base class for single image reading sinks.
|
protecteddefault |
|
inline |
Get error string.
Call this if WaitForFrame() returns 0 to determine what the error is.
|
inline |
Set sink description.
| description | Description |
|
inline |
Enable or disable getting new frames.
Disabling will cause processFrame (for callback-based CvSinks) to not be called and WaitForFrame() to not return. This can be used to save processor resources when frames are not needed.
1.9.4