SoxEndpoint Class Reference

#include <SoxEndpoint.h>

Inheritance diagram for SoxEndpoint:

Collaboration diagram for SoxEndpoint:

Public Member Functions
bool	Open (int rate, int nchan, std::string globalopts, std::string fileopts, std::string filename, std::string effectopts)
void	NextSample (double s)
void	Close (void)

Detailed Description

A pipeline element which allows samples to be piped into the SoX program, written to file or otherwise.

Member Function Documentation

Close()

void SoxEndpoint::Close

(

void

)

Close the output pipe if it exists

NextSample()

void SoxEndpoint::NextSample ( double  s )

virtual

Adds the next sample to the output pipe

Parameters

s

Implements SampleCallback.

Open()

bool SoxEndpoint::Open	(	int	srate,
		int	nchan,
		std::string	globalopts,
		std::string	fileopts,
		std::string	filename,
		std::string	effectopts
	)

Open the SoX pipe

Parameters

srate	sample rate for pipe
nchan	nr of channels in filtered audio
globalopts
fileopts
filename	filename to pass to sox
effectopts	options for SoX effects

Returns

true if open sucessful, false otherwise

---

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

• src/SoxEndpoint.h
• src/SoxEndpoint.cpp