Playback configuration. More...

#include <abstract_playback.h>

Public Member Functions
	Mode (dtime sampleRate, AudioSampleFormat format, int numChannels, dtime bufferLength, int numBuffers)
	Sets playback configuration. More...

	Mode (dtime sampleRate, AudioSampleFormat format, int numChannels, dtime bufferLength)

	Mode ()

dtime	getLatency () const

Public Attributes
dtime	sampleRate
	samples per second / sample rate in Hz More...

AudioSampleFormat	sampleFormat
	format of each sample More...

unsigned char	numChannels
	number of channels More...

dtime	bufferLength
	length of each atomic buffer in samples More...

unsigned char	numBuffers
	number of atomic buffers More...

Detailed Description

Playback configuration.

Definition at line 39 of file abstract_playback.h.

Constructor & Destructor Documentation

◆ Mode() [1/3]

AbstractPlayback::Mode::Mode	(	dtime	sampleRate,
		AudioSampleFormat	format,
		int	numChannels,
		dtime	bufferLength,
		int	numBuffers
	)

Sets playback configuration.

Parameters

sampleRate	sampling frequency in Hz
format	sample format
numChannels	number of channels (e.g., 1 for mono, 2 for stereo)
bufferLength	length of a single buffer
numBuffers	number of buffers

Definition at line 36 of file abstract_playback.cpp.

                                                                 :
     sampleRate(sampleRate),
     sampleFormat(format),
     numChannels((unsigned char) numChannels),
     bufferLength(bufferLength),
     numBuffers((unsigned char) numBuffers)
 {
     // check that all the mode parameters are in their valid ranges
     if (numBuffers < 2)
         Insanity::insanity("Bad playback mode: less that 2 buffers");
     if (numChannels < 1)
         Insanity::insanity("Bad playback mode: no channels");
     if (bufferLength < 1)
         Insanity::insanity("Bad playback mode: non-positive buffer length");
     switch (format) {
         case Int8:
         case Int16:
         case Int32:
         case Float32:
             break;
         default:
             Insanity::insanity("Bad playback mode: invalid sample format");
     }
         // we accept zero/negative sample rate which signifies "not set"
 }

◆ Mode() [2/3]

AbstractPlayback::Mode::Mode	(	dtime	sampleRate,
		AudioSampleFormat	format,
		int	numChannels,
		dtime	bufferLength
	)

Definition at line 63 of file abstract_playback.cpp.

                                                 :
     Mode(sampleRate, format, numChannels, bufferLength, 2)
 {}

◆ Mode() [3/3]

AbstractPlayback::Mode::Mode ( )

Definition at line 68 of file abstract_playback.cpp.

68 : Mode(0, AudioSampleFormat::Int16, 1, 1024, 2) {}

Member Function Documentation

◆ getLatency()

dtime Beatmup::Audio::AbstractPlayback::Mode::getLatency ( ) const

inline

Returns: mode latency in samples.

Definition at line 61 of file abstract_playback.h.

61 { return bufferLength * numBuffers; }

Member Data Documentation

◆ sampleRate

dtime Beatmup::Audio::AbstractPlayback::Mode::sampleRate

samples per second / sample rate in Hz

Definition at line 40 of file abstract_playback.h.

◆ sampleFormat

AudioSampleFormat Beatmup::Audio::AbstractPlayback::Mode::sampleFormat

format of each sample

Definition at line 41 of file abstract_playback.h.

◆ numChannels

unsigned char Beatmup::Audio::AbstractPlayback::Mode::numChannels

number of channels

Definition at line 42 of file abstract_playback.h.

◆ bufferLength

dtime Beatmup::Audio::AbstractPlayback::Mode::bufferLength

length of each atomic buffer in samples

Definition at line 43 of file abstract_playback.h.

◆ numBuffers

unsigned char Beatmup::Audio::AbstractPlayback::Mode::numBuffers

number of atomic buffers

Definition at line 44 of file abstract_playback.h.

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

core/audio/playback/abstract_playback.h
core/audio/playback/abstract_playback.cpp

Public Member Functions

Public Attributes