Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
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:
roc::core::NonCopyable< T > roc::sndio::PulseaudioSink roc::sndio::PulseaudioSource

Public Member Functions

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

Protected Member Functions

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

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: