VideoStreamPauseScope Class Reference

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

Inheritance diagram for VideoStreamPauseScope:

Public Member Functions
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	VideoStreamPauseScope (VideoStream pStream)
	Creates a new mv.impact.acquire.labs.VideoStreamPauseScope object that will pause the selected video stream.
	VideoStreamPauseScope (VideoStream stream, bool pausedWithinScope)
	Creates a new mv.impact.acquire.labs.VideoStreamPauseScope object.

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 mv.impact.acquire.labs.VideoStream

Since

2.41.0

Constructor & Destructor Documentation

VideoStreamPauseScope() [1/2]

VideoStreamPauseScope ( VideoStream stream, bool pausedWithinScope )

inline

Creates a new mv.impact.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]	stream	The video stream that shall be configured.
[in]	pausedWithinScope	The mode the selected video stream shall have while this object is alive.

VideoStreamPauseScope() [2/2]

VideoStreamPauseScope ( VideoStream pStream )

inline

Creates a new mv.impact.acquire.labs.VideoStreamPauseScope object that will pause the selected video stream.

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

Parameters

[in]

pStream

The video stream that shall be configured.

Member Function Documentation

Dispose()

void Dispose ( )

inline

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

See the frameworks documentation about the System.IDisposable interface for more information.