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 baseVolumeChanged ()
 
void cardIndexChanged ()
 
void defaultChanged ()
 
void descriptionChanged ()
 
void formFactorChanged ()
 
void portsChanged ()
 
void pulsePropertiesChanged ()
 
void stateChanged ()
 
void virtualDeviceChanged ()
 
- 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
 
void switchStreams () override
 
- Public Member Functions inherited from PulseAudioQt::Device
quint32 activePortIndex () const
 
qint64 baseVolume () const
 
quint32 cardIndex () const
 
QString description () const
 
QString formFactor () const
 
bool isVirtualDevice () const
 
QList< Port * > ports () const
 
QVariantMap pulseProperties () const
 
 Q_ENUM (State)
 
State state () const
 
- Public Member Functions inherited from PulseAudioQt::VolumeObject
QVector< QStringchannels () const
 
QVector< qint64channelVolumes () 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
 
qint64 baseVolume
 
quint32 cardIndex
 
bool default
 
QString description
 
QString formFactor
 
QList< Port * > ports
 
QVariantMap pulseProperties
 
State state
 
bool virtualDevice
 
- Properties inherited from PulseAudioQt::VolumeObject
QVector< QStringchannels
 
QVector< qint64channelVolumes
 
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.

Constructor & Destructor Documentation

◆ ~Sink()

PulseAudioQt::Sink::~Sink ( )

Definition at line 32 of file sink.cpp.

Member Function Documentation

◆ isDefault()

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

Whether this is the default device.

Implements PulseAudioQt::Device.

Definition at line 72 of file sink.cpp.

◆ monitorIndex()

quint32 PulseAudioQt::Sink::monitorIndex ( ) const

Index of the monitor source for this sink.

Definition at line 84 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 57 of file sink.cpp.

◆ setChannelVolume()

void PulseAudioQt::Sink::setChannelVolume ( int channel,
qint64 volume )
overridevirtual

Implements PulseAudioQt::VolumeObject.

Definition at line 67 of file sink.cpp.

◆ setChannelVolumes()

void PulseAudioQt::Sink::setChannelVolumes ( const QVector< qint64 > & channelVolumes)
overridevirtual

Implements PulseAudioQt::VolumeObject.

Definition at line 89 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 77 of file sink.cpp.

◆ setMuted()

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

Set whether this object is muted.

Implements PulseAudioQt::VolumeObject.

Definition at line 52 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 47 of file sink.cpp.

◆ switchStreams()

void PulseAudioQt::Sink::switchStreams ( )
overridevirtual

Switch all streams onto this Device Iterates through all relevant streams for the Device type and assigns them to this Device.

For example for a Sink device all SinkInputs known to the daemon will be explicitly switched onto this Sink. Useful for mass-rerouting of streams from different devices onto a specific target device.

Implements PulseAudioQt::Device.

Definition at line 94 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-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:20:07 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.