mvIMPACT Acquire SDK C++
VideoStreamPauseScope Class Reference

A smaller helper class for pausing a video stream for a defined time. More...

Public Member Functions

 VideoStreamPauseScope (VideoStream &stream, bool boPausedWithinScope=true)
 Creates a new mvIMPACT::acquire::labs::VideoStreamPauseScope object. More...
 
 ~VideoStreamPauseScope ()
 

Detailed Description

A smaller helper class for pausing a video stream for a defined time.

This class uses a RAII pattern to pause an instance of mvIMPACT::acquire::labs::VideoStream

Since
2.41.0

Constructor & Destructor Documentation

◆ VideoStreamPauseScope()

VideoStreamPauseScope ( VideoStream stream,
bool  boPausedWithinScope = true 
)
inlineexplicit

Creates a new mvIMPACT::acquire::labs::VideoStreamPauseScope object.

Trying to pause a stream that is paused already or trying to resume a stream that is not paused will raise an exception! When this object goes out of scope the previous state will be restored automatically.

Parameters
[in]streamThe video stream that shall be configured.
[in]boPausedWithinScopeThe mode the selected video stream shall have while this object is alive.

◆ ~VideoStreamPauseScope()

~VideoStreamPauseScope ( )
inline

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