A selection of options available when creating realtime threads. More...

Public Member Functions
RealtimeOptions	withPriority (int newPriority) const
	A value with a range of 0-10, where 10 is the highest priority.

RealtimeOptions	withProcessingTimeMs (double newProcessingTimeMs) const
	Specify the expected amount of processing time required each time the thread wakes up.

RealtimeOptions	withMaximumProcessingTimeMs (double newMaximumProcessingTimeMs) const
	Specify the maximum amount of processing time required each time the thread wakes up.

RealtimeOptions	withApproximateAudioProcessingTime (int samplesPerFrame, double sampleRate) const
	Specify the maximum amount of processing time required each time the thread wakes up.

RealtimeOptions	withPeriodMs (double newPeriodMs) const
	Specify the approximate amount of time between each thread wake up.

RealtimeOptions	withPeriodHz (double newPeriodHz) const
	Specify the approximate frequency at which the thread will be woken up.

int	getPriority () const
	Returns a value with a range of 0-10, where 10 is the highest priority.

std::optional< double >	getProcessingTimeMs () const
	Returns the expected amount of processing time required each time the thread wakes up.

std::optional< double >	getMaximumProcessingTimeMs () const
	Returns the maximum amount of processing time required each time the thread wakes up.

std::optional< double >	getPeriodMs () const
	Returns the approximate amount of time between each thread wake up, or nullopt if there is no inherent periodicity.

Detailed Description

A selection of options available when creating realtime threads.

See also: startRealtimeThread

Member Function Documentation

◆ withPriority()

RealtimeOptions Thread::RealtimeOptions::withPriority ( int newPriority ) const

nodiscard

A value with a range of 0-10, where 10 is the highest priority.

Currently only used by Posix platforms.

See also: getPriority

References isPositiveAndNotGreaterThan(), jassert, and withMember().

◆ withProcessingTimeMs()

RealtimeOptions Thread::RealtimeOptions::withProcessingTimeMs ( double newProcessingTimeMs ) const

nodiscard

Specify the expected amount of processing time required each time the thread wakes up.

Only used by macOS/iOS.

See also: getProcessingTimeMs, withMaximumProcessingTimeMs, withPeriodMs, withPeriodHz

References jassert, and withMember().

◆ withMaximumProcessingTimeMs()

RealtimeOptions Thread::RealtimeOptions::withMaximumProcessingTimeMs ( double newMaximumProcessingTimeMs ) const

nodiscard

Specify the maximum amount of processing time required each time the thread wakes up.

Only used by macOS/iOS.

See also: getMaximumProcessingTimeMs, withProcessingTimeMs, withPeriodMs, withPeriodHz

References jassert, and withMember().

Referenced by withApproximateAudioProcessingTime().

◆ withApproximateAudioProcessingTime()

RealtimeOptions Thread::RealtimeOptions::withApproximateAudioProcessingTime	(	int	samplesPerFrame,
		double	sampleRate ) const

nodiscard

Specify the maximum amount of processing time required each time the thread wakes up.

This is identical to 'withMaximumProcessingTimeMs' except it calculates the processing time from a sample rate and block size. This is useful if you want to run this thread in parallel to an audio device thread.

Only used by macOS/iOS.