roc::sndio::SndfileSink Class Reference

Sndfile sink. More...

#include <sndfile_sink.h>

Inheritance diagram for roc::sndio::SndfileSink:

Collaboration diagram for roc::sndio::SndfileSink:

Public Member Functions
	SndfileSink (core::IArena &arena, const Config &config)
	Initialize. More...
bool	is_valid () const
	Check if the object was successfully constructed. More...
bool	open (const char *driver, const char *path)
	Open output file or device. More...
virtual ISink *	to_sink ()
	Cast IDevice to ISink. More...
virtual ISource *	to_source ()
	Cast IDevice to ISink. More...
virtual DeviceType	type () const
	Get device type. More...
virtual DeviceState	state () const
	Get device state. More...
virtual void	pause ()
	Pause reading. More...
virtual bool	resume ()
	Resume paused reading. More...
virtual bool	restart ()
	Restart reading from the beginning. More...
virtual audio::SampleSpec	sample_spec () const
	Get sample specification of the sink. More...
virtual core::nanoseconds_t	latency () const
	Get latency of the sink. More...
virtual bool	has_latency () const
	Check if the sink supports latency reports. More...
virtual bool	has_clock () const
	Check if the sink has own clock. More...
virtual void	write (audio::Frame &frame)
	Write audio frame. More...
Public Member Functions inherited from roc::core::ListNode< Tag >
ListData *	list_data () const
	Get pointer to internal data. More...

Additional Inherited Members
Static Public Member Functions inherited from roc::core::ListNode< Tag >
static ListNode *	list_node (ListData *data)
	Get pointer to parent node from pointer to internal data. More...

Detailed Description

Sndfile sink.

Remarks

Writes samples to output file. Supports multiple drivers for different file types.

Definition at line 33 of file sndfile_sink.h.

Constructor & Destructor Documentation

SndfileSink()

roc::sndio::SndfileSink::SndfileSink	(	core::IArena &	arena,
		const Config &	config
	)

Initialize.

Member Function Documentation

has_clock()

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

virtual

Check if the sink has own clock.

Implements roc::sndio::IDevice.

has_latency()

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

virtual

Check if the sink supports latency reports.

Implements roc::sndio::IDevice.

is_valid()

bool roc::sndio::SndfileSink::is_valid

(

)

const

Check if the object was successfully constructed.

latency()

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

virtual

Get latency of the sink.

Implements roc::sndio::IDevice.

open()

bool roc::sndio::SndfileSink::open	(	const char *	driver,
		const char *	path
	)

Open output file or device.

Parameters

• driver is output format name;
• path is output file name, "-" for stdout.

Remarks

If driver is NULL, default is used.

pause()

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

virtual

Pause reading.

Implements roc::sndio::IDevice.

restart()

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

virtual

Restart reading from the beginning.

Implements roc::sndio::IDevice.

resume()

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

virtual

Resume paused reading.

Implements roc::sndio::IDevice.

sample_spec()

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

virtual

Get sample specification of the sink.

Implements roc::sndio::IDevice.

state()

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

virtual

Get device state.

Implements roc::sndio::IDevice.

to_sink()

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

virtual

Cast IDevice to ISink.

Implements roc::sndio::IDevice.

to_source()

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

virtual

Cast IDevice to ISink.

Implements roc::sndio::IDevice.

type()

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

virtual

Get device type.

Implements roc::sndio::IDevice.

write()

virtual void roc::sndio::SndfileSink::write ( audio::Frame &  frame )

virtual

Write audio frame.

Implements roc::audio::IFrameWriter.

---

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

• roc_sndio/target_sndfile/roc_sndio/sndfile_sink.h