Qmmp
Loading...
Searching...
No Matches
Public Types | Signals | Public Member Functions | List of all members
Volume Class Referenceabstract

#include <volume.h>

Inherits QObject.

Public Types

enum  VolumeFlag { IsMuteSupported = 0x1 , HasNotifySignal = 0x2 }
 

Signals

void changed ()
 

Public Member Functions

virtual ~Volume ()
 
virtual void setVolume (const VolumeSettings &volume)=0
 
virtual VolumeSettings volume () const =0
 
virtual bool isMuted () const
 
virtual void setMuted (bool mute)
 
virtual VolumeFlags flags () const
 

Detailed Description

The Volume class provides asbtract volume interface.

Author
Ilya Kotov forko.nosp@m.tov0.nosp@m.2@ya..nosp@m.ru

Member Enumeration Documentation

◆ VolumeFlag

enum VolumeFlag

This enum describes volume capabilities.

Enumerator
IsMuteSupported 

Indicates the interface has feature to mute audio

HasNotifySignal 

Indicates the object supports change notification via emitting changed() signal so polling the volume is not needed

Constructor & Destructor Documentation

◆ ~Volume()

virtual ~Volume ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ changed

void changed ( )
signal

Emitted if volume is changed.

◆ flags()

virtual VolumeFlags flags ( ) const
virtual

Returns volume flags.

◆ isMuted()

virtual bool isMuted ( ) const
virtual

Returns true if volume is disabled. Otherwise returns false.

◆ setMuted()

virtual void setMuted ( bool mute)
virtual

Mutes/Restores volume. Default implementation does nothing.

Parameters
mute- state of volume (true - mute, false - restore)

◆ setVolume()

virtual void setVolume ( const VolumeSettings & volume)
pure virtual

Setups volume levels. Subclass should reimplement this fucntion.

Parameters
volumeStructure with required volume levels.

◆ volume()

virtual VolumeSettings volume ( ) const
pure virtual

Returns volume level of the channel.


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