QtFM::PlayOptions Struct

The PlayOptions struct holds how Engine::play() plays a patch. More…

Header	`#include <QtFM>`
CMake	`target_link_libraries(app PRIVATE Nt::FM)`
Module	Nt FM C++ Classes

List of all members, including inherited members

Public Variables

float	pitch
float	gain
float	pan
float	duration
float	delay
int	priority
quint32	seed
int	bus

Detailed Description

Member Variable Documentation

int QtFM::PlayOptions::bus

The bus of the voice: 0 for effects, 1 for music, 2 for the user interface.

See also QtFM::Engine::setBusGain().

float QtFM::PlayOptions::delay

Seconds from the engine's current render position until the voice starts. The start is sample accurate, for rhythmic effects.

float QtFM::PlayOptions::duration

Seconds until the note is released; -1, the default, takes the patch's duration, or runs a one-shot patch through its envelopes and holds a looping one until VoiceHandle::stop().

float QtFM::PlayOptions::gain

Gain in decibels, added to the patch's gain.

float QtFM::PlayOptions::pan

Pan from -1 (left) to 1 (right), added to the patch's pan.

float QtFM::PlayOptions::pitch

Semitones added to the patch's base note.

int QtFM::PlayOptions::priority

The priority of the voice: a voice of higher priority survives voice stealing.

quint32 QtFM::PlayOptions::seed

The seed of the patch's random variance; 0, the default, takes the next number from the engine's generator. The same seed gives the same sound.