A sample playback handle to be used by the engine. More...

#include <dsp/sample_playback.h>

Data Fields
sample_t **	buf
	A pointer to the original buffer.

channels_t	channels
	The number of channels.

unsigned_frame_t	buf_size
	The number of frames in the buffer.

unsigned_frame_t	offset
	The current offset in the buffer.

float	volume
	The volume to play the sample at (ratio from 0.0 to 2.0, where 1.0 is the normal volume).

nframes_t	start_offset
	Offset relative to the current processing cycle to start playing the sample.

const char *	file
	Source file initialized from.

const char *	func
	Function initialized from.

int	lineno
	Line no initialized from.

Detailed Description

A sample playback handle to be used by the engine.

Definition at line 26 of file sample_playback.h.

Field Documentation

◆ buf

sample_t** SamplePlayback::buf

A pointer to the original buffer.

Definition at line 29 of file sample_playback.h.

◆ buf_size

unsigned_frame_t SamplePlayback::buf_size

The number of frames in the buffer.

Definition at line 35 of file sample_playback.h.

◆ channels

channels_t SamplePlayback::channels

The number of channels.

Definition at line 32 of file sample_playback.h.

◆ file

const char* SamplePlayback::file

Source file initialized from.

Definition at line 49 of file sample_playback.h.

◆ func

const char* SamplePlayback::func

Function initialized from.

Definition at line 52 of file sample_playback.h.

◆ lineno

int SamplePlayback::lineno

Line no initialized from.

Definition at line 55 of file sample_playback.h.

◆ offset

unsigned_frame_t SamplePlayback::offset

The current offset in the buffer.

Definition at line 38 of file sample_playback.h.

◆ start_offset

nframes_t SamplePlayback::start_offset

Offset relative to the current processing cycle to start playing the sample.

Definition at line 46 of file sample_playback.h.

◆ volume

float SamplePlayback::volume

The volume to play the sample at (ratio from 0.0 to 2.0, where 1.0 is the normal volume).

Definition at line 42 of file sample_playback.h.

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

dsp/sample_playback.h

Data Fields