#include <Phonon/VolumeFaderEffect>

Class 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 50 of file volumefadereffect.h.

Inheritance diagram for VolumeFaderEffect:

Public Types
enum	FadeCurve { Fade3Decibel, Fade6Decibel, Fade9Decibel, Fade12Decibel }
	Determines the curve of the volume change. More...

Public Slots
void	fadeIn (int fadeTime)
	Tells the Fader to change the volume from the current volume to 100% in `fadeTime` milliseconds. More...

void	fadeOut (int fadeTime)
	Tells the Fader to change the volume from the current volume to 0% in `fadeTime` milliseconds. More...

void	setVolume (float volume)

void	setVolumeDecibel (double volumeDecibel)

void	setFadeCurve (FadeCurve curve)

void	fadeTo (float volume, int fadeTime)
	Tells the Fader to change the volume from the current value to `volume` in `fadeTime` milliseconds. More...

Public Slots inherited from QObject
void	deleteLater ()

Public Member Functions
float	volume () const

double	volumeDecibel () const

FadeCurve	fadeCurve () const

Public Member Functions inherited from Effect
	~Effect ()

	Effect (const EffectDescription &description, QObject *parent=0)
	QObject constructor. More...

EffectDescription	description () const
	Returns the description of this effect. More...

QList< EffectParameter >	parameters () const
	Returns a list of parameters that this effect provides to control its behaviour. More...

QVariant	parameterValue (const EffectParameter &) const

void	setParameterValue (const EffectParameter &, const QVariant &value)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=0)

virtual	~QObject ()

virtual bool	event (QEvent *)

virtual bool	eventFilter (QObject , QEvent )

QString	objectName () const

void	setObjectName (const QString &name)

bool	isWidgetType () const

bool	signalsBlocked () const

bool	blockSignals (bool b)

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString()) const

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

const QObjectList &	children () const

void	setParent (QObject *)

void	installEventFilter (QObject *)

void	removeEventFilter (QObject *)

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

void	dumpObjectTree ()

void	dumpObjectInfo ()

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

void	setUserData (uint id, QObjectUserData *data)

QObjectUserData *	userData (uint id) const

QObject *	parent () const

bool	inherits (const char *classname) const

Public Member Functions inherited from MediaNode
virtual	~MediaNode ()

bool	isValid () const
	Tells whether the backend provides an implementation of this class. More...

QList< Path >	inputPaths () const

QList< Path >	outputPaths () const

Properties
float	volume
	This is the current volume of the output as voltage factor. More...

double	volumeDecibel
	This is the current volume of the output in decibel. More...

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

Properties inherited from QObject
QString	objectName

Additional Inherited Members
Signals inherited from QObject
void	destroyed (QObject *=0)

Static Public Member Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static uint	registerUserData ()

Protected Member Functions inherited from Effect
	Effect (EffectPrivate &dd, QObject *parent)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

virtual void	timerEvent (QTimerEvent *)

virtual void	childEvent (QChildEvent *)

virtual void	customEvent (QEvent *)

virtual void	connectNotify (const char *signal)

virtual void	disconnectNotify (const char *signal)

	QObject (QObjectPrivate &dd, QObject *parent=0)

Protected Member Functions inherited from MediaNode
	MediaNode (MediaNodePrivate &dd)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from MediaNode
MediaNodePrivate *const	k_ptr

Static Protected Attributes inherited from QObject
static const QMetaObject	staticQtMetaObject

Member Enumeration Documentation

enum 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 89 of file volumefadereffect.h.

                            {
                 Fade3Decibel,
                 Fade6Decibel,
                 Fade9Decibel,
                 Fade12Decibel
             };

Member Function Documentation

float volume ( ) const

double volumeDecibel ( ) const

FadeCurve fadeCurve ( ) const

void 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

fadeTime the fade duration in milliseconds

See also: fadeTo; volume

void 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

fadeTime the fade duration in milliseconds

See also: fadeTo

void setVolume ( float volume )

slot

void setVolumeDecibel ( double volumeDecibel )

slot

void setFadeCurve ( FadeCurve curve )

slot

void 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

Property Documentation

float 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 64 of file volumefadereffect.h.

double 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 75 of file volumefadereffect.h.

FadeCurve 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 84 of file volumefadereffect.h.

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

phonon/volumefadereffect.h

VolumeFaderEffect Class Reference

Class Description

Public Types

Public Slots

Public Member Functions

Properties

Additional Inherited Members

Member Enumeration Documentation

Member Function Documentation

Property Documentation