cs::VideoCamera Class Reference

A source that represents a video camera. More...

#include <cscore_oo.h>

Inheritance diagram for cs::VideoCamera:

Public Types
enum	WhiteBalance {   kFixedIndoor = 3000 , kFixedOutdoor1 = 4000 , kFixedOutdoor2 = 5000 , kFixedFluorescent1 = 5100 ,   kFixedFlourescent2 = 5200 }
	White balance. More...
Public Types inherited from cs::VideoSource
enum	Kind { kUnknown = CS_SOURCE_UNKNOWN , kUsb = CS_SOURCE_USB , kHttp = CS_SOURCE_HTTP , kCv = CS_SOURCE_CV }
	Video source kind. More...
enum	ConnectionStrategy { kConnectionAutoManage = CS_CONNECTION_AUTO_MANAGE , kConnectionKeepOpen = CS_CONNECTION_KEEP_OPEN , kConnectionForceClose = CS_CONNECTION_FORCE_CLOSE }
	Connection strategy. More...

Public Member Functions
	VideoCamera ()=default
void	SetBrightness (int brightness)
	Set the brightness, as a percentage (0-100). More...
int	GetBrightness ()
	Get the brightness, as a percentage (0-100). More...
void	SetWhiteBalanceAuto ()
	Set the white balance to auto. More...
void	SetWhiteBalanceHoldCurrent ()
	Set the white balance to hold current. More...
void	SetWhiteBalanceManual (int value)
	Set the white balance to manual, with specified color temperature. More...
void	SetExposureAuto ()
	Set the exposure to auto aperature. More...
void	SetExposureHoldCurrent ()
	Set the exposure to hold current. More...
void	SetExposureManual (int value)
	Set the exposure to manual, as a percentage (0-100). More...
Public Member Functions inherited from cs::VideoSource
	VideoSource () noexcept=default
	VideoSource (const VideoSource &source)
	VideoSource (VideoSource &&other) noexcept
VideoSource &	operator= (VideoSource other) noexcept
	~VideoSource ()
	operator bool () const
int	GetHandle () const
bool	operator== (const VideoSource &other) const
Kind	GetKind () const
	Get the kind of the source. More...
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? More...
bool	IsEnabled () const
	Gets source enable status. More...
VideoProperty	GetProperty (std::string_view name)
	Get a property. More...
std::vector< VideoProperty >	EnumerateProperties () const
	Enumerate all properties of this source. More...
VideoMode	GetVideoMode () const
	Get the current video mode. More...
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 (std::string_view 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< VideoMode >	EnumerateVideoModes () const
	Enumerate all known video modes for this source. More...
CS_Status	GetLastStatus () const
std::vector< VideoSink >	EnumerateSinks ()
	Enumerate all sinks connected to this source. More...

Protected Member Functions
	VideoCamera (CS_Source handle)
Protected Member Functions inherited from cs::VideoSource
	VideoSource (CS_Source handle)

Additional Inherited Members
Static Public Member Functions inherited from cs::VideoSource
static std::vector< VideoSource >	EnumerateSources ()
	Enumerate all existing sources. More...
Protected Attributes inherited from cs::VideoSource
CS_Status	m_status = 0
CS_Source	m_handle {0}
	Video source handle. More...

Detailed Description

A source that represents a video camera.

Member Enumeration Documentation

WhiteBalance

enum cs::VideoCamera::WhiteBalance

White balance.

Enumerator
kFixedIndoor	Fixed indoor white balance.
kFixedOutdoor1	Fixed outdoor white balance 1.
kFixedOutdoor2	Fixed outdoor white balance 2.
kFixedFluorescent1	Fixed fluorescent white balance 1.
kFixedFlourescent2	Fixed fluorescent white balance 2.

Constructor & Destructor Documentation

VideoCamera() [1/2]

cs::VideoCamera::VideoCamera ( )

default

VideoCamera() [2/2]

cs::VideoCamera::VideoCamera ( CS_Source  handle )

inlineexplicitprotected

Member Function Documentation

GetBrightness()

int cs::VideoCamera::GetBrightness ( )

inline

Get the brightness, as a percentage (0-100).

SetBrightness()

void cs::VideoCamera::SetBrightness ( int  brightness )

inline

Set the brightness, as a percentage (0-100).

SetExposureAuto()

void cs::VideoCamera::SetExposureAuto ( )

inline

Set the exposure to auto aperature.

SetExposureHoldCurrent()

void cs::VideoCamera::SetExposureHoldCurrent ( )

inline

Set the exposure to hold current.

SetExposureManual()

void cs::VideoCamera::SetExposureManual ( int  value )

inline

Set the exposure to manual, as a percentage (0-100).

SetWhiteBalanceAuto()

void cs::VideoCamera::SetWhiteBalanceAuto ( )

inline

Set the white balance to auto.

SetWhiteBalanceHoldCurrent()

void cs::VideoCamera::SetWhiteBalanceHoldCurrent ( )

inline

Set the white balance to hold current.

SetWhiteBalanceManual()

void cs::VideoCamera::SetWhiteBalanceManual ( int  value )

inline

Set the white balance to manual, with specified color temperature.

---

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

• cscore_oo.h
• cscore_oo.inc