MacroPlayer

Asynchronous macro playback engine.

Example:

from qgis_macros.macro_player import MacroPlayer

player = MacroPlayer(playback_speed=1.5)
player.playback_ended.connect(on_playback_finished)
player.play(macro)

class qgis_macros.macro_player.MacroPlaybackStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

Status of a completed macro playback.

SUCCESS = 1

FAILURE = 2

STOPPED = 3

class qgis_macros.macro_player.MacroPlaybackReport(status=MacroPlaybackStatus.SUCCESS, error=None)[source]

Bases: object

Report emitted when macro playback completes.

Parameters:

status (MacroPlaybackStatus)
error (Exception | None)

status: MacroPlaybackStatus = 1

error: Exception | None = None

class qgis_macros.macro_player.MacroPlayer(playback_speed=1.0)[source]

Bases: _QObjectStub

Represents an object used for macro playback with adjustable speed.

Used to execute a sequence of predefined events at a specified playback speed.

Parameters:: playback_speed (float)

playback_ended = <_qgis_stubs._StubSignal object>

set_speed(speed)[source]

Set the playback speed.

Parameters:: speed (float)
Return type:: None

play(macro)[source]

Play back the recorded events asynchronously.

Parameters:: macro (Macro)
Return type:: None