Impact Acquire SDK Python
VideoStreamPauseScope Class Reference

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

Inheritance diagram for VideoStreamPauseScope:
[legend]

Public Member Functions

 __init__ (self, stream, boPausedWithinScope=True)
 Creates a new mvIMPACT.acquire.labs.VideoStreamPauseScope object.
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

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

◆ __init__()

__init__ ( self,
stream,
boPausedWithinScope = True )

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

Property Documentation

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static