kdemm Library API Documentation

KDE::Multimedia::Channel Class Reference

Abstraction of different inputs or outputs. More...

#include <channel.h>

Inheritance diagram for KDE::Multimedia::Channel:

Inheritance graph
[legend]
Collaboration diagram for KDE::Multimedia::Channel:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Direction { Input, Output }

Public Member Functions

virtual ~Channel ()
virtual QString channelName () const
virtual QString channelType () const
virtual Direction direction () const
virtual bool hasVolumeControl () const =0
virtual float volume () const =0
virtual bool setVolume (float volume)=0

Protected Member Functions

 Channel (const QString &name, const QString &type, Direction direction, QObject *parent=0, const char *name=0)

Detailed Description

Abstraction of different inputs or outputs.

Author:
Matthias Kretz <kretz@kde.org>
Since:
4.0

Definition at line 37 of file channel.h.


Constructor & Destructor Documentation

KDE::Multimedia::Channel::Channel const QString name,
const QString type,
Direction  direction,
QObject parent = 0,
const char *  name = 0
[protected]
 

You can not instantiate channels yourself, use the Factory to create them.

Definition at line 37 of file channel.cpp.


Member Function Documentation

QString KDE::Multimedia::Channel::channelName  )  const [virtual]
 

The user visible name of the channel.

Implements MixerIface.

Definition at line 52 of file channel.cpp.

QString KDE::Multimedia::Channel::channelType  )  const [virtual]
 

The (internal) channel type.

Implements MixerIface.

Definition at line 57 of file channel.cpp.

Channel::Direction KDE::Multimedia::Channel::direction  )  const [virtual]
 

Whether it is an Input or Output channel.

Definition at line 62 of file channel.cpp.

virtual bool KDE::Multimedia::Channel::hasVolumeControl  )  const [pure virtual]
 

If the channel has a volume control this function returns true.

Implements MixerIface.

virtual float KDE::Multimedia::Channel::volume  )  const [pure virtual]
 

The current volume of the channel.

Implements MixerIface.

virtual bool KDE::Multimedia::Channel::setVolume float  volume  )  [pure virtual]
 

Set the volume for the channel.

Returns:
Returns true if the volume has been successfully set

Implements MixerIface.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdemm Library Version 3.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Sep 13 04:04:40 2005 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003