Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
roc::sndio::SoxSink Class Reference

SoX sink. More...

#include <sox_sink.h>

Inheritance diagram for roc::sndio::SoxSink:
roc::sndio::ISink roc::core::NonCopyable< T > roc::sndio::ITerminal roc::audio::IFrameWriter roc::core::ListNode roc::core::NonCopyable< ListNode >

Public Member Functions

 SoxSink (core::IAllocator &allocator, const Config &config)
 Initialize.
 
bool valid () const
 Check if the object was successfully constructed.
 
bool open (const char *driver, const char *path)
 Open output file or device.
 
virtual audio::SampleSpec sample_spec () const
 Get sample specification of the sink.
 
virtual core::nanoseconds_t latency () const
 Get latency of the sink.
 
virtual bool has_clock () const
 Check if the sink has own clock.
 
virtual void write (audio::Frame &frame)
 Write audio frame.
 
virtual audio::SampleSpec sample_spec () const =0
 Get sample specification of the terminal.
 
virtual core::nanoseconds_t latency () const =0
 Get latency of the terminal.
 
virtual bool has_clock () const =0
 Check if the terminal has own clock.
 
virtual void write (Frame &frame)=0
 Write audio frame.
 
- Public Member Functions inherited from roc::core::ListNode
ListNodeDatalist_node_data () const
 Get list node data.
 

Detailed Description

SoX sink.

Remarks
Writes samples to output file or device. Supports multiple drivers for different file types and audio systems.

Definition at line 33 of file sox_sink.h.

Constructor & Destructor Documentation

◆ SoxSink()

roc::sndio::SoxSink::SoxSink ( core::IAllocator allocator,
const Config config 
)

Initialize.

Member Function Documentation

◆ has_clock()

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

Check if the sink has own clock.

Implements roc::sndio::ITerminal.

◆ latency()

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

Get latency of the sink.

Implements roc::sndio::ITerminal.

◆ open()

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

Open output file or device.

Parameters

  • driver is output driver name;
  • path is output file or device name, "-" for stdout.
Remarks
If driver or path are NULL, defaults are used.

◆ sample_spec()

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

Get sample specification of the sink.

Implements roc::sndio::ITerminal.

◆ valid()

bool roc::sndio::SoxSink::valid ( ) const

Check if the object was successfully constructed.

◆ write()

virtual void roc::sndio::SoxSink::write ( audio::Frame frame)
virtual

Write audio frame.

Implements roc::audio::IFrameWriter.


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