Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorAudio::IAudioSpectrumProvider Class Referenceabstract

#include <PhosphorAudio/IAudioSpectrumProvider.h>

Inheritance diagram for PhosphorAudio::IAudioSpectrumProvider:
[legend]

Signals

void spectrumUpdated (const QVector< float > &spectrum)
void runningChanged (bool running)
void errorOccurred (const QString &message)

Public Member Functions

 IAudioSpectrumProvider (QObject *parent=nullptr)
 ~IAudioSpectrumProvider () override=default
virtual bool isAvailable () const =0
virtual void start ()=0
virtual void stop ()=0
virtual bool isRunning () const =0
virtual SpectrumOptions options () const =0
 The provider's current (normalized) parameter set.
virtual void setOptions (const SpectrumOptions &options)=0
 Apply a full parameter set.
virtual QVector< float > spectrum () const =0

Constructor & Destructor Documentation

◆ IAudioSpectrumProvider()

PhosphorAudio::IAudioSpectrumProvider::IAudioSpectrumProvider ( QObject * parent = nullptr)
inlineexplicit

◆ ~IAudioSpectrumProvider()

PhosphorAudio::IAudioSpectrumProvider::~IAudioSpectrumProvider ( )
overridedefault

Member Function Documentation

◆ errorOccurred

void PhosphorAudio::IAudioSpectrumProvider::errorOccurred ( const QString & message)
signal

◆ isAvailable()

virtual bool PhosphorAudio::IAudioSpectrumProvider::isAvailable ( ) const
pure virtual

◆ isRunning()

virtual bool PhosphorAudio::IAudioSpectrumProvider::isRunning ( ) const
pure virtual

◆ options()

virtual SpectrumOptions PhosphorAudio::IAudioSpectrumProvider::options ( ) const
pure virtual

The provider's current (normalized) parameter set.

Implemented in PhosphorAudio::CavaSpectrumProvider.

◆ runningChanged

void PhosphorAudio::IAudioSpectrumProvider::runningChanged ( bool running)
signal

◆ setOptions()

virtual void PhosphorAudio::IAudioSpectrumProvider::setOptions ( const SpectrumOptions & options)
pure virtual

Apply a full parameter set.

Implementations normalize the values, no-op when nothing changed, and restart capture at most once for however many fields differ.

Implemented in PhosphorAudio::CavaSpectrumProvider.

◆ spectrum()

virtual QVector< float > PhosphorAudio::IAudioSpectrumProvider::spectrum ( ) const
pure virtual

◆ spectrumUpdated

void PhosphorAudio::IAudioSpectrumProvider::spectrumUpdated ( const QVector< float > & spectrum)
signal

◆ start()

virtual void PhosphorAudio::IAudioSpectrumProvider::start ( )
pure virtual

◆ stop()

virtual void PhosphorAudio::IAudioSpectrumProvider::stop ( )
pure virtual

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