Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::sndio::PulseaudioDevice Class Reference

PulseAudio device. Base class for PulseAudio source and sink. More...

#include <pulseaudio_device.h>

Inheritance diagram for roc::sndio::PulseaudioDevice:
Collaboration diagram for roc::sndio::PulseaudioDevice:

Public Member Functions

bool open (const char *device)
 Open output device. More...
 

Protected Member Functions

 PulseaudioDevice (const Config &config, DeviceType device_type)
 Initialize. More...
 
DeviceState state () const
 Get device state. More...
 
void pause ()
 Pause reading. More...
 
bool resume ()
 Resume paused reading. More...
 
bool restart ()
 Restart reading from the beginning. More...
 
audio::SampleSpec sample_spec () const
 Get sample specification of the sink. More...
 
core::nanoseconds_t latency () const
 Get latency of the sink. More...
 
bool request (audio::Frame &frame)
 Process audio frame. More...
 

Detailed Description

PulseAudio device. Base class for PulseAudio source and sink.

Definition at line 32 of file pulseaudio_device.h.

Constructor & Destructor Documentation

◆ PulseaudioDevice()

roc::sndio::PulseaudioDevice::PulseaudioDevice ( const Config config,
DeviceType  device_type 
)
protected

Initialize.

Member Function Documentation

◆ latency()

core::nanoseconds_t roc::sndio::PulseaudioDevice::latency ( ) const
protected

Get latency of the sink.

◆ open()

bool roc::sndio::PulseaudioDevice::open ( const char *  device)

Open output device.

◆ pause()

void roc::sndio::PulseaudioDevice::pause ( )
protected

Pause reading.

◆ request()

bool roc::sndio::PulseaudioDevice::request ( audio::Frame frame)
protected

Process audio frame.

◆ restart()

bool roc::sndio::PulseaudioDevice::restart ( )
protected

Restart reading from the beginning.

◆ resume()

bool roc::sndio::PulseaudioDevice::resume ( )
protected

Resume paused reading.

◆ sample_spec()

audio::SampleSpec roc::sndio::PulseaudioDevice::sample_spec ( ) const
protected

Get sample specification of the sink.

◆ state()

DeviceState roc::sndio::PulseaudioDevice::state ( ) const
protected

Get device state.


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