wpi::cs::VideoEvent Class Reference

An event generated by the library and provided to event listeners. More...

#include <wpi/cs/VideoEvent.hpp>

Inheritance diagram for wpi::cs::VideoEvent:

Public Member Functions
VideoSource	GetSource () const
	Returns the source associated with the event (if any).
VideoSink	GetSink () const
	Returns the sink associated with the event (if any).
VideoProperty	GetProperty () const
	Returns the property associated with the event (if any).
Public Member Functions inherited from wpi::cs::RawEvent
	RawEvent ()=default
	RawEvent (RawEvent::Kind kind_)
	RawEvent (std::string_view name_, CS_Handle handle_, RawEvent::Kind kind_)
	RawEvent (std::string_view name_, CS_Source source_, const VideoMode &mode_)
	RawEvent (std::string_view name_, CS_Source source_, RawEvent::Kind kind_, CS_Property property_, CS_PropertyKind propertyKind_, int value_, std::string_view valueStr_)

Additional Inherited Members
Public Types inherited from wpi::cs::RawEvent
enum	Kind {   kSourceCreated = CS_SOURCE_CREATED , kSourceDestroyed = CS_SOURCE_DESTROYED , kSourceConnected = CS_SOURCE_CONNECTED , kSourceDisconnected = CS_SOURCE_DISCONNECTED ,   kSourceVideoModesUpdated = CS_SOURCE_VIDEOMODES_UPDATED , kSourceVideoModeChanged = CS_SOURCE_VIDEOMODE_CHANGED , kSourcePropertyCreated = CS_SOURCE_PROPERTY_CREATED , kSourcePropertyValueUpdated = CS_SOURCE_PROPERTY_VALUE_UPDATED ,   kSourcePropertyChoicesUpdated = CS_SOURCE_PROPERTY_CHOICES_UPDATED , kSinkSourceChanged = CS_SINK_SOURCE_CHANGED , kSinkCreated = CS_SINK_CREATED , kSinkDestroyed = CS_SINK_DESTROYED ,   kSinkEnabled = CS_SINK_ENABLED , kSinkDisabled = CS_SINK_DISABLED , kNetworkInterfacesChanged = CS_NETWORK_INTERFACES_CHANGED , kTelemetryUpdated = CS_TELEMETRY_UPDATED ,   kSinkPropertyCreated = CS_SINK_PROPERTY_CREATED , kSinkPropertyValueUpdated = CS_SINK_PROPERTY_VALUE_UPDATED , kSinkPropertyChoicesUpdated = CS_SINK_PROPERTY_CHOICES_UPDATED , kUsbCamerasChanged = CS_USB_CAMERAS_CHANGED }
Public Attributes inherited from wpi::cs::RawEvent
Kind	kind
CS_Source	sourceHandle = CS_INVALID_HANDLE
CS_Sink	sinkHandle = CS_INVALID_HANDLE
std::string	name
VideoMode	mode
CS_Property	propertyHandle
CS_PropertyKind	propertyKind
int	value
std::string	valueStr
CS_Listener	listener {0}

Detailed Description

An event generated by the library and provided to event listeners.

Member Function Documentation

GetProperty()

VideoProperty wpi::cs::VideoEvent::GetProperty ( ) const

inline

Returns the property associated with the event (if any).

Returns

The property associated with the event (if any).

GetSink()

VideoSink wpi::cs::VideoEvent::GetSink ( ) const

inline

Returns the sink associated with the event (if any).

Returns

The sink associated with the event (if any).

GetSource()

VideoSource wpi::cs::VideoEvent::GetSource ( ) const

inline

Returns the source associated with the event (if any).

Returns

The source associated with the event (if any).

---

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

• wpi/cs/VideoEvent.hpp