Phonon::VolumeFaderEffect

Search for usage in LXR

Phonon::VolumeFaderEffect Class Reference

#include <phonon/VolumeFaderEffect>

Inheritance diagram for Phonon::VolumeFaderEffect:

Public Types

enum  FadeCurve { Fade3Decibel , Fade6Decibel , Fade9Decibel , Fade12Decibel }
 

Properties

FadeCurve fadeCurve
 
float volume
 
double volumeDecibel
 
- Properties inherited from QObject
 objectName
 

Public Slots

void fadeIn (int fadeTime)
 
void fadeOut (int fadeTime)
 
void fadeTo (float volume, int fadeTime)
 
void setFadeCurve (FadeCurve curve)
 
void setVolume (float volume)
 
void setVolumeDecibel (double volumeDecibel)
 

Public Member Functions

FadeCurve fadeCurve () const
 
float volume () const
 
double volumeDecibel () const
 
- Public Member Functions inherited from Phonon::Effect
 Effect (const EffectDescription &description, QObject *parent=nullptr)
 
EffectDescription description () const
 
QList< EffectParameterparameters () const
 
QVariant parameterValue (const EffectParameter &) const
 
void setParameterValue (const EffectParameter &, const QVariant &value)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from Phonon::Effect
 Effect (EffectPrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Audio effect to gradually fade the audio volume.

This effect differs from gradually changing the output volume in that a dedicated effect can change the volume in the smallest possible steps while every other volume control will make more or less noticeable steps.

Author
Matthias Kretz kretz.nosp@m.@kde.nosp@m..org
See also
AudioOutput::volume

Definition at line 48 of file volumefadereffect.h.

Member Enumeration Documentation

◆ FadeCurve

Determines the curve of the volume change.

Enumerator
Fade3Decibel 

"Crossfade curve" / "fast" fade out

Often the best fade for a crossfade, as after half of the time the volume reached -3dB. This means that half the possible power (which is proportional to the square of the voltage) is reached. Summed, the maximum power of two audio signals fading with a -3dB curve will always be equal.

For fading in or out the -3dB curve is too abrupt in the end.

This is the default fade curve.

Fade6Decibel 

"Linear" fade out

With a -6dB fade curve after half of the fading time -6dB has been reached. -6dB is equal to half of the voltage meaning that the voltage multiplier changes linearly from the start of the fade to the end.

Fade9Decibel 

"slow" fade out

After half of the fade time -9dB are reached. So the fade is fast in the beginning and slow in the end. This is a good fade for ending music.

Fade12Decibel 

more extreme version of the -9dB fade

Definition at line 87 of file volumefadereffect.h.

Property Documentation

◆ fadeCurve

FadeCurve Phonon::VolumeFaderEffect::fadeCurve
readwrite

This property holds the fade curve to be used for the fadeIn(), fadeOut() and fadeTo() slots.

Defaults to Fade3Decibel.

See also
FadeCurve

Definition at line 82 of file volumefadereffect.h.

◆ volume

float Phonon::VolumeFaderEffect::volume
readwrite

This is the current volume of the output as voltage factor.

Setting this property changes the volume immediately.

1.0 means 100%, 0.5 means 50% voltage/25% power, 0.0 means 0%

See also
volumeDecibel

Definition at line 62 of file volumefadereffect.h.

◆ volumeDecibel

double Phonon::VolumeFaderEffect::volumeDecibel
readwrite

This is the current volume of the output in decibel.

Setting this property changes the volume immediately.

0 dB means no change in volume, -6dB means an attenuation of the voltage to 50% and an attenuation of the power to 25%, -inf dB means silence.

See also
volume

Definition at line 73 of file volumefadereffect.h.

Member Function Documentation

◆ fadeIn

void Phonon::VolumeFaderEffect::fadeIn ( int fadeTime)
slot

Tells the Fader to change the volume from the current volume to 100% in fadeTime milliseconds.

Short for fadeTo(1.0, fadeTime).

Parameters
fadeTimethe fade duration in milliseconds
See also
fadeTo
volume

Definition at line 60 of file volumefadereffect.cpp.

◆ fadeOut

void Phonon::VolumeFaderEffect::fadeOut ( int fadeTime)
slot

Tells the Fader to change the volume from the current volume to 0% in fadeTime milliseconds.

Short for fadeTo(0.0, fadeTime).

Parameters
fadeTimethe fade duration in milliseconds
See also
fadeTo

Definition at line 65 of file volumefadereffect.cpp.

◆ fadeTo

void Phonon::VolumeFaderEffect::fadeTo ( float volume,
int fadeTime )
slot

Tells the Fader to change the volume from the current value to volume in fadeTime milliseconds.

See also
fadeIn
fadeOut

Definition at line 70 of file volumefadereffect.cpp.

◆ setVolumeDecibel

void Phonon::VolumeFaderEffect::setVolumeDecibel ( double volumeDecibel)
slot

Definition at line 54 of file volumefadereffect.cpp.

◆ volumeDecibel()

double Phonon::VolumeFaderEffect::volumeDecibel ( ) const

Definition at line 49 of file volumefadereffect.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:53:29 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.