PulseAudioQt::Sink

Search for usage in LXR

PulseAudioQt::Sink Class Reference

#include <sink.h>

Inheritance diagram for PulseAudioQt::Sink:

Signals

void monitorIndexChanged ()
 
- Signals inherited from PulseAudioQt::Device
void activePortIndexChanged ()
 
void cardIndexChanged ()
 
void defaultChanged ()
 
void descriptionChanged ()
 
void formFactorChanged ()
 
void portsChanged ()
 
void stateChanged ()
 
- Signals inherited from PulseAudioQt::VolumeObject
void channelsChanged ()
 
void channelVolumesChanged ()
 
void isVolumeWritableChanged ()
 
void mutedChanged ()
 
void rawChannelsChanged ()
 
void volumeChanged ()
 

Public Member Functions

bool isDefault () const override
 
quint32 monitorIndex () const
 
void setActivePortIndex (quint32 port_index) override
 
void setChannelVolume (int channel, qint64 volume) override
 
void setChannelVolumes (const QVector< qint64 > &channelVolumes) override
 
void setDefault (bool enable) override
 
void setMuted (bool muted) override
 
void setVolume (qint64 volume) override
 
- Public Member Functions inherited from PulseAudioQt::Device
quint32 activePortIndex () const
 
quint32 cardIndex () const
 
QString description () const
 
QString formFactor () const
 
QList< Port * > ports () const
 
 Q_ENUM (State)
 
State state () const
 
- Public Member Functions inherited from PulseAudioQt::VolumeObject
QVector< QStringchannels () const
 
QVector< qint64 > channelVolumes () const
 
bool isMuted () const
 
bool isVolumeWritable () const
 
QStringList rawChannels () const
 
qint64 volume () const
 

Additional Inherited Members

- Public Types inherited from PulseAudioQt::Device
enum  State {
  InvalidState = 0, RunningState, IdleState, SuspendedState,
  UnknownState
}
 
- Properties inherited from PulseAudioQt::Device
quint32 activePortIndex
 
quint32 cardIndex
 
bool default
 
QString description
 
QString formFactor
 
QList< Port * > ports
 
State state
 
- Properties inherited from PulseAudioQt::VolumeObject
QVector< QStringchannels
 
QVector< qint64 > channelVolumes
 
bool muted
 
QStringList rawChannels
 
qint64 volume
 
bool volumeWritable
 

Detailed Description

A PulseAudio sink.

This class is based on https://freedesktop.org/software/pulseaudio/doxygen/structpa__sink__info.html.

Definition at line 19 of file sink.h.

Member Function Documentation

◆ isDefault()

bool PulseAudioQt::Sink::isDefault ( ) const
overridevirtual

Whether this is the default device.

Implements PulseAudioQt::Device.

Definition at line 71 of file sink.cpp.

◆ monitorIndex()

quint32 PulseAudioQt::Sink::monitorIndex ( ) const

Index of the monitor source for this sink.

Definition at line 83 of file sink.cpp.

◆ setActivePortIndex()

void PulseAudioQt::Sink::setActivePortIndex ( quint32  port_index)
overridevirtual

Set the currently active port, by index.

Implements PulseAudioQt::Device.

Definition at line 56 of file sink.cpp.

◆ setDefault()

void PulseAudioQt::Sink::setDefault ( bool  enable)
overridevirtual

Set whether this is the default device.

Implements PulseAudioQt::Device.

Definition at line 76 of file sink.cpp.

◆ setMuted()

void PulseAudioQt::Sink::setMuted ( bool  muted)
overridevirtual

Set whether this object is muted.

Implements PulseAudioQt::VolumeObject.

Definition at line 51 of file sink.cpp.

◆ setVolume()

void PulseAudioQt::Sink::setVolume ( qint64  volume)
overridevirtual

Set the volume for this object.

This affects all channels. The volume must be between PulseAudioQt::minimumVolume() and PulseAudioQt::maximumVolume().

Implements PulseAudioQt::VolumeObject.

Definition at line 46 of file sink.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 04:01:52 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.