WPILibC++  2020.3.2-60-g3011ebe
cs::ImageSource Class Reference

A base class for single image providing sources. More...

#include <cscore_oo.h>

Inheritance diagram for cs::ImageSource:
cs::VideoSource

Public Member Functions

void NotifyError (const wpi::Twine &msg)
 Signal sinks that an error has occurred. More...
 
void SetConnected (bool connected)
 Set source connection status. More...
 
void SetDescription (const wpi::Twine &description)
 Set source description. More...
 
VideoProperty CreateProperty (const wpi::Twine &name, VideoProperty::Kind kind, int minimum, int maximum, int step, int defaultValue, int value)
 Create a property. More...
 
VideoProperty CreateIntegerProperty (const wpi::Twine &name, int minimum, int maximum, int step, int defaultValue, int value)
 Create an integer property. More...
 
VideoProperty CreateBooleanProperty (const wpi::Twine &name, bool defaultValue, bool value)
 Create a boolean property. More...
 
VideoProperty CreateStringProperty (const wpi::Twine &name, const wpi::Twine &value)
 Create a string property. More...
 
void SetEnumPropertyChoices (const VideoProperty &property, wpi::ArrayRef< std::string > choices)
 Configure enum property choices. More...
 
template<typename T >
void SetEnumPropertyChoices (const VideoProperty &property, std::initializer_list< T > choices)
 Configure enum property choices. More...
 
- Public Member Functions inherited from cs::VideoSource
 VideoSource (const VideoSource &source)
 
 VideoSource (VideoSource &&other) noexcept
 
VideoSourceoperator= (VideoSource other) noexcept
 
 operator bool () const
 
int GetHandle () const
 
bool operator== (const VideoSource &other) const
 
bool operator!= (const VideoSource &other) const
 
Kind GetKind () const
 Get the kind of the source.
 
std::string GetName () const
 Get the name of the source. More...
 
std::string GetDescription () const
 Get the source description. More...
 
uint64_t GetLastFrameTime () const
 Get the last time a frame was captured. More...
 
void SetConnectionStrategy (ConnectionStrategy strategy)
 Sets the connection strategy. More...
 
bool IsConnected () const
 Is the source currently connected to whatever is providing the images?
 
bool IsEnabled () const
 Gets source enable status. More...
 
VideoProperty GetProperty (const wpi::Twine &name)
 Get a property. More...
 
std::vector< VideoPropertyEnumerateProperties () const
 Enumerate all properties of this source.
 
VideoMode GetVideoMode () const
 Get the current video mode.
 
bool SetVideoMode (const VideoMode &mode)
 Set the video mode. More...
 
bool SetVideoMode (VideoMode::PixelFormat pixelFormat, int width, int height, int fps)
 Set the video mode. More...
 
bool SetPixelFormat (VideoMode::PixelFormat pixelFormat)
 Set the pixel format. More...
 
bool SetResolution (int width, int height)
 Set the resolution. More...
 
bool SetFPS (int fps)
 Set the frames per second (FPS). More...
 
bool SetConfigJson (wpi::StringRef config)
 Set video mode and properties from a JSON configuration string. More...
 
bool SetConfigJson (const wpi::json &config)
 Set video mode and 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...
 
double GetActualFPS () const
 Get the actual FPS. More...
 
double GetActualDataRate () const
 Get the data rate (in bytes per second). More...
 
std::vector< VideoModeEnumerateVideoModes () const
 Enumerate all known video modes for this source.
 
CS_Status GetLastStatus () const
 
std::vector< VideoSinkEnumerateSinks ()
 Enumerate all sinks connected to this source. More...
 

Additional Inherited Members

- Public Types inherited from cs::VideoSource
enum  Kind { kUnknown = CS_SOURCE_UNKNOWN, kUsb = CS_SOURCE_USB, kHttp = CS_SOURCE_HTTP, kCv = CS_SOURCE_CV }
 
enum  ConnectionStrategy { kConnectionAutoManage = CS_CONNECTION_AUTO_MANAGE, kConnectionKeepOpen = CS_CONNECTION_KEEP_OPEN, kConnectionForceClose = CS_CONNECTION_FORCE_CLOSE }
 Connection strategy. More...
 
- Static Public Member Functions inherited from cs::VideoSource
static std::vector< VideoSourceEnumerateSources ()
 Enumerate all existing sources. More...
 
- Protected Member Functions inherited from cs::VideoSource
 VideoSource (CS_Source handle)
 
- Protected Attributes inherited from cs::VideoSource
CS_Status m_status = 0
 
CS_Source m_handle
 

Detailed Description

A base class for single image providing sources.

Member Function Documentation

◆ CreateBooleanProperty()

VideoProperty cs::ImageSource::CreateBooleanProperty ( const wpi::Twine name,
bool  defaultValue,
bool  value 
)
inline

Create a boolean property.

Parameters
nameProperty name
defaultValueDefault value
valueCurrent value
Returns
Property

◆ CreateIntegerProperty()

VideoProperty cs::ImageSource::CreateIntegerProperty ( const wpi::Twine name,
int  minimum,
int  maximum,
int  step,
int  defaultValue,
int  value 
)
inline

Create an integer property.

Parameters
nameProperty name
minimumMinimum value
maximumMaximum value
stepStep value
defaultValueDefault value
valueCurrent value
Returns
Property

◆ CreateProperty()

VideoProperty cs::ImageSource::CreateProperty ( const wpi::Twine name,
VideoProperty::Kind  kind,
int  minimum,
int  maximum,
int  step,
int  defaultValue,
int  value 
)
inline

Create a property.

Parameters
nameProperty name
kindProperty kind
minimumMinimum value
maximumMaximum value
stepStep value
defaultValueDefault value
valueCurrent value
Returns
Property

◆ CreateStringProperty()

VideoProperty cs::ImageSource::CreateStringProperty ( const wpi::Twine name,
const wpi::Twine value 
)
inline

Create a string property.

Parameters
nameProperty name
defaultValueDefault value
valueCurrent value
Returns
Property

◆ NotifyError()

void cs::ImageSource::NotifyError ( const wpi::Twine msg)
inline

Signal sinks that an error has occurred.

This should be called instead of NotifyFrame when an error occurs.

◆ SetConnected()

void cs::ImageSource::SetConnected ( bool  connected)
inline

Set source connection status.

Defaults to true.

Parameters
connectedTrue for connected, false for disconnected

◆ SetDescription()

void cs::ImageSource::SetDescription ( const wpi::Twine description)
inline

Set source description.

Parameters
descriptionDescription

◆ SetEnumPropertyChoices() [1/2]

template<typename T >
void cs::ImageSource::SetEnumPropertyChoices ( const VideoProperty property,
std::initializer_list< T >  choices 
)
inline

Configure enum property choices.

Parameters
propertyProperty
choicesChoices

◆ SetEnumPropertyChoices() [2/2]

void cs::ImageSource::SetEnumPropertyChoices ( const VideoProperty property,
wpi::ArrayRef< std::string >  choices 
)
inline

Configure enum property choices.

Parameters
propertyProperty
choicesChoices

The documentation for this class was generated from the following files: