A single job in the queue, obtained from addJob()/addJobs()/getJobs(). More...

#include <tracktion_RenderQueue.h>

Public Types
enum class	State { pending , active , completed , failed , cancelled }

Public Member Functions
State	getState () const

juce::String	getName () const

const Renderer::Parameters &	getParameters () const
	The parameters this job renders with.

float	getProgress () const
	Returns this job's progress, 0 to 1.

juce::File	getFile () const
	Returns the rendered file once the job has completed.

juce::String	getError () const
	Returns the error message if the job failed.

void	cancel ()
	Cancels this job.

void	setThumbnail (std::shared_ptr< juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver >)
	Sets a receiver (e.g.

std::shared_ptr< juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver >	getThumbnail () const
	Returns the receiver set with setThumbnail(), if any.

Detailed Description

A single job in the queue, obtained from addJob()/addJobs()/getJobs().

Holds everything about the job: its parameters, state, progress and result.

Member Enumeration Documentation

◆ State

enum class engine::RenderQueue::Job::State

strong

Enumerator
pending	Not started yet.
active	Currently rendering.
completed	Finished successfully.
failed	Finished with an error, see getError()
cancelled	Cancelled before or during rendering.

Member Function Documentation

◆ getState()

State engine::RenderQueue::Job::getState ( ) const

◆ getName()

juce::String engine::RenderQueue::Job::getName ( ) const

◆ getParameters()

const Renderer::Parameters & engine::RenderQueue::Job::getParameters ( ) const

The parameters this job renders with.

◆ getProgress()

float engine::RenderQueue::Job::getProgress ( ) const

Returns this job's progress, 0 to 1.

◆ getFile()

juce::File engine::RenderQueue::Job::getFile ( ) const

Returns the rendered file once the job has completed.

◆ getError()

juce::String engine::RenderQueue::Job::getError ( ) const

Returns the error message if the job failed.

◆ cancel()

void engine::RenderQueue::Job::cancel ( )

Cancels this job.

Pending jobs are skipped, an active job is stopped.

◆ setThumbnail()

void engine::RenderQueue::Job::setThumbnail ( std::shared_ptr< juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver > )

Sets a receiver (e.g.

a juce::AudioThumbnail) to be filled while this job renders. Only valid while the job is still pending.

◆ getThumbnail()

std::shared_ptr< juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver > engine::RenderQueue::Job::getThumbnail ( ) const

Returns the receiver set with setThumbnail(), if any.

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

tracktion_RenderQueue.h

Public Types

Public Member Functions