QtCraft API C++ classes QML types Handbook

QcAudioMixer::Voice Struct

struct QcAudioMixer::Voice

One playing sound. More...

Public Variables

float appliedGain
float appliedPan
std::shared_ptr<const QcSampleBuffer> buffer
QcSoundBus bus
int fadeFrames
float gain
QcAudioMixer::VoiceId id
bool loop
float pan
double pitch
double position

Detailed Description

Member Variable Documentation

float Voice::appliedGain

Gain actually reached; moves to gain over one mix() call so changes do not click.

float Voice::appliedPan

Stereo position actually reached; moves to pan over one mix() call like the gain.

std::shared_ptr<const QcSampleBuffer> Voice::buffer

The samples it plays.

QcSoundBus Voice::bus

Bus whose volume applies.

int Voice::fadeFrames

Frames left until a voice stopped with fadeOut() is silent and removed; -1 while it plays on.

float Voice::gain

Gain asked for (at least 0).

QcAudioMixer::VoiceId Voice::id

Id play() returned for it.

bool Voice::loop

Starts over at the end instead of ending.

float Voice::pan

Stereo position asked for: -1 left, 0 centre, 1 right.

double Voice::pitch

Playback speed; 1 is the buffer's own.

double Voice::position

Read position in source samples; advances by pitch scaled to the output rate.