Class for audio output to the soundcard. More...

#include <phonon/AudioOutput>

Inheritance diagram for Phonon::AudioOutput:

Public Slots
void	setName (const QString &newName)

void	setVolume (qreal newVolume)

void	setVolumeDecibel (qreal newVolumeDecibel)

bool	setOutputDevice (const Phonon::AudioOutputDevice &newAudioOutputDevice)

void	setMuted (bool mute)

Signals
void	volumeChanged (qreal newVolume)

void	mutedChanged (bool)

void	outputDeviceChanged (const Phonon::AudioOutputDevice &newAudioOutputDevice)

Public Member Functions
	AudioOutput (Phonon::Category category, QObject *parent=0)

	AudioOutput (QObject *parent=0)

QString	name () const

qreal	volume () const

qreal	volumeDecibel () const

Phonon::Category	category () const

AudioOutputDevice	outputDevice () const

bool	isMuted () const

Properties
QString	name

qreal	volume

qreal	volumeDecibel

AudioOutputDevice	outputDevice

bool	muted

Friends
class	FactoryPrivate

class	::AudioOutputAdaptor

Additional Inherited Members
Protected Member Functions inherited from Phonon::AbstractAudioOutput
	AbstractAudioOutput (AbstractAudioOutputPrivate &dd, QObject *parent)

Protected Attributes inherited from Phonon::MediaNode
MediaNodePrivate *const	k_ptr

Detailed Description

Class for audio output to the soundcard.

Use this class to define the audio output.

Author: Matthias Kretz kretz.nosp@m.@kde.nosp@m..org

See Also: Phonon::Ui::VolumeSlider

Constructor & Destructor Documentation

Phonon::AudioOutput::AudioOutput	(	Phonon::Category	category,
		QObject *	parent = `0`
	)

explicit

Creates a new AudioOutput that defines output to a physical device.

Parameters

category The category can be used by mixer applications to group volume controls of applications into categories. That makes it easier for the user to identify the programs. The category is also used for the default output device that is configured centrally. As an example: often users want to have the audio signal of a VoIP application go to their USB headset while all other sounds should go to the internal soundcard.

parent QObject parent

See Also: Phonon::categoryToString; outputDevice

Member Function Documentation

Category Phonon::AudioOutput::category ( ) const

Returns the category of this output.

See Also: AudioOutput(Phonon::Category, QObject *)

void Phonon::AudioOutput::mutedChanged ( bool )

signal

This signal is emitted when the muted property has changed. As this property can change by IPC (DBus) calls a UI element showing the muted property should listen to this signal.

void Phonon::AudioOutput::outputDeviceChanged ( const Phonon::AudioOutputDevice & newAudioOutputDevice)

signal

This signal is emitted when the (hardware) device for the output has changed.

The change can happen either through setOutputDevice or if the global configuration for the used category has changed.

See Also: outputDevice

void Phonon::AudioOutput::volumeChanged ( qreal newVolume)

signal

This signal is emitted whenever the volume has changed. As the volume can change without a call to setVolume (calls over dbus) this is important to keep a widget showing the current volume up to date.

Property Documentation

bool Phonon::AudioOutput::muted

readwrite

This property tells whether the output is muted.

Muting the output has the same effect as calling setVolume(0.0).

QString Phonon::AudioOutput::name

readwrite

This is the name that appears in Mixer applications that control the volume of this output.

See Also: category

AudioOutputDevice Phonon::AudioOutput::outputDevice

readwrite

This property holds the (hardware) destination for the output.

The default device is determined by the category and the global configuration for that category of outputs. Normally you don't need to override this setting - letting the user change the global configuration is the right choice. You can still override the device though, if you have good reasons to do so.

See Also: outputDeviceChanged

qreal Phonon::AudioOutput::volume

readwrite

This is the current loudness of the output (it is using Stevens' law to calculate the change in voltage internally).

See Also: volumeDecibel

qreal Phonon::AudioOutput::volumeDecibel

readwrite

This is the current volume of the output in decibel.

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

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

/home/me/src/git/p/phonon/phonon/audiooutput.h
/home/me/src/git/p/phonon/phonon/audiooutput.cpp

Public Slots

Signals

Public Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation