WPILibC++ 2025.0.0-alpha-1-14-g3b6f38d
cs::VideoListener Class Reference

An event listener. More...

#include <cscore_oo.h>

Public Member Functions

 VideoListener ()=default
 
 VideoListener (std::function< void(const VideoEvent &event)> callback, int eventMask, bool immediateNotify)
 Create an event listener. More...
 
 VideoListener (const VideoListener &)=delete
 
VideoListeneroperator= (const VideoListener &)=delete
 
 VideoListener (VideoListener &&other) noexcept
 
VideoListeneroperator= (VideoListener &&other) noexcept
 
 ~VideoListener ()
 

Friends

void swap (VideoListener &first, VideoListener &second) noexcept
 

Detailed Description

An event listener.

This calls back to a desigated callback function when an event matching the specified mask is generated by the library.

Constructor & Destructor Documentation

◆ VideoListener() [1/4]

cs::VideoListener::VideoListener ( )
default

◆ VideoListener() [2/4]

cs::VideoListener::VideoListener ( std::function< void(const VideoEvent &event)>  callback,
int  eventMask,
bool  immediateNotify 
)
inline

Create an event listener.

Parameters
callbackCallback function
eventMaskBitmask of VideoEvent::Kind values
immediateNotifyWhether callback should be immediately called with a representative set of events for the current library state.

◆ VideoListener() [3/4]

cs::VideoListener::VideoListener ( const VideoListener )
delete

◆ VideoListener() [4/4]

cs::VideoListener::VideoListener ( VideoListener &&  other)
inlinenoexcept

◆ ~VideoListener()

cs::VideoListener::~VideoListener ( )
inline

Member Function Documentation

◆ operator=() [1/2]

VideoListener & cs::VideoListener::operator= ( const VideoListener )
delete

◆ operator=() [2/2]

VideoListener & cs::VideoListener::operator= ( VideoListener &&  other)
inlinenoexcept

Friends And Related Function Documentation

◆ swap

void swap ( VideoListener first,
VideoListener second 
)
friend

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