WPILibC++ 2025.2.1
|
A sink for user code to accept video frames as raw bytes. More...
#include <cscore_raw.h>
Public Member Functions | |
RawSink ()=default | |
RawSink (std::string_view name) | |
Create a sink for accepting raw images. | |
RawSink (std::string_view name, std::function< void(uint64_t time)> processFrame) | |
Create a sink for accepting raws images in a separate thread. | |
Public Member Functions inherited from cs::ImageSink | |
void | SetDescription (std::string_view description) |
Set sink description. | |
std::string | GetError () const |
Get error string. | |
void | SetEnabled (bool enabled) |
Enable or disable getting new frames. | |
Public Member Functions inherited from cs::VideoSink | |
VideoSink () noexcept=default | |
VideoSink (const VideoSink &sink) | |
VideoSink (VideoSink &&other) noexcept | |
VideoSink & | operator= (VideoSink other) noexcept |
~VideoSink () | |
operator bool () const | |
Returns true if the VideoSink is valid. | |
int | GetHandle () const |
Returns the VideoSink handle. | |
bool | operator== (const VideoSink &other) const |
Kind | GetKind () const |
Get the kind of the sink. | |
std::string | GetName () const |
Get the name of the sink. | |
std::string | GetDescription () const |
Get the sink description. | |
VideoProperty | GetProperty (std::string_view name) |
Get a property of the sink. | |
std::vector< VideoProperty > | EnumerateProperties () const |
Enumerate all properties of this sink. | |
bool | SetConfigJson (std::string_view config) |
Set properties from a JSON configuration string. | |
bool | SetConfigJson (const wpi::json &config) |
Set properties from a JSON configuration object. | |
std::string | GetConfigJson () const |
Get a JSON configuration string. | |
wpi::json | GetConfigJsonObject () const |
Get a JSON configuration object. | |
void | SetSource (VideoSource source) |
Configure which source should provide frames to this sink. | |
VideoSource | GetSource () const |
Get the connected source. | |
VideoProperty | GetSourceProperty (std::string_view name) |
Get a property of the associated source. | |
CS_Status | GetLastStatus () const |
Protected Member Functions | |
uint64_t | GrabFrame (wpi::RawFrame &image, double timeout=0.225) const |
Wait for the next frame and get the image. | |
uint64_t | GrabFrameNoTimeout (wpi::RawFrame &image) const |
Wait for the next frame and get the image. | |
uint64_t | GrabFrameLastTime (wpi::RawFrame &image, uint64_t lastFrameTime, double timeout=0.225) const |
Wait for the next frame and get the image. | |
Protected Member Functions inherited from cs::ImageSink | |
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 , kRaw = CS_SINK_RAW } |
Static Public Member Functions inherited from cs::VideoSink | |
static std::vector< VideoSink > | EnumerateSinks () |
Enumerate all existing sinks. | |
Protected Attributes inherited from cs::VideoSink | |
CS_Status | m_status = 0 |
CS_Sink | m_handle {0} |
A sink for user code to accept video frames as raw bytes.
This is a complex API, most cases should use CvSource.
|
default |