switchboard::RecorderNode Class Reference

Records the incoming audio data to a file. More...

#include <RecorderNode.hpp>

Inheritance diagram for switchboard::RecorderNode:

Public Member Functions
	RecorderNode (const uint recordingSampleRate=constants::SAMPLE_RATE_UNDEFINED, const uint numberOfRecordedChannels=constants::STEREO)
	Creates a RecorderNode instance.
	~RecorderNode ()
	RecorderNode destructor.
void	start ()
	Start recording the incoming audio.
bool	stop (const std::string &recordingFilePath, Codec format)
	Stop recording the incoming audio and write it to file.
bool	getIsRecording () const
	Check whether the RecorderNode is recording.
void	setIsRealtime (const bool isRealtime)
	Set whether the RecorderNode should run in realtime mode.
bool	getIsRealtime () const
	Check whether the RecorderNode is running in realtime mode.
bool	setBusFormat (AudioBusFormat &busFormat) override
bool	consume (AudioBus &bus) override

Detailed Description

Records the incoming audio data to a file.

RecorderNode class

Constructor & Destructor Documentation

RecorderNode()

switchboard::RecorderNode::RecorderNode	(	const uint	recordingSampleRate = constants::SAMPLE_RATE_UNDEFINED,
		const uint	numberOfRecordedChannels = constants::STEREO )

Creates a RecorderNode instance.

Parameters

recordingSampleRate	The sample rate which the output file will be saved with. SAMPLE_RATE_UNDEFINED (0) means, sample rate will be set to the first received bus sample rate in setBusFormat.
numberOfRecordedChannels	Number of channels to record. Must match the number of channels of the incoming audio buffer.

Member Function Documentation

getIsRealtime()

bool switchboard::RecorderNode::getIsRealtime

(

)

const

Check whether the RecorderNode is running in realtime mode.

Returns

True if the RecorderNode is running in realtime mode.

getIsRecording()

bool switchboard::RecorderNode::getIsRecording

(

)

const

Check whether the RecorderNode is recording.

Returns

True if the RecorderNode is recording.

setIsRealtime()

void switchboard::RecorderNode::setIsRealtime

(

const bool

isRealtime

)

Set whether the RecorderNode should run in realtime mode.

Parameters

isRealtime

True if the RecorderNode should run in realtime mode.

stop()

bool switchboard::RecorderNode::stop	(	const std::string &	recordingFilePath,
		Codec	format )

Stop recording the incoming audio and write it to file.

Parameters

recordingFilePath	Final recording file path.
format	Final recording file format.