• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Solid

Solid::AudioInterface

Solid::AudioInterface Class Reference

#include <audiointerface.h>

Inheritance diagram for Solid::AudioInterface:

Inheritance graph
[legend]

List of all members.


Detailed Description

This device interface is available on interfaces exposed by sound cards.

Definition at line 36 of file audiointerface.h.


Public Types

enum  AudioDriver { Alsa, OpenSoundSystem, UnknownAudioDriver }
enum  AudioInterfaceType { UnknownAudioInterfaceType = 0, AudioControl = 1, AudioInput = 2, AudioOutput = 4 }
enum  SoundcardType {
  InternalSoundcard, UsbSoundcard, FirewireSoundcard, Headset,
  Modem
}

Public Member Functions

AudioInterfaceTypes deviceType () const
AudioDriver driver () const
QVariant driverHandle () const
QString name () const
SoundcardType soundcardType () const
virtual ~AudioInterface ()

Static Public Member Functions

static Type deviceInterfaceType ()

Properties

AudioInterfaceTypes deviceType
AudioDriver driver
QVariant driverHandle
QString name
SoundcardType soundcardType

Member Enumeration Documentation

enum Solid::AudioInterface::AudioDriver

This enum type defines the type of driver required to interact with the device.

Enumerator:
Alsa  An Advanced Linux Sound Architecture (ALSA) driver device.
OpenSoundSystem  An Open Sound System (OSS) driver device.
UnknownAudioDriver  An unknown driver device.

Definition at line 54 of file audiointerface.h.

enum Solid::AudioInterface::AudioInterfaceType

This enum type defines the type of audio interface this device expose.

Enumerator:
UnknownAudioInterfaceType  An unknown audio interface.
AudioControl  A control/mixer interface.
AudioInput  An audio source.
AudioOutput  An audio sink.

Definition at line 74 of file audiointerface.h.

enum Solid::AudioInterface::SoundcardType

This type stores an OR combination of AudioInterfaceType values.

This enum defines the type of soundcard of this device.

Enumerator:
InternalSoundcard  An internal soundcard (onboard or PCI card).
UsbSoundcard  An external USB soundcard (that is not a headphone).
FirewireSoundcard  An external Firewire soundcard.
Headset  A headset attached to a USB port or connected via Bluetooth (the headset includes its own audio hardware; it is impossible to detect a headset connected to the internal soundcard).
Modem  A modem device.

Softmodems today are implemented as (cheap) soundcards. ALSA can provide an interface to the modem.

Definition at line 102 of file audiointerface.h.


Constructor & Destructor Documentation

Solid::AudioInterface::~AudioInterface (  )  [virtual]

Destroys an AudioInterface object.

Definition at line 33 of file audiointerface.cpp.


Member Function Documentation

static Type Solid::AudioInterface::deviceInterfaceType (  )  [inline, static]

Get the Solid::DeviceInterface::Type of the AudioInterface device interface.

Returns:
the AudioInterface device interface type
See also:
Solid::DeviceInterface::Type

Definition at line 155 of file audiointerface.h.

AudioInterfaceTypes Solid::AudioInterface::deviceType (  )  const

Retrieves the type of this audio interface (in/out/control).

Returns:
the type of this audio interface
See also:
Solid::AudioInterface::AudioInterfaceTypes

AudioDriver Solid::AudioInterface::driver (  )  const

Retrieves the audio driver that should be used to access the device.

Returns:
the driver needed to access the device
See also:
Solid::AudioInterface::AudioDriver

QVariant Solid::AudioInterface::driverHandle (  )  const

Retrieves a driver specific handle to access the device.

For Alsa devices it is a list with (card, device, subdevice).

 QVariantList list = dev->driverHandle().toList();
 QString card = list[0].toString();
 int device = list[1].toInt();
 int subdevice = list[2].toInt();
The card entry sometimes can be converted to an integer, but it may just as well be the textual id for the card. So don't rely on it to work with QVariant::toInt().

For OSS devices it is simply a string like "/dev/dsp". Use QVariant::toString() to retrieve the string.

Returns:
the driver specific data to handle this device

QString Solid::AudioInterface::name (  )  const

Retrieves the name of this audio interface.

The product name of the parent device is normally better suited for the user to identify the soundcard. If the soundcard has multiple devices, though you need to add this name to differentiate between the devices.

Returns:
the name of the audio interface if available, QString() otherwise

SoundcardType Solid::AudioInterface::soundcardType (  )  const

Retrieves the type of soundcard (internal/headset/.

..).

Returns:
the type of soundcard
See also:
Solid::AudioInterface::SoundcardType


Property Documentation

Solid::AudioInterface::AudioInterfaceTypes Solid::AudioInterface::deviceType [read]

Definition at line 44 of file audiointerface.h.

Solid::AudioInterface::AudioDriver Solid::AudioInterface::driver [read]

Definition at line 41 of file audiointerface.h.

QVariant Solid::AudioInterface::driverHandle [read]

Definition at line 42 of file audiointerface.h.

QString Solid::AudioInterface::name [read]

Definition at line 43 of file audiointerface.h.

Solid::AudioInterface::SoundcardType Solid::AudioInterface::soundcardType [read]

Definition at line 45 of file audiointerface.h.


The documentation for this class was generated from the following files:
  • audiointerface.h
  • audiointerface.cpp

Solid

Skip menu "Solid"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal