roc::sndio::IDevice Class Reference

Base interface for sinks and sources. More...

#include <idevice.h>

Inheritance diagram for roc::sndio::IDevice:

Public Member Functions
virtual ISink *	to_sink ()=0
	Cast IDevice to ISink. More...
virtual ISource *	to_source ()=0
	Cast IDevice to ISink. More...
virtual DeviceType	type () const =0
	Get device type. More...
virtual DeviceState	state () const =0
	Get device state. More...
virtual void	pause ()=0
	Pause device. More...
virtual bool	resume ()=0
	Resume device after pause. More...
virtual bool	restart ()=0
	Restart device. More...
virtual audio::SampleSpec	sample_spec () const =0
	Get sample specification of the device. More...
virtual core::nanoseconds_t	latency () const =0
	Get latency of the device. More...
virtual bool	has_latency () const =0
	Check if the device supports latency reports. More...
virtual bool	has_clock () const =0
	Check if the device has own clock. More...

Detailed Description

Base interface for sinks and sources.

Definition at line 28 of file idevice.h.

Member Function Documentation

has_clock()

virtual bool roc::sndio::IDevice::has_clock ( ) const

pure virtual

Check if the device has own clock.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

has_latency()

virtual bool roc::sndio::IDevice::has_latency ( ) const

pure virtual

Check if the device supports latency reports.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

latency()

virtual core::nanoseconds_t roc::sndio::IDevice::latency ( ) const

pure virtual

Get latency of the device.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

pause()

virtual void roc::sndio::IDevice::pause ( )

pure virtual

Pause device.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

restart()

virtual bool roc::sndio::IDevice::restart ( )

pure virtual

Restart device.

Remarks

If device was paused, it's automatically resumed.

Returns

false if an error occurred.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

resume()

virtual bool roc::sndio::IDevice::resume ( )

pure virtual

Resume device after pause.

Returns

false if an error occurred.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

sample_spec()

virtual audio::SampleSpec roc::sndio::IDevice::sample_spec ( ) const

pure virtual

Get sample specification of the device.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

state()

virtual DeviceState roc::sndio::IDevice::state ( ) const

pure virtual

Get device state.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

to_sink()

virtual ISink* roc::sndio::IDevice::to_sink ( )

pure virtual

Cast IDevice to ISink.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

to_source()

virtual ISource* roc::sndio::IDevice::to_source ( )

pure virtual

Cast IDevice to ISink.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

type()

virtual DeviceType roc::sndio::IDevice::type ( ) const

pure virtual

Get device type.

Implemented in roc::sndio::WavSource, roc::sndio::WavSink, roc::sndio::SoxSource, roc::sndio::SoxSink, roc::sndio::SndfileSource, roc::sndio::SndfileSink, roc::sndio::PulseaudioDevice, roc::pipeline::TranscoderSource, roc::pipeline::TranscoderSink, roc::pipeline::SenderSink, and roc::pipeline::ReceiverSource.

---

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

• roc_sndio/idevice.h