KDE 4.0 API Reference Phonon
AudioOutput Class Reference
[Classes for applications using Phonon]
#include <Phonon/AudioOutput>
Detailed Description
Class for audio output to the soundcard.Use this class to define the audio output.
- See also:
- Phonon::Ui::VolumeSlider
Signals | |
| void | volumeChanged (qreal newVolume) |
| void | mutedChanged (bool) |
| void | outputDeviceChanged (const AudioOutputDevice &newAudioOutputDevice) |
Public Member Functions | |
| AudioOutput (Phonon::Category category, QObject *parent=0) | |
| Phonon::Category | category () const |
Properties | |
| QString | name |
| qreal | volume |
| qreal | volumeDecibel |
| AudioOutputDevice | outputDevice |
| bool | muted |
Constructor & Destructor Documentation
| 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
Member Function Documentation
| Phonon::Category category | ( | ) | const |
| void 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.
| void 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 outputDeviceChanged | ( | const 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
Property Documentation
QString name [read, write] |
This is the name that appears in Mixer applications that control the volume of this output.
- See also:
- category
qreal volume [read, write] |
This is the current loudness of the output (it is using Stevens' law to calculate the change in voltage internally).
- See also:
- volumeDecibel
qreal volumeDecibel [read, write] |
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
AudioOutputDevice outputDevice [read, write] |
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
bool muted [read, write] |
This property tells whether the output is muted.
Muting the output has the same effect as calling setVolume(0.0).
The documentation for this class was generated from the following file:
- audiooutput.h
