C/C++ SDK / C++ layer · Jobs / kroys::AutomationJob

kroys::AutomationJob

An automation step's context.

Kindclass

Headerkroys/plugin.hpp

Members4

DECLARATION

Declaration

Declared in kroys/plugin.hpp.

plugin.hpp

class AutomationJob

REFERENCE

Members

Constructors

#explicit AutomationJob(const KroysAutomationJob* job);

Wraps the host's job.

constructor

Methods

#[[nodiscard]] std::string OutputFolder() const;

Folder the capture writes into.

method

#void Hold(uint32_t frames) const;

Keeps the runner waiting frames frames after the step.

methodwraps KroysAutomationJob::Hold

#Result Fail(const std::string& message) const;

Thread-safe: fails the task with a message (Run then returns an error).

methodwraps KroysTaskJob::Fail

Signatures

explicit AutomationJob(const KroysAutomationJob* job);
[[nodiscard]] std::string OutputFolder() const;
void Hold(uint32_t frames) const;
Result Fail(const std::string& message) const;

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.