Phonon::BackendCapabilities

Phonon::BackendCapabilities Namespace Reference

Classes

class  Notifier
 

Functions

PHONON_EXPORT QList< AudioCaptureDeviceavailableAudioCaptureDevices ()
 
PHONON_EXPORT QList< EffectDescriptionavailableAudioEffects ()
 
PHONON_EXPORT QList< AudioOutputDeviceavailableAudioOutputDevices ()
 
PHONON_EXPORT QList< VideoCaptureDeviceavailableAVCaptureDevices ()
 
PHONON_EXPORT QStringList availableMimeTypes ()
 
PHONON_EXPORT QList< VideoCaptureDeviceavailableVideoCaptureDevices ()
 
PHONON_EXPORT bool isMimeTypeAvailable (const QString &mimeType)
 
PHONON_EXPORT Notifiernotifier ()
 

Detailed Description

Collection of functions describing the capabilities of the Backend.

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

Function Documentation

◆ availableAudioCaptureDevices()

QList< AudioCaptureDevice > Phonon::BackendCapabilities::availableAudioCaptureDevices ( )

Returns the audio capture devices the backend supports.

Returns
A list of AudioCaptureDevice objects that give a name and description for every supported audio capture device.

Definition at line 87 of file backendcapabilities.cpp.

◆ availableAudioEffects()

QList< EffectDescription > Phonon::BackendCapabilities::availableAudioEffects ( )

Returns the visualization effects the backend supports.

Returns
A list of VisualizationEffect objects that give a name and description for every supported visualization effect. Returns descriptions for the audio effects the backend supports.
A list of AudioEffectDescription objects that give a name and description for every supported audio effect.

Definition at line 125 of file backendcapabilities.cpp.

◆ availableAudioOutputDevices()

QList< AudioOutputDevice > Phonon::BackendCapabilities::availableAudioOutputDevices ( )

Returns the audio output devices the backend supports.

Returns
A list of AudioOutputDevice objects that give a name and description for every supported audio output device.

Definition at line 73 of file backendcapabilities.cpp.

◆ availableAVCaptureDevices()

QList< VideoCaptureDevice > Phonon::BackendCapabilities::availableAVCaptureDevices ( )

Returns the video capture devices that have audio capture capabilities that the backend supports.

In effect, these are both video and audio capture devices and one can connect them to both a VideoWidget and an AudioOutput, for example.

The resulting VideoCaptureDevices have a "hasaudio" property to true.

Note
These devices appear both in availableVideoCaptureDevices() and availableAudioCaptureDevices()
Warning
Creating two separate MediaObject instances for the same capture device, one for video and the other for audio, most probably doesn't work. But, if there are two separate devices, use Experimental::AVCapture.
See also
availableVideoCaptureDevices()
availableAudioCaptureDevices()
Experimental::AVCapture

Definition at line 111 of file backendcapabilities.cpp.

◆ availableMimeTypes()

QStringList Phonon::BackendCapabilities::availableMimeTypes ( )

Returns a list of mime types that the Backend can decode.

See also
isMimeTypeAvailable()

Definition at line 47 of file backendcapabilities.cpp.

◆ availableVideoCaptureDevices()

QList< VideoCaptureDevice > Phonon::BackendCapabilities::availableVideoCaptureDevices ( )

Returns the video output devices the backend supports.

Returns
A list of VideoOutputDevice objects that give a name and description for every supported video output device. Returns the video capture devices the backend supports.
A list of VideoCaptureDevice objects that give a name and description for every supported video capture device.

Definition at line 99 of file backendcapabilities.cpp.

◆ isMimeTypeAvailable()

bool Phonon::BackendCapabilities::isMimeTypeAvailable ( const QString & mimeType)

Often all you want to know is whether one given MIME type can be decoded by the backend.

Use this method in favor of availableMimeTypes() as it can give you a negative answer without having a backend loaded.

See also
availableMimeTypes();

Definition at line 55 of file backendcapabilities.cpp.

◆ notifier()

BackendCapabilities::Notifier * Phonon::BackendCapabilities::notifier ( )

Use this function to get a QObject pointer to connect to one of the Notifier signals.

Returns
a pointer to a QObject.

To connect to the signal do the following:

QObject::connect(BackendCapabilities::notifier(), SIGNAL(capabilitiesChanged()), ...
PHONON_EXPORT Notifier * notifier()
Use this function to get a QObject pointer to connect to one of the Notifier signals.
QMetaObject::Connection connect(const QObject *sender, PointerToMemberFunction signal, Functor functor)
See also
Notifier::capabilitiesChanged()
Notifier::availableAudioOutputDevicesChanged()
Notifier::availableAudioCaptureDevicesChanged()
Notifier::availableVideoCaptureDevicesChanged()

Definition at line 42 of file backendcapabilities.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:10:22 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.